Class AxpOmniSdk

Attach event handler callback that needs to be invoked when user has remained inactive for the idleTimeout duration.

Attach event handler callback that needs to be invoked when SDK gets initialized.

Attach event handler callback that needs to be invoked when SDK shuts down.

Get the default conversation for this SDK instance. Before calling this method, it is mandatory for the SDK to be initialized.

Note: In order to fully leverage the advantages of TypeScript, it is recommended to specify the type of the conversation class that was provided to the SDK during initialization. See init method. If no class was provided to the SDK during initialization, then the default conversation class will be AxpConversationCore and there is no need to specify the type.

Example

const defaultConversation = AxpOmniSdk.getDefaultConversation<typeof AxpConversationMixedClass>();
Copy

Initialize the SDK and conversation with the given parameters. Before any operation can be performed with the SDK, it must be initialized. The initialization process creates a new session for the current user (identified by the JWT) and returns a AxpUserSession object that contains the Conversation object corresponding to the User's ongoing conversation.

Initialize the SDK and conversation with the given parameters. Before any operation can be performed with the SDK, it must be initialized. The initialization process creates a new session for the current user (identified by the JWT) and returns a AxpUserSession object that contains the Conversation object corresponding to the User's ongoing conversation.

Example

const AxpConversationMixedClass = AxpMessagingConversation();

const SDKUserSession = await AxpOmniSdk.init({
  displayName: <displayName>,
  token: <jwt_token>,
  integrationId: <integration_id>,
  host: <region>,
  appKey: <appKey>,
  logLevel: <logLevel>,
  idleTimeoutDuration: <idleTimeOutDuration>,
  idleShutdownGraceTimeoutDuration: <graceTimeoutDuration>,
  jwtProvider: <jwtProviderImpl>
}, AxpConversationMixedClass);
Copy

Remove the event handler callback that was attached to the idleTimeout event.

Remove the event handler callback that was attached to the SDK initialization event.

Remove the event handler callback that was attached to the SDK shutdown event.

Reset the idle timer to indicate the SDK that the user session is still active. The SDK already resets the timeout when it receives a request internally from the modules or other sub modules(AXP Messaging).

Invoke this method only when client want to indicate a user's activity visible only to the client (apart from the above mentioned activities).

Set a new Jwt for the SDK to invoke APIs at server. Before calling this method, it is mandatory for the SDK to be initialized.

Sets the log level of SDK.

Shutdown the SDK and closes the session with AXP. After shutdown, if the SDK is required to be used again, re-initialize it by calling init. Before calling this method, it is mandatory for the SDK to be initialized.