Interface ISDK

The SDK interface.

interface ISDK {
    authenticateAgent(credentials: IAgentCredentials): Promise<IAuthAgent>;
    authenticateUser(credentials: IUserCredentials): Promise<IAuthUser>;
    close(options?: ISDKCloseOptions): Promise<void>;
    joinCluster(clusterId: string): Promise<ICluster>;
}

Index

Methods

authenticateAgent authenticateUser close joinCluster

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.

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.

close

close(options?): Promise<void>
Close the SDK.
Parameters
- Optionaloptions: ISDKCloseOptions
  The options to close the SDK with.
Returns Promise<void>

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.