Class Client

Hierarchy

Client

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Client(gateway: Gateway, auth: Auth, session: Session | null, country?: string, language?: string): Client

- Defined in client.ts:11
Parameters
- gateway: Gateway
- auth: Auth
- session: Session | null
- Default value country: string = constants.DEFAULT_COUNTRY
- Default value language: string = constants.DEFAULT_LANGUAGE
Returns Client

Properties

auth

auth: Auth

country

country: string

devices

devices: DeviceInfo[] = []

gateway

gateway: Gateway

language

language: string

modelInfo

modelInfo: object

Type declaration

[key: string]: any

session

session: Session | null

Methods

getDevice

getDevice(deviceId: string): Promise<undefined | DeviceInfo>

- Defined in client.ts:131
Parameters
- deviceId: string
Returns Promise<undefined | DeviceInfo>

getModelInfo

getModelInfo(device: DeviceInfo): Promise<ModelInfo>

- Defined in client.ts:148
Parameters
- device: DeviceInfo
Returns Promise<ModelInfo>

refresh

refresh(): Promise<void>

- Defined in client.ts:139
Returns Promise<void>

toStateObject

toStateObject(): object

- Defined in client.ts:94
Returns object
- auth: undefined | object
- country: string
- gateway: undefined | object
- language: string
- modelInfo: object
  - [key: string]: any
- session: undefined | string

updateDevices

updateDevices(): Promise<void>

- Defined in client.ts:124
Returns Promise<void>

Static loadFromState

loadFromState(state: object): Client

- Defined in client.ts:32
Parameters
- state: object
Returns Client

Static loadFromToken

loadFromToken(refreshToken: string, country?: string, language?: string): Promise<Client>

- Defined in client.ts:22
Parameters
- refreshToken: string
- Default value country: string = constants.DEFAULT_COUNTRY
- Default value language: string = constants.DEFAULT_LANGUAGE
Returns Promise<Client>

Generated using TypeDoc