Interface ISignal

Hierarchy

ISignal

Implemented by

Signal

Index

Properties

Properties

browser

browser: (callback?: Callback<undefined | string>) => void

Type declaration

- (callback?: Callback<undefined | string>): void
- Parameters
  - Optional callback: Callback<undefined | string>
  Returns void

debug

debug: (value: boolean) => void

Type declaration

- (value: boolean): void
- Parameters
  - value: boolean
  Returns void

event

event: (type: EventType, eventParams: EventParams, callback?: Callback<EventResponse>) => void

Type declaration

- (type: EventType, eventParams: EventParams, callback?: Callback<EventResponse>): void
- Parameters
  - type: EventType
  - eventParams: EventParams
  - Optional callback: Callback<EventResponse>
  Returns void

forget

forget: () => void

Type declaration

- (): void
- Returns void

identity

identity: (params: IIdentityParams, callback?: Callback<Optional<IIdentity>>) => void

Type declaration

- (params: IIdentityParams, callback?: Callback<Optional<IIdentity>>): void
- Parameters
  - params: IIdentityParams
  - Optional callback: Callback<Optional<IIdentity>>
  Returns void

init

init: (token: string, options?: IInitOptions) => void

Type declaration

- (token: string, options?: IInitOptions): void
- Parameters
  - token: string
  - Optional options: IInitOptions
  Returns void

ping

ping: (callback?: Callback<boolean>) => void

Type declaration

- (callback?: Callback<boolean>): void
- Parameters
  - Optional callback: Callback<boolean>
  Returns void

session

session: (callback?: Callback<undefined | string>) => void

Type declaration

- (callback?: Callback<undefined | string>): void
- Parameters
  - Optional callback: Callback<undefined | string>
  Returns void

Readonly version

version: string

Library version, this also is the same as our API version

whoami

whoami: (callback?: Callback<IUser>) => void

Type declaration

- (callback?: Callback<IUser>): void
- Parameters
  - Optional callback: Callback<IUser>
  Returns void

Generated using TypeDoc