AbstractProfileService

AbstractProfileService ⇐ Abstract#

Kind: global abstract class
Extends: Abstract
Mixes: MServiceCache
Service:
Properties

• AbstractProfileService ⇐ Abstract
  • new AbstractProfileService()
  • .getAvailableProfiles(options) ⇒ Promise.<Array.<Profile>, Error>
  • .getCurrentProfile(options) ⇒ Promise.<Profile, Error>
  • .setCurrentProfile(profile) ⇒ Promise.<Profile, Error>
  • .isKid(options) ⇒ Promise.<boolean, Error>
  • .saveProfile(profile, [options]) ⇒ Promise.<Profile, Error>
  • .deleteProfile(profile, [options]) ⇒ Promise.<Profile, Error>
  • .getAvailableContexts(options) ⇒ Promise.<Array.<Profile>, Error>
  • .getAllModelIdsContexts([options]) ⇒ Promise.<Object>
  • .getContextModelIds(contextType, [options]) ⇒ Promise.<Object>
  • .getContextModels(contextType, [options]) ⇒ Promise.<Array>
  • .setContext(contextType, model, [options]) ⇒ Promise
  • .unsetContext(contextType, model, [options]) ⇒ Promise
  • .getRecommended(ruleId, [options]) ⇒ Promise.<BusinessModel>
  • ._getAvailableProfiles(options) ⇒ Promise.<Array.<Profile>, Error>
  • ._getAvailableContexts(options) ⇒ Promise.<Array.<String>, Error>
  • ._saveProfile(profile, [options]) ⇒ Promise.<Profile, Error>
  • ._deleteProfile(profile, [options]) ⇒ Promise.<Profile, Error>
  • ._getContextModels(profileId, contextType, [options]) ⇒ Promise
  • ._setContext(profileId, contextType, model, value, [options]) ⇒ Promise
  • ._unsetContext(profileId, contextType, model, value, [options]) ⇒ Promise
  • ._getAllModelIdsContexts(profileId, [options]) ⇒ Promise.<Object>
  • ._getContextModelIds(profileId, contextType, [options]) ⇒ Promise.<Object>
  • ._onSseEvent(event)
  • ._getRecommended(profileId, ruleId, [options]) ⇒ Promise.<BusinessModel>
  • “profileCleanContext”
  • “profileAddContext” (data)
  • “profileAddContext” (data)

AbstractProfileService()#

Service which handles CMS user profiles.

getAvailableProfiles(options) ⇒ Promise.<Array.<Profile>, Error>#

List available users profile

Kind: instance method of AbstractProfileService
Returns: Promise.<Array.<Profile>, Error> - List of users profile

getCurrentProfile(options) ⇒ Promise.<Profile, Error>#

Get current user profile.

Kind: instance method of AbstractProfileService
Returns: Promise.<Profile, Error> - a user profile

setCurrentProfile(profile) ⇒ Promise.<Profile, Error>#

Set current user profile.

Kind: instance method of AbstractProfileService
Returns: Promise.<Profile, Error> - a user profile

isKid(options) ⇒ Promise.<boolean, Error>#

Check whether the current profile is a kids or not

Kind: instance method of AbstractProfileService
Returns: Promise.<boolean, Error> - return true if current profile age is smaller than yearsNotKidAnymore or if the current profile don’t have birthday return false otherwise

saveProfile(profile, [options]) ⇒ Promise.<Profile, Error>#

Create or Update a profile

Kind: instance method of AbstractProfileService
Returns: Promise.<Profile, Error> - a user profile

deleteProfile(profile, [options]) ⇒ Promise.<Profile, Error>#

Delete a profile

Kind: instance method of AbstractProfileService
Returns: Promise.<Profile, Error> - result

getAvailableContexts(options) ⇒ Promise.<Array.<Profile>, Error>#

List available users profile

Kind: instance method of AbstractProfileService
Returns: Promise.<Array.<Profile>, Error> - List of users profile

getAllModelIdsContexts([options]) ⇒ Promise.<Object>#

For each context, get all model id’s

Kind: instance method of AbstractProfileService
Returns: Promise.<Object> - map of contexts

getContextModelIds(contextType, [options]) ⇒ Promise.<Object>#

Kind: instance method of AbstractProfileService
Returns: Promise.<Object> - A map { id: value }

getContextModels(contextType, [options]) ⇒ Promise.<Array>#

Kind: instance method of AbstractProfileService
Returns: Promise.<Array> - A list of models

setContext(contextType, model, [options]) ⇒ Promise#

Set profile’s context by type

Kind: instance method of AbstractProfileService

unsetContext(contextType, model, [options]) ⇒ Promise#

Unset profile’s context by type

Kind: instance method of AbstractProfileService

getRecommended(ruleId, [options]) ⇒ Promise.<BusinessModel>#

Get recommended Business Model by rule

Kind: instance method of AbstractProfileService

_getAvailableProfiles(options) ⇒ Promise.<Array.<Profile>, Error>#

Vendor implementation to get available profiles

Kind: instance abstract method of AbstractProfileService
Returns: Promise.<Array.<Profile>, Error> - List of users profile
Access: protected

_getAvailableContexts(options) ⇒ Promise.<Array.<String>, Error>#

Vendor implementation to get available contexts

Kind: instance abstract method of AbstractProfileService
Returns: Promise.<Array.<String>, Error> - List of contexts
Access: protected

_saveProfile(profile, [options]) ⇒ Promise.<Profile, Error>#

Vendor implementation to Create or Update a profile

Kind: instance abstract method of AbstractProfileService
Returns: Promise.<Profile, Error> - a user profile
Access: protected

_deleteProfile(profile, [options]) ⇒ Promise.<Profile, Error>#

Vendor implementation to delete a profile

Kind: instance abstract method of AbstractProfileService
Returns: Promise.<Profile, Error> - result
Access: protected

_getContextModels(profileId, contextType, [options]) ⇒ Promise#

Kind: instance abstract method of AbstractProfileService
Access: protected

_setContext(profileId, contextType, model, value, [options]) ⇒ Promise#

Vendor implementation to set profile’s context

Kind: instance abstract method of AbstractProfileService
Access: protected

_unsetContext(profileId, contextType, model, value, [options]) ⇒ Promise#

Vendor implementation to unset profile’s context

Kind: instance abstract method of AbstractProfileService
Access: protected

_getAllModelIdsContexts(profileId, [options]) ⇒ Promise.<Object>#

Vendor implementation to get for each context, get all model id’s

Kind: instance abstract method of AbstractProfileService
Returns: Promise.<Object> - map of contexts
Access: protected

_getContextModelIds(profileId, contextType, [options]) ⇒ Promise.<Object>#

Vendor implementation to get for a context all model id’s

Kind: instance abstract method of AbstractProfileService
Returns: Promise.<Object> - A map { id: value }
Access: protected

_onSseEvent(event)#

Vendor implementation of sse callback

Kind: instance abstract method of AbstractProfileService
Access: protected

_getRecommended(profileId, ruleId, [options]) ⇒ Promise.<BusinessModel>#

Implementation for get recommended Business Model by rule

Kind: instance abstract method of AbstractProfileService

“profileCleanContext”#

Fired when current profile clean context cache

Kind: event emitted by AbstractProfileService
Properties

“profileAddContext” (data)#

Fired when current profile add context

Kind: event emitted by AbstractProfileService

“profileAddContext” (data)#

Fired when current profile remove context

Kind: event emitted by AbstractProfileService