Internships manager

Internships manager

  • Docs
  • API
  • Tuto
  • Help
  • GitHub

›Services API

Introduction

  • Internships manager API

REST API

  • Businesses
  • Campaigns
  • Files
  • Internships
  • InternshipTypes
  • Mentors
  • Mentoring propositions
  • Statistics
  • Students

Services API

  • Emails
  • Statistics

Statistics

Details of methods to handle statistics service

This service is build as singletons, to use it, just do as following

...
import cache from '../../statistics/singleton';
...


cache.getCampaign(campaignId);

#.initialized

Var used to know if cache is initialized

#.init

This method is used to init cache

Params

KeyTypeOptionalDescription
statsStatisticsnoglobal statistics for setup
...campaignStatsCampaignStatistics[]yesstatistics by campaigns

#.stateChange

Method used to change state of an internship in cache

Params

KeyTypeOptionalDescription
nextINTERNSHIP_MODEnoNext internship mode
prevINTERNSHIP_MODEyesPrevious internship mode
idnumberyesCampaign id, if internship is link to a campaign

#.stateAdd

Method used to increase internships stats using mode and quantity

Params

KeyTypeOptionalDescription
stateINTERNSHIP_MODEnoMode for apply change
qnumbernoQuantity to increase
idnumberyesCampaign id, if internship is link to a campaign

#.stateRemove

Method used to decrease internships stats using mode and quantity

Params

KeyTypeOptionalDescription
stateINTERNSHIP_MODEnoMode for apply change
qnumbernoQuantity to decrease (q < 0)
idnumberyesCampaign id, if internship is link to a campaign

#.addMentor

Method used to increment global mentor counter Use link mentor to increment campaign counters

#.removeMentor

Method used to decrement global mentor counter Use unlink mentor to decrement campaign counters

#.linkMentor

Method used to increment mentor campaign counter

Params

KeyTypeOptionalDescription
idnumbernoCampaign id

#.unlinkMentor

Method used to decrement mentor campaign counter

Params

KeyTypeOptionalDescription
idnumbernoCampaign id

#.addStudent

Method used to increment student counter

Params

KeyTypeOptionalDescription
idnumberyesCampaign id

#.removeStudent

Method used to decrement student counter

Params

KeyTypeOptionalDescription
idnumberyesCampaign id

#.linkStudent

Method used to increment mentoring propositions campaign counter

Params

KeyTypeOptionalDescription
idnumbernoCampaign id

#.addProposition

Method used to increment mentoring propositions counter

Params

KeyTypeOptionalDescription
idnumberyesCampaign id

#.removeProposition

Method used to decrement mentoring propositions counter

Params

KeyTypeOptionalDescription
idnumberyesCampaign id

#.linkProposition

Method used to increment mentoring propositions campaign counter

Params

KeyTypeOptionalDescription
idnumbernoCampaign id

#.getCampaign

Method used to get Campaign statistics

Params

KeyTypeOptionalDescription
idnumbernoCampaign id

Returns

  • CampaignStatistics if campaign is found
  • undefined if nothing is found

#.newCampain

Method used to create a new campaign

Params

KeyTypeOptionalDescription
idnumbernoCampaign id
statPartialnoCampaign stats

#.isDefined

Method used to check if campaign statistics are defined

Params

KeyTypeOptionalDescription
idnumbernoCampaign id

Returns

Boolean, true if defined

#.reset

This method is used to reset all cache, be sure to know what you do if you use it

← Emails
  • #.initialized
  • #.init
    • Params
  • #.stateChange
    • Params
  • #.stateAdd
    • Params
  • #.stateRemove
    • Params
  • #.addMentor
  • #.removeMentor
  • #.linkMentor
    • Params
  • #.unlinkMentor
    • Params
  • #.addStudent
    • Params
  • #.removeStudent
    • Params
  • #.linkStudent
    • Params
  • #.addProposition
    • Params
  • #.removeProposition
    • Params
  • #.linkProposition
    • Params
  • #.getCampaign
    • Params
    • Returns
  • #.newCampain
    • Params
  • #.isDefined
    • Params
    • Returns
  • #.reset
Copyright © 2019 ENIB