Class GroupSubchannel

TODO -> zhujun

Hierarchy

ConversationChannel<GroupSubchannelModel>
- GroupSubchannel

Properties

channelType

channelType: ChannelType

createAt

createAt: number

Readonly subchannelCreatedAt

subchannelCreatedAt: number

Accessors

creatorId

get creatorId(): string

Inherited from ConversationChannel.creatorId
- Defined in core/modules/BaseChannel.ts:42
Returns string

draft

get draft(): string

- Defined in chat/group-channel/GroupSubchannel.ts:153
TODO -> zhujun

Returns string

firstUnreadMessageCreatedAt

get firstUnreadMessageCreatedAt(): null | number

- Defined in chat/group-channel/GroupSubchannel.ts:163
TODO -> zhujun

Returns null | number

id

get id(): string

Overrides ConversationChannel.id
- Defined in chat/group-channel/GroupSubchannel.ts:53
TODO -> zhujun

Returns string

isJoined

get isJoined(): boolean

- Defined in chat/group-channel/GroupSubchannel.ts:87
TODO -> zhujun

Returns boolean

lastMessage

get lastMessage(): null | BaseMessage

- Defined in chat/group-channel/GroupSubchannel.ts:137
TODO -> zhujun

Returns null | BaseMessage

name

get name(): string

Inherited from ConversationChannel.name
- Defined in core/modules/BaseChannel.ts:38
Returns string

parentChannel

get parentChannel(): GroupChannel

- Defined in chat/group-channel/GroupSubchannel.ts:65
TODO -> zhujun

Returns GroupChannel

pushNotificationLevel

get pushNotificationLevel(): PushNotificationLevel

- Defined in chat/group-channel/GroupSubchannel.ts:127
TODO -> zhujun

Returns PushNotificationLevel

subchannelType

get subchannelType(): GroupSubchannelType

- Defined in chat/group-channel/GroupSubchannel.ts:97
TODO -> zhujun

Returns GroupSubchannelType

unreadMentionCount

get unreadMentionCount(): number

- Defined in chat/group-channel/GroupSubchannel.ts:117
TODO -> zhujun

Returns number

unreadMessageCount

get unreadMessageCount(): number

- Defined in chat/group-channel/GroupSubchannel.ts:107
TODO -> zhujun

Returns number

Methods

addMembers

addMembers(userIds: string[]): Promise<CMSYResult<void>>

- Defined in chat/group-channel/GroupSubchannel.ts:724
TODO -> zhujun

Parameters
- userIds: string[]
Returns Promise<CMSYResult<void>>

createMemberListQuery

createMemberListQuery(params?: GroupSubchannelMemberListQueryParams): GroupSubchannelMemberListQuery

- Defined in chat/group-channel/GroupSubchannel.ts:770
TODO -> zhujun

Parameters
- Optional params: GroupSubchannelMemberListQueryParams
Returns GroupSubchannelMemberListQuery

createPreviousMessageListQuery

createPreviousMessageListQuery(params: PreviousMessageListQueryParams): PreviousMessageListQuery

Overrides ConversationChannel.createPreviousMessageListQuery
- Defined in chat/group-channel/GroupSubchannel.ts:797
TODO -> zhujun

Parameters
- params: PreviousMessageListQueryParams
Returns PreviousMessageListQuery

deleteMessage

deleteMessage(params: MessageDeleteParams): Promise<CMSYResult<void>>

- Defined in chat/group-channel/GroupSubchannel.ts:371
TODO -> zhujun

Parameters
- params: MessageDeleteParams
Returns Promise<CMSYResult<void>>

getDraft

getDraft(): Promise<CMSYResult<string>>

- Defined in chat/group-channel/GroupSubchannel.ts:215
TODO -> zhujun

Returns Promise<CMSYResult<string>>

getFirstUnreadMessageInfo

getFirstUnreadMessageInfo(): Promise<CMSYResult<null | FirstUnreadMessageInfo>>

- Defined in chat/group-channel/GroupSubchannel.ts:599
TODO -> zhujun

Returns Promise<CMSYResult<null | FirstUnreadMessageInfo>>

getMessagesByUIds

getMessagesByUIds(UIds: string[]): Promise<CMSYResult<BaseMessage[]>>

- Defined in chat/group-channel/GroupSubchannel.ts:509
TODO -> zhujun

Parameters
- UIds: string[]
Returns Promise<CMSYResult<BaseMessage[]>>

getMyNotificationLevel

getMyNotificationLevel(): Promise<CMSYResult<PushNotificationLevel>>

- Defined in chat/group-channel/GroupSubchannel.ts:556
TODO -> zhujun

Returns Promise<CMSYResult<PushNotificationLevel>>

getReadStatus

getReadStatus(): Promise<CMSYResult<UserReadStatus[]>>

- Defined in chat/group-channel/GroupSubchannel.ts:701
TODO -> zhujun

Returns Promise<CMSYResult<UserReadStatus[]>>

getReadStatusByMessageUId

getReadStatusByMessageUId(messageUId: string): Promise<CMSYResult<MessageReadMemberInfo>>

- Defined in chat/group-channel/GroupSubchannel.ts:684
TODO -> zhujun

Parameters
- messageUId: string
Returns Promise<CMSYResult<MessageReadMemberInfo>>

getReadStatusCount

getReadStatusCount(messages: Required<Pick<BaseMessage, "UId" | "createdAt">>[]): Promise<CMSYResult<MessageReadStatus[]>>

- Defined in chat/group-channel/GroupSubchannel.ts:638
TODO -> zhujun

Parameters
- messages: Required<Pick<BaseMessage, "UId" | "createdAt">>[]
Returns Promise<CMSYResult<MessageReadStatus[]>>

getUnreadMentionedMessages

getUnreadMentionedMessages(params: MessageDigestListParams): Promise<CMSYResult<MessageDigest[]>>

- Defined in chat/group-channel/GroupSubchannel.ts:611
TODO -> zhujun

Parameters
- params: MessageDigestListParams
Returns Promise<CMSYResult<MessageDigest[]>>

getUnreadMessageCount

getUnreadMessageCount(params?: GroupSubchannelUnreadMessageCountParams): Promise<CMSYResult<number>>

- Defined in chat/group-channel/GroupSubchannel.ts:582
TODO -> zhujun

Parameters
- Optional params: GroupSubchannelUnreadMessageCountParams
Returns Promise<CMSYResult<number>>

markAsRead

markAsRead(): Promise<CMSYResult<void>>

- Defined in chat/group-channel/GroupSubchannel.ts:571
TODO -> zhujun

Returns Promise<CMSYResult<void>>

removeMembers

removeMembers(userIds: string[]): Promise<CMSYResult<void>>

- Defined in chat/group-channel/GroupSubchannel.ts:747
TODO -> zhujun

Parameters
- userIds: string[]
Returns Promise<CMSYResult<void>>

sendCustomMessage

sendCustomMessage(params: CustomMessageCreateParams): CustomMessageRequestHandler

Inherited from ConversationChannel.sendCustomMessage
- Defined in core/modules/ConversationChannel.ts:59
TODO -> zhujun

Parameters
- params: CustomMessageCreateParams
Returns CustomMessageRequestHandler

sendFileMessage

sendFileMessage(params: FileMessageCreateParams): FileMessageRequestHandler

Inherited from ConversationChannel.sendFileMessage
- Defined in core/modules/ConversationChannel.ts:44
TODO -> zhujun

Parameters
- params: FileMessageCreateParams
Returns FileMessageRequestHandler

sendTextMessage

sendTextMessage(params: TextMessageCreateParams): TextMessageRequestHandler

Inherited from ConversationChannel.sendTextMessage
- Defined in core/modules/ConversationChannel.ts:31
TODO -> zhujun

Parameters
- params: TextMessageCreateParams
Returns TextMessageRequestHandler

setDraft

setDraft(draft: string): Promise<CMSYResult<void>>

- Defined in chat/group-channel/GroupSubchannel.ts:202
TODO -> zhujun

Parameters
- draft: string
Returns Promise<CMSYResult<void>>

setMyNotificationLevel

setMyNotificationLevel(level: PushNotificationLevel): Promise<CMSYResult<void>>

- Defined in chat/group-channel/GroupSubchannel.ts:535
TODO -> zhujun

Parameters
- level: PushNotificationLevel
Returns Promise<CMSYResult<void>>

startTyping

startTyping(): Promise<CMSYResult<void>>

- Defined in chat/group-channel/GroupSubchannel.ts:189
TODO -> zhujun

Returns Promise<CMSYResult<void>>

toJSON

toJSON(): object

Overrides ConversationChannel.toJSON
- Defined in chat/group-channel/GroupSubchannel.ts:167
Returns object

updateCustomMessage

updateCustomMessage(message: CustomMessage, params: CustomMessageUpdateParams): Promise<CMSYResult<void>>

- Defined in chat/group-channel/GroupSubchannel.ts:463
TODO -> zhujun

Parameters
- message: CustomMessage
- params: CustomMessageUpdateParams
Returns Promise<CMSYResult<void>>

updateFileMessage

updateFileMessage(message: FileMessage, params: FileMessageUpdateParams): Promise<CMSYResult<void>>

- Defined in chat/group-channel/GroupSubchannel.ts:432
TODO -> zhujun

Parameters
- message: FileMessage
- params: FileMessageUpdateParams
Returns Promise<CMSYResult<void>>

updateTextMessage

updateTextMessage(message: TextMessage, params: TextMessageUpdateParams): Promise<CMSYResult<void>>

- Defined in chat/group-channel/GroupSubchannel.ts:390
TODO -> zhujun

Parameters
- message: TextMessage
- params: TextMessageUpdateParams
Returns Promise<CMSYResult<void>>

Generated using TypeDoc