Class CelebrityAPI

CelebrityAPI is an interface for celebrity actions.

Hierarchy

CelebrityAPI

Index

Constructors

constructor

Methods

Constructors

constructor

new CelebrityAPI(): CelebrityAPI

Returns CelebrityAPI

Methods

login

login(username: string, password: string): Promise<void>

Used to login to the system. Request is retried multiple times in case of network error. Can reject with SDKError. If username/password pair is incorrect, rejects with SDKError with Errors.NOT_FOUND code.

Parameters
- username: string
- password: string
Returns Promise<void>

logout

logout(): void

Used to logout from the system. Stops subscription if active.

Returns void

setLogLevel

setLogLevel(level: LogLevels): void

Sets the level of CelebrityAPI log outputs.

Default is LogLevels.WARN.

Parameters
- level: LogLevels
Returns void

subscribe

subscribe(onData: (data: { sessions: [Session]; total: number }) => any, onError: (e: SDKError) => any): void

Used to start a subscription for active sessions. Accepts two callbacks:

Parameters
- onData: (data: { sessions: [Session]; total: number }) => any
  
  Is called when sessions list is updated with data containing total number of active sessions and top 500 sessions.
  - - (data: { sessions: [Session]; total: number }): any
    - Parameters
      - data: { sessions: [Session]; total: number }
        sessions: [Session]
        total: number
      Returns any
- onError: (e: SDKError) => any
  
  Is called in case of critical error such as Errors.NOT_AUTHORIZED. Automatically stops the subscription.
  - - (e: SDKError): any
    - Parameters
      - e: SDKError
      Returns any
Returns void

unsubscribe

unsubscribe(): void

Used to stop the subscription for active sessions. Aborts any inflight requests.

Returns void