Class Session

One connection's protocol. Each method returns the actions to carry out. now is whole milliseconds from a clock that only goes forward (Math.floor(performance.now()), or Date.now()).

Index

Constructors

Methods

[dispose] closed deadline free isConnected isSubscribed open receive refresh tick

Constructors

constructor

new Session(channels: string[]): Session
A session for these feeds.
Parameters
- channels: string[]
Returns Session
- Defined in pkg/kicksdk.d.ts:119

Methods

[dispose]

"[dispose]"(): void
Returns void
- Defined in pkg/kicksdk.d.ts:99

closed

closed(): any
The socket closed.

Returns any
- Defined in pkg/kicksdk.d.ts:103

deadline

deadline(): number | undefined
When to call tick next, in ms, or undefined.

Returns number | undefined
- Defined in pkg/kicksdk.d.ts:107

free

free(): void
Returns void
- Defined in pkg/kicksdk.d.ts:98

isConnected

isConnected(): boolean
Whether Kick accepted the connection.

Returns boolean
- Defined in pkg/kicksdk.d.ts:111

isSubscribed

isSubscribed(channel: string): boolean
Whether a feed is subscribed.
Parameters
- channel: string
Returns boolean
- Defined in pkg/kicksdk.d.ts:115

open

open(token: string, now: number): any
The socket opened.
Parameters
- token: string
- now: number
Returns any
- Defined in pkg/kicksdk.d.ts:123

receive

receive(text: string, now: number): any
A text frame arrived.
Parameters
- text: string
- now: number
Returns any
- Defined in pkg/kicksdk.d.ts:127

refresh

refresh(token: string, now: number): any
A new token, after a refresh_token action.
Parameters
- token: string
- now: number
Returns any
- Defined in pkg/kicksdk.d.ts:131

tick

tick(now: number): any
The clock reached deadline().
Parameters
- now: number
Returns any
- Defined in pkg/kicksdk.d.ts:135