Class Lighthouse

Index

Constructors

Properties

Accessors

Methods

accountInfo channelAirings currentLiveAirings devices get guideChannels post resolveDevice selectDeviceContext execute listAvailableDevices listVirtualDevices virtualDevice

Constructors

constructor

new Lighthouse(
    email: string,
    password: string,
    timeout?: number,
    request_logging?: boolean,
): Lighthouse
Parameters
- email: string
- password: string
- timeout: number = 2000
- request_logging: boolean = false
Returns Lighthouse

Properties

`Readonly`timeout

timeout: number = 2000

Accessors

authenticated

get authenticated(): boolean
Returns boolean

Methods

accountInfo

accountInfo(timeout?: number): Promise<undefined | AccountInfo>
Retrieves the account information
Parameters
- timeout: number = ...
Returns Promise<undefined | AccountInfo>

channelAirings

channelAirings(
    channel_id: string,
    context_token?: string,
    timeout?: number,
): Promise<GuideAiring[]>
Retrieves the current airing information for the specified channel within the specified device context
Parameters
- channel_id: string
- context_token: string = ...
- timeout: number = ...
Returns Promise<GuideAiring[]>

currentLiveAirings

currentLiveAirings(
context_token?: string,
timeout?: number,
): Promise<LiveAiring[]>
Retrieves the list of live airings for the specified device context
Parameters
- context_token: string = ...
- timeout: number = ...
Returns Promise<LiveAiring[]>

devices

devices(timeout?: number): Promise<Lighthouse.Device[]>
Retrieves a list of the devices associated with the account
Parameters
- timeout: number = ...
Returns Promise<Lighthouse.Device[]>

`Protected`get

get<ResponseType = any>(
    endpoint: string,
    params?: Record<string, any>,
    timeout?: number,
    token?: string,
): Promise<ResponseType>
Type Parameters
- ResponseType = any
Parameters
- endpoint: string
- params: Record<string, any> = {}
- timeout: number = ...
- Optionaltoken: string
Returns Promise<ResponseType>

guideChannels

guideChannels(context_token?: string, timeout?: number): Promise<GuideChannel[]>
Retrieves the list of channels available within the specified device context
Parameters
- context_token: string = ...
- timeout: number = ...
Returns Promise<GuideChannel[]>

`Protected`post

post<ResponseType = any>(
    endpoint: string,
    payload?: object,
    timeout?: number,
    token?: string,
): Promise<ResponseType>
Type Parameters
- ResponseType = any
Parameters
- endpoint: string
- Optionalpayload: object
- timeout: number = ...
- Optionaltoken: string
Returns Promise<ResponseType>

resolveDevice

resolveDevice(
server_id: string,
timeout?: number,
): Promise<undefined | Lighthouse.Device>
Attempts to retrieve information regarding a specific device associated with the account
Parameters
- server_id: string
- timeout: number = ...
Returns Promise<undefined | Lighthouse.Device>

selectDeviceContext

selectDeviceContext(
    profile_id: string,
    server_id: string,
    timeout?: number,
): Promise<undefined | string>
Selects the device context based upon the specified profile_id and server_id.
Parameters
- profile_id: string
- server_id: string
- timeout: number = ...
Returns Promise<undefined | string>

`Static`execute

execute<ResponseType = any>(
    method: string,
    endpoint: string,
    params?: Record<string, any>,
    payload?: string | Record<string, any>,
    timeout?: number,
): Promise<ResponseType>
Type Parameters
- ResponseType = any
Parameters
- method: string
- endpoint: string
- params: Record<string, any> = {}
- Optionalpayload: string | Record<string, any>
- timeout: number = 2000
Returns Promise<ResponseType>

`Static`listAvailableDevices

listAvailableDevices(timeout?: number): Promise<Lighthouse.Device[]>
Retrieves a list of devices associated with the network from which this API call is made.
Parameters
- timeout: number = 2000
Returns Promise<Lighthouse.Device[]>

`Static`listVirtualDevices

listVirtualDevices(timeout?: number): Promise<Lighthouse.Device[]>
Retrieves a list of virtual devices associated with the network from which this API call is made.
Parameters
- timeout: number = 2000
Returns Promise<Lighthouse.Device[]>

`Static`virtualDevice

virtualDevice(
server_id: string,
timeout?: number,
): Promise<undefined | Lighthouse.Device>
Attempts to retrieve the specified virtual device associated with the network from which this API call is made.
Parameters
- server_id: string
- timeout: number = 2000
Returns Promise<undefined | Lighthouse.Device>