Class TalkClient

Simple client implementation.

Hierarchy

TypedEmitter<TalkClientEvents>
- TalkClient

Implements

CommandSession
ClientSession
Managed<TalkClientEvents>

Index

Constructors

constructor

Properties

pingInterval

Accessors

Methods

Constructors

constructor

new TalkClient(config?: Partial<ClientConfig>, loader?: ClientDataLoader, _sessionFactory?: SessionFactory): TalkClient

Overrides TypedEmitter<TalkClientEvents>.constructor
- Defined in talk/client/index.ts:60
Parameters
- config: Partial<ClientConfig> = {}
- loader: ClientDataLoader = ...
- _sessionFactory: SessionFactory = ...
Returns TalkClient

Properties

pingInterval

pingInterval: number

Ping request interval. (Default = 60000 (1 min))

Accessors

blockList

get blockList(): TalkBlockSession

- Defined in talk/client/index.ts:98
Returns TalkBlockSession

channelList

get channelList(): TalkChannelList

- Defined in talk/client/index.ts:88
Returns TalkChannelList

clientUser

get clientUser(): ChannelUser

- Defined in talk/client/index.ts:92
Returns ChannelUser

configuration

get configuration(): ClientConfig
set configuration(configuration: ClientConfig): void

- Defined in talk/client/index.ts:80
Returns ClientConfig
- Defined in talk/client/index.ts:84
Parameters
- configuration: ClientConfig
Returns void

logon

get logon(): boolean

- Defined in talk/client/index.ts:105
true if session created

Returns boolean

Methods

close

close(): void

- Defined in talk/client/index.ts:156
End session

Returns void

createSessionProxy

createSessionProxy(): TalkSession

- Defined in talk/client/index.ts:186
Create proxy that can be used safely without exposing client

Returns TalkSession

getTokens

getTokens(unknown: number[]): AsyncCommandResult<DefaultRes>

- Defined in talk/client/index.ts:140
Parameters
- unknown: number[]
Returns AsyncCommandResult<DefaultRes>

isClientUser

isClientUser(user: ChannelUser): boolean

- Defined in talk/client/index.ts:149
Parameters
- user: ChannelUser
  
  Target user to compare
Returns boolean

true if client user.

login

login(credential: OAuthCredential): AsyncCommandResult<LoginResult>

Implementation of ClientSession.login
- Defined in talk/client/index.ts:115
Parameters
- credential: OAuthCredential
Returns AsyncCommandResult<LoginResult>

pushReceived

pushReceived(method: string, data: DefaultRes, ctx: EventContext<TalkClientEvents>): void

Implementation of Managed.pushReceived
- Defined in talk/client/index.ts:162
Parameters
- method: string
- data: DefaultRes
- ctx: EventContext<TalkClientEvents>
Returns void

request

request<T>(method: string, data: DefaultReq): Promise<DefaultRes & T>

Implementation of CommandSession.request
- Defined in talk/client/index.ts:203
Type parameters
- T = DefaultRes
Parameters
- method: string
- data: DefaultReq
Returns Promise<DefaultRes & T>

setStatus

setStatus(status: ClientStatus): AsyncCommandResult<void>

Implementation of ClientSession.setStatus
- Defined in talk/client/index.ts:136
Parameters
- status: ClientStatus
Returns AsyncCommandResult<void>

Generated using TypeDoc