Global

Methods

initializeClient(config) → {Elarian}

Initialize a client

Parameters:
Name Type Description
config ClientConfig
Source:
Returns:
Type
Elarian

Type Definitions

AppState

An object representing app state

Type:
  • Object
Properties:
Name Type Description
appId string
token string
state Buffer
Source:

ClientConfig

An object representing client params

Type:
  • Object
Properties:
Name Type Attributes Description
token string
appId string
options Object <optional>
Source:

Event

An string representing an event. Must be one of:

  • Connection Events:
    • error: Emitted on connection error
    • closed: Emitted on connection closed
    • pending: Emitted when not connected
    • connected: Emitted on connection success
    • connecting: Emitted when connecting
  • App Events
    • consentDenied: ...
    • consentRevoked: ...
Type:
  • string
Source:

NotificationHandler(notification, callbackopt) → {void}

A function that reacts to events

Parameters:
Name Type Attributes Description
notification Notification
callback NotificationCallback <optional>

A response to the event. Required for voice and ussd events
Source:
Returns:
Type
void