Class SDK

The SDK class. This is the entry point for the Crewdle SDK.

Implements

ISDK

Index

Methods

authenticateAgent authenticateUser close joinCluster getInstance isProduction timestamp

Methods

authenticateAgent

authenticateAgent(credentials): Promise<IAuthAgent>
Authenticate an agent.
Parameters
- credentials: IAgentCredentials
  The credentials to authenticate the agent with.
Returns Promise<IAuthAgent>
A promise that resolves with the authenticated agent.

Implementation of ISDK.authenticateAgent

authenticateUser

authenticateUser(credentials): Promise<IAuthUser>
Authenticate a user.
Parameters
- credentials: IUserCredentials
  The credentials to authenticate the user with.
Returns Promise<IAuthUser>
A promise that resolves with the authenticated user.

Implementation of ISDK.authenticateUser

close

close(): Promise<void>
Close the SDK.

Returns Promise<void>
Implementation of ISDK.close

joinCluster

joinCluster(clusterId): Promise<ICluster>
Join a cluster.
Parameters
- clusterId: string
  The ID of the cluster to join.
Returns Promise<ICluster>
A promise that resolves with the cluster.

Throws
SDKClientErrorCodes.NodeNotAuthenticated if the node is not authenticated.

Implementation of ISDK.joinCluster

`Static` getInstance

getInstance(vendorId, accessToken, options?, secretKey?): Promise<ISDK>
Get an instance of the SDK.
Parameters
- vendorId: string
  The ID of the vendor to access the SDK.
- accessToken: string
  The access token to validate the access to the SDK.
- Optional options: ISDKOptions
  The options to configure the SDK.
- Optional secretKey: string
  The secret key to use for the SDK when calling from a server.
Returns Promise<ISDK>
An instance of the SDK.

`Static` isProduction

isProduction(): boolean
Get if the SDK is running in production mode.

Returns boolean

`Static` timestamp

timestamp(): Promise<number>
Get the current estimated server timestamp.

Returns Promise<number>

Generated using TypeDoc