Interface TalkChannel

TalkChannel interface includes managed methods and other methods that make it easier to use

Hierarchy

Channel
ChannelDataStore<ChannelInfo, ChannelUserInfo>
ChannelSession
TypedEmitter<TalkChannelEvents>
- TalkChannel

Index

Properties

Readonly chatListStore

chatListStore: UpdatableChatListStore

Readonly clientUser

clientUser: Readonly<ChannelUser>

Get client user

Readonly store

store: UpdatableChannelDataStore<ChannelInfo, ChannelUserInfo>

Readonly userCount

userCount: number

Get total user count

Methods

getAllUserInfo

getAllUserInfo(): IterableIterator<ChannelUserInfo>

Overrides ChannelDataStore.getAllUserInfo
- Defined in talk/channel/index.ts:70
Get user info iterator

Returns IterableIterator<ChannelUserInfo>

getDisplayName

getDisplayName(): string

- Defined in talk/channel/index.ts:58
Get displayed channel name

Returns string

getName

getName(): string

- Defined in talk/channel/index.ts:53
Get channel name

Returns string

getReadCount

getReadCount(chat: ChatLogged): number

Overrides ChannelDataStore.getReadCount
- Defined in talk/channel/index.ts:83
Get read count of the chat. This may not work correctly on channel with many users. (99+)

Parameters
- chat: ChatLogged
Returns number

getReaders

getReaders(chat: ChatLogged): Readonly<ChannelUserInfo>[]

Overrides ChannelDataStore.getReaders
- Defined in talk/channel/index.ts:91
Get readers in this channel. This may not work correctly on channel with many users. (99+)

Parameters
- chat: ChatLogged
Returns Readonly<ChannelUserInfo>[]

getUserInfo

getUserInfo(user: ChannelUser): undefined | Readonly<ChannelUserInfo>

Overrides ChannelDataStore.getUserInfo
- Defined in talk/channel/index.ts:65
Get channel user info

Parameters
- user: ChannelUser
  
  User to find
Returns undefined | Readonly<ChannelUserInfo>

sendMedia

sendMedia(type: number, template: MediaUploadTemplate): AsyncCommandResult<Chatlog>

- Defined in talk/channel/index.ts:160
Upload media and send.

Parameters
- type: number
- template: MediaUploadTemplate
Returns AsyncCommandResult<Chatlog>

sendMultiMedia

sendMultiMedia(type: number, templates: MediaUploadTemplate[]): AsyncCommandResult<Chatlog>

- Defined in talk/channel/index.ts:168
Upload multi media and send.

Parameters
- type: number
- templates: MediaUploadTemplate[]
Returns AsyncCommandResult<Chatlog>

setGroupMeta

setGroupMeta(content: GroupMetaContent): AsyncCommandResult<void>

- Defined in talk/channel/index.ts:152
Set group profile meta

Parameters
- content: GroupMetaContent
Returns AsyncCommandResult<void>

setLiveTalkCountMeta

setLiveTalkCountMeta(content: LiveTalkCountMetaContent): AsyncCommandResult<void>

- Defined in talk/channel/index.ts:138
Set live talk count meta

Parameters
- content: LiveTalkCountMetaContent
Returns AsyncCommandResult<void>

setLiveTalkInfoMeta

setLiveTalkInfoMeta(content: LiveTalkInfoMetaContent): AsyncCommandResult<void>

- Defined in talk/channel/index.ts:145
Set live talk info meta

Parameters
- content: LiveTalkInfoMetaContent
Returns AsyncCommandResult<void>

setNoticeMeta

setNoticeMeta(notice: string): AsyncCommandResult<void>

- Defined in talk/channel/index.ts:110
Set channel notice

Parameters
- notice: string
Returns AsyncCommandResult<void>

setProfileMeta

setProfileMeta(content: ProfileMetaContent): AsyncCommandResult<void>

- Defined in talk/channel/index.ts:117
Set channel profile

Parameters
- content: ProfileMetaContent
Returns AsyncCommandResult<void>

setTitleMeta

setTitleMeta(title: string): AsyncCommandResult<void>

- Defined in talk/channel/index.ts:103
Set channel title

Parameters
- title: string
Returns AsyncCommandResult<void>

setTvLiveMeta

setTvLiveMeta(content: TvLiveMetaContent): AsyncCommandResult<void>

- Defined in talk/channel/index.ts:131
Set channel tv live meta

Parameters
- content: TvLiveMetaContent
Returns AsyncCommandResult<void>

setTvMeta

setTvMeta(content: TvMetaContent): AsyncCommandResult<void>

- Defined in talk/channel/index.ts:124
Set channel tv meta

Parameters
- content: TvMetaContent
Returns AsyncCommandResult<void>

updateAll

updateAll(): AsyncCommandResult<void>

- Defined in talk/channel/index.ts:96
Update channel info and every user info

Returns AsyncCommandResult<void>

Generated using TypeDoc