CommunitySubChannel | NexconnChat

Represents a sub-channel within a community (ultra group).

example

const sub = new CommunitySubChannel('community-001', 'sub-001');
const params = new SendTextMessageParams({ text: 'Hello sub-channel' });
await sub.sendMessage(params);

Hierarchy

BaseChannel
- CommunitySubChannel

Methods

Static createChannelsQuery

createChannelsQuery(params: ChannelsQueryParams): ChannelsQuery

Inherited from BaseChannel.createChannelsQuery
Creates a paginated query for listing channels.
example
```
const query = BaseChannel.createChannelsQuery({ pageSize: 20 });
const result = await query.loadNextPage();
```
Parameters
- params: ChannelsQueryParams
  
  Query parameters
Returns ChannelsQuery
A ChannelsQuery instance

Static getUnreadChannels

getUnreadChannels(channelTypes: ChannelType[]): Promise<NCResult<BaseChannel[]>>

Inherited from BaseChannel.getUnreadChannels
Gets channels that have unread messages.
example
```
const result = await BaseChannel.getUnreadChannels([ChannelType.DIRECT, ChannelType.GROUP]);
```
Parameters
- channelTypes: ChannelType[]
  
  Filter by channel types
Returns Promise<NCResult<BaseChannel[]>>
A promise resolving to the list of channels with unread messages

Static getPinnedChannels

getPinnedChannels(channelTypes: ChannelType[]): Promise<NCResult<BaseChannel[]>>

Inherited from BaseChannel.getPinnedChannels
Gets pinned (top) channels filtered by channel types.
example
```
const result = await BaseChannel.getPinnedChannels([ChannelType.DIRECT, ChannelType.GROUP]);
```
Parameters
- channelTypes: ChannelType[]
  
  Filter by channel types
Returns Promise<NCResult<BaseChannel[]>>
A promise resolving to the list of pinned channels

Static deleteChannels

deleteChannels(identifiers: ChannelIdentifier[]): Promise<NCResult<void>>

Inherited from BaseChannel.deleteChannels
Deletes channels by their identifiers.
example
```
await BaseChannel.deleteChannels([new DirectChannelIdentifier('user-123')]);
```
Parameters
- identifiers: ChannelIdentifier[]
  
  The channel identifiers to delete
Returns Promise<NCResult<void>>
A promise resolving to the operation result

Static setChannelTypeNoDisturbLevel

setChannelTypeNoDisturbLevel(params: ChannelTypeNoDisturbLevelParams): Promise<NCResult<void>>

Inherited from BaseChannel.setChannelTypeNoDisturbLevel
Sets the do-not-disturb level for all channels of a specific type.
example
```
await BaseChannel.setChannelTypeNoDisturbLevel({
  channelType: ChannelType.GROUP,
  level: ChannelNoDisturbLevel.MUTED,
});
```
Parameters
- params: ChannelTypeNoDisturbLevelParams
  
  The channel type and level parameters
Returns Promise<NCResult<void>>
A promise resolving to the operation result

Static getChannelTypeNoDisturbLevel

getChannelTypeNoDisturbLevel(channelType: ChannelType): Promise<NCResult<ChannelNoDisturbLevel>>

Inherited from BaseChannel.getChannelTypeNoDisturbLevel
Gets the do-not-disturb level applied to all channels of a specific type.
example
```
const r = await BaseChannel.getChannelTypeNoDisturbLevel(ChannelType.DIRECT);
```
Parameters
- channelType: ChannelType
Returns Promise<NCResult<ChannelNoDisturbLevel>>

Static createUnreadMentionMeChannelsQuery

createUnreadMentionMeChannelsQuery(params: UnreadMentionMeChannelsQueryParams): UnreadMentionMeChannelsQuery

Inherited from BaseChannel.createUnreadMentionMeChannelsQuery
Creates a query for channels with unread messages that mention the current user.
example
```
const query = BaseChannel.createUnreadMentionMeChannelsQuery({
  channelTypes: [ChannelType.DIRECT, ChannelType.GROUP],
});
const page = await query.loadNextPage();
```
Parameters
- params: UnreadMentionMeChannelsQueryParams
  
  Query parameters
Returns UnreadMentionMeChannelsQuery
An UnreadMentionMeChannelsQuery instance

Static getTotalUnreadCount

getTotalUnreadCount(): Promise<NCResult<number>>

Inherited from BaseChannel.getTotalUnreadCount
Gets the total unread message count across all channels.
example
```
const result = await BaseChannel.getTotalUnreadCount();
if (result.isOk) {
  console.log('Total unread:', result.data);
}
```
Returns Promise<NCResult<number>>
A promise resolving to the total unread count

Static getChannelsUnreadCountByNoDisturbLevel

getChannelsUnreadCountByNoDisturbLevel(params: ChannelsUnreadCountParams): Promise<NCResult<number>>

Inherited from BaseChannel.getChannelsUnreadCountByNoDisturbLevel
Gets the total unread message count filtered by do-not-disturb levels and channel types.
example
```
const r = await BaseChannel.getChannelsUnreadCountByNoDisturbLevel({
  channelTypes: [ChannelType.DIRECT],
  levels: [ChannelNoDisturbLevel.DEFAULT],
});
```
Parameters
- params: ChannelsUnreadCountParams
  
  Filter parameters
Returns Promise<NCResult<number>>
A promise resolving to the filtered unread count

Static createMessagesReadReceiptUsersQuery

createMessagesReadReceiptUsersQuery(params: MessagesReadReceiptUsersQueryParams): MessagesReadReceiptUsersQuery

Inherited from BaseChannel.createMessagesReadReceiptUsersQuery
Creates a paginated query for users who have read a specific message.
example
```
const query = BaseChannel.createMessageReadReceiptUsersQuery({
  channelIdentifier: new DirectChannelIdentifier('user-123'),
  messageId: 'msg-id',
  status: MessageReadReceiptStatus.RESPONDED,
});
```
Parameters
- params: MessagesReadReceiptUsersQueryParams
  
  Query parameters
Returns MessagesReadReceiptUsersQuery
A MessagesReadReceiptUsersQuery instance

reload

reload(): Promise<NCResult<BaseChannel>>

Inherited from BaseChannel.reload
Reloads this channel from the server and returns a fresh BaseChannel instance.
example
```
const refreshed = await channel.reload();
```
Returns Promise<NCResult<BaseChannel>>

pin(): Promise<NCResult<void>>

Inherited from BaseChannel.pin
Pins this channel to the top of the channel list.
example
```
await channel.pin();
```
Returns Promise<NCResult<void>>
A promise resolving to the operation result

unpin

unpin(): Promise<NCResult<void>>

Inherited from BaseChannel.unpin
Unpins this channel from the top of the channel list.
example
```
await channel.unpin();
```
Returns Promise<NCResult<void>>
A promise resolving to the operation result

delete

delete(): Promise<NCResult<void>>

Inherited from BaseChannel.delete

Deletes this channel.

Returns Promise<NCResult<void>>
A promise resolving to the operation result

deleteTags

deleteTags(tagIds: string[]): Promise<NCResult<void>>

Inherited from BaseChannel.deleteTags

Removes tags from this channel.

Parameters
- tagIds: string[]
  
  The tag IDs to remove
Returns Promise<NCResult<void>>
A promise resolving to the operation result

getTags

getTags(): Promise<NCResult<Tag[]>>

Inherited from BaseChannel.getTags

Gets all tags associated with this channel.

Returns Promise<NCResult<Tag[]>>
A promise resolving to the list of tags

setNoDisturbLevel

setNoDisturbLevel(level: ChannelNoDisturbLevel): Promise<NCResult<void>>

Inherited from BaseChannel.setNoDisturbLevel
Sets the do-not-disturb level for this channel.
example
```
await channel.setNoDisturbLevel(ChannelNoDisturbLevel.MUTED);
```
Parameters
- level: ChannelNoDisturbLevel
  
  The notification level to apply
Returns Promise<NCResult<void>>
A promise resolving to the operation result

clearUnreadCount

clearUnreadCount(): Promise<NCResult<void>>

Inherited from BaseChannel.clearUnreadCount

Clears the unread message count for this channel.

Returns Promise<NCResult<void>>
A promise resolving to the operation result

saveDraft

saveDraft(draft: string): Promise<NCResult<void>>

Inherited from BaseChannel.saveDraft

Saves a draft text for this channel.

Parameters
- draft: string
  
  The draft text to save
Returns Promise<NCResult<void>>
A promise resolving to the operation result

clearDraft

clearDraft(): Promise<NCResult<void>>

Inherited from BaseChannel.clearDraft

Clears the saved draft text for this channel.

Returns Promise<NCResult<void>>
A promise resolving to the operation result

deleteMessagesForMe

deleteMessagesForMe(messages: Message<any>[]): Promise<NCResult<void>>

Inherited from BaseChannel.deleteMessagesForMe

Deletes messages for the current user only (messages remain visible to others).

Parameters
- messages: Message<any>[]
  
  The messages to delete
Returns Promise<NCResult<void>>
A promise resolving to the operation result

Static getMessagesByIds

getMessagesByIds(params: GetMessagesByIdsParams): Promise<NCResult<Record<string, undefined | Message<any>>>>

Inherited from BaseChannel.getMessagesByIds
Gets messages by their server-side message IDs.
example
```
const result = await BaseChannel.getMessagesByIds({
  channelIdentifier: new DirectChannelIdentifier('user-123'),
  messageIds: ['msg-1', 'msg-2'],
});
if (result.isOk) {
  const msg = result.data['msg-1'];
}
```
Parameters
- params: GetMessagesByIdsParams
  
  The query parameters
Returns Promise<NCResult<Record<string, undefined | Message<any>>>>
A promise resolving to a map of message ID to message (or undefined if not found)

deleteMessageForAll

deleteMessageForAll(message: Message<any>): Promise<NCResult<void>>

Inherited from BaseChannel.deleteMessageForAll
Deletes (recalls) a message for all users in the channel.
example
```
await channel.deleteMessageForAll(sentMessage);
```
Parameters
- message: Message<any>
  
  The message to recall
Returns Promise<NCResult<void>>
A promise resolving to the operation result

deleteMessagesForMeByTimestamp

deleteMessagesForMeByTimestamp(params: DeleteMessagesForMeByTimestampParams): Promise<NCResult<void>>

Inherited from BaseChannel.deleteMessagesForMeByTimestamp

Clears messages in this channel before a specific timestamp.

Parameters
- params: DeleteMessagesForMeByTimestampParams
  
  The clear parameters
Returns Promise<NCResult<void>>
A promise resolving to the operation result

sendMessage

sendMessage<T>(params: SendMessageParams<T>): Promise<NCResult<Message<T>>>

Inherited from BaseChannel.sendMessage
Sends a message in this channel.
example
```
const params = new SendTextMessageParams({ text: 'Hello!' });
const result = await channel.sendMessage(params);
if (result.isOk) {
  console.log('Sent message ID:', result.data.messageId);
}
```
Type Parameters
- T extends Record<string, any>
  
  The type of the message content
Parameters
- params: SendMessageParams<T>
  
  The send message parameters
Returns Promise<NCResult<Message<T>>>
A promise resolving to the sent message

sendMediaMessage

sendMediaMessage<T>(params: SendMediaMessageParams<T>): Promise<NCResult<Message<T>>>

Inherited from BaseChannel.sendMediaMessage
Sends a media message (image, file, voice, etc.) that requires file upload.
example
```
const result = await Message.createSendImageMessageParams(imageFile);
if (result.isOk) {
  const sentResult = await channel.sendMediaMessage(result.data);
}
```
Type Parameters
- T extends Record<string, any>
  
  The type of the message content
Parameters
- params: SendMediaMessageParams<T>
  
  The send media message parameters (must include a file)
Returns Promise<NCResult<Message<T>>>
A promise resolving to the sent message

sendReadReceiptResponse

sendReadReceiptResponse(messageIds: string[]): Promise<NCResult<void>>

Inherited from BaseChannel.sendReadReceiptResponse
Sends read receipt responses for the specified messages.
example
```
await channel.sendReadReceiptResponse(['msg-1', 'msg-2']);
```
Parameters
- messageIds: string[]
  
  The message IDs to acknowledge as read
Returns Promise<NCResult<void>>
A promise resolving to the operation result

getMessageReadReceiptInfo

getMessageReadReceiptInfo(messageIds: string[]): Promise<NCResult<MessageReadReceiptInfo[]>>

Inherited from BaseChannel.getMessageReadReceiptInfo

Gets read receipt information for messages in this channel.

Parameters
- messageIds: string[]
  
  The message IDs to query
Returns Promise<NCResult<MessageReadReceiptInfo[]>>
A promise resolving to the read receipt info list

getMessagesReadReceiptByUsers

getMessagesReadReceiptByUsers(params: GetMessagesReadReceiptByUsersParams): Promise<NCResult<MessageReadReceiptUser[]>>

Inherited from BaseChannel.getMessagesReadReceiptByUsers

Gets read receipt status for specific users on a message.

Parameters
- params: GetMessagesReadReceiptByUsersParams
  
  The query parameters
Returns Promise<NCResult<MessageReadReceiptUser[]>>
A promise resolving to the read receipt user list

Static getMessageReadReceiptInfoByIdentifiers

getMessageReadReceiptInfoByIdentifiers(identifiers: MessageIdentifier[]): Promise<NCResult<MessageReadReceiptInfo[]>>

Inherited from BaseChannel.getMessageReadReceiptInfoByIdentifiers

Gets read receipt information for messages across different channels.

Parameters
- identifiers: MessageIdentifier[]
  
  Array of message identifiers (channel + message ID)
Returns Promise<NCResult<MessageReadReceiptInfo[]>>
A promise resolving to the read receipt info list

Static modifyMessage

modifyMessage<T>(params: ModifyMessageParams<T>): Promise<NCResult<void>>

Inherited from BaseChannel.modifyMessage
Modifies (edits) a sent message's content.
example
```
await BaseChannel.modifyMessage({
  channelIdentifier: originalMessage.channelIdentifier,
  messageId: originalMessage.messageId,
  content: { text: 'Updated text' },
});
```
Type Parameters
- T extends Record<string, any>
  
  The type of the message content
Parameters
- params: ModifyMessageParams<T>
  
  The modification parameters (message and new content)
Returns Promise<NCResult<void>>
A promise resolving to the operation result

Static refreshReferenceMessage

refreshReferenceMessage(messages: Message<ReferenceMessageContent>[]): Promise<NCResult<RefreshReferenceMessageResult[]>>

Inherited from BaseChannel.refreshReferenceMessage

Refreshes the quoted content of reference messages to get the latest version.

Parameters
- messages: Message<ReferenceMessageContent>[]
  
  The reference messages to refresh
Returns Promise<NCResult<RefreshReferenceMessageResult[]>>
A promise resolving to the refresh results

Static createMessagesQuery

createMessagesQuery(params: MessagesQueryParams): MessagesQuery

Inherited from BaseChannel.createMessagesQuery
Creates a paginated query for message history.
example
```
const query = BaseChannel.createMessagesQuery({
  channelIdentifier: new DirectChannelIdentifier('user-123'),
  pageSize: 20,
});
const result = await query.loadNextPage();
```
Parameters
- params: MessagesQueryParams
  
  Query parameters
Returns MessagesQuery
A MessagesQuery instance

Accessors

channelId

get channelId(): string

Inherited from BaseChannel.channelId

The channel ID

Returns string

channelType

get channelType(): ChannelType

Inherited from BaseChannel.channelType

The channel type

Returns ChannelType

noDisturbLevel

get noDisturbLevel(): ChannelNoDisturbLevel

Inherited from BaseChannel.noDisturbLevel

The do-not-disturb level for this channel

Returns ChannelNoDisturbLevel

isPinned

get isPinned(): boolean

Inherited from BaseChannel.isPinned

Whether this channel is pinned (stuck to top)

Returns boolean

unreadCount

get unreadCount(): number

Inherited from BaseChannel.unreadCount

The unread message count for this channel

Returns number

operationTime

get operationTime(): number

Inherited from BaseChannel.operationTime

The last operation timestamp (ms) on this channel

Returns number

draft

get draft(): string

Inherited from BaseChannel.draft

The saved draft text for this channel

Returns string

latestMessage

get latestMessage(): null | Message<any>

Inherited from BaseChannel.latestMessage

The latest message in this channel, or null if none

Returns null | Message<any>

translateStrategy

get translateStrategy(): TranslateStrategy

Inherited from BaseChannel.translateStrategy

The translate strategy applied to this channel

Returns TranslateStrategy

includeRobot

get includeRobot(): boolean

Inherited from BaseChannel.includeRobot

Whether this channel includes robot/bot users

Returns boolean

subChannelId

get subChannelId(): string

The sub-channel ID within the community

Returns string

identifier

get identifier(): CommunitySubChannelIdentifier

Overrides BaseChannel.identifier

The community sub-channel identifier

Returns CommunitySubChannelIdentifier

subChannelType

get subChannelType(): CommunitySubChannelType

The type of this sub-channel (public or private)

Returns CommunitySubChannelType

Constructors

constructor

new CommunitySubChannel(channelId: string, subChannelId: string): CommunitySubChannel

Overrides BaseChannel.constructor
Parameters
- channelId: string
  
  Parent community channel ID
- subChannelId: string
  
  Sub-channel ID within the community
Returns CommunitySubChannel

Hierarchy

Index

Methods

Accessors

Constructors

Methods

Static createChannelsQuery

Parameters

params: ChannelsQueryParams

Returns ChannelsQuery

Static getUnreadChannels

Parameters

channelTypes: ChannelType[]

Returns Promise<NCResult<BaseChannel[]>>

Static getPinnedChannels

Parameters

channelTypes: ChannelType[]

Returns Promise<NCResult<BaseChannel[]>>

Static deleteChannels

Parameters

identifiers: ChannelIdentifier[]

Returns Promise<NCResult<void>>

Static setChannelTypeNoDisturbLevel

Parameters

params: ChannelTypeNoDisturbLevelParams

Returns Promise<NCResult<void>>

Static getChannelTypeNoDisturbLevel

Parameters

channelType: ChannelType

Returns Promise<NCResult<ChannelNoDisturbLevel>>

Static createUnreadMentionMeChannelsQuery

Parameters

params: UnreadMentionMeChannelsQueryParams

Returns UnreadMentionMeChannelsQuery

Static getTotalUnreadCount

Returns Promise<NCResult<number>>

Static getChannelsUnreadCountByNoDisturbLevel

Parameters

params: ChannelsUnreadCountParams

Returns Promise<NCResult<number>>

Static createMessagesReadReceiptUsersQuery

Parameters

params: MessagesReadReceiptUsersQueryParams

Returns MessagesReadReceiptUsersQuery

reload

Returns Promise<NCResult<BaseChannel>>

pin

Returns Promise<NCResult<void>>

unpin

Returns Promise<NCResult<void>>

delete

Returns Promise<NCResult<void>>

deleteTags

Parameters

tagIds: string[]

Returns Promise<NCResult<void>>

getTags

Returns Promise<NCResult<Tag[]>>

setNoDisturbLevel

Parameters

level: ChannelNoDisturbLevel

Returns Promise<NCResult<void>>

clearUnreadCount

Returns Promise<NCResult<void>>

saveDraft

Parameters

draft: string

Returns Promise<NCResult<void>>

clearDraft

Returns Promise<NCResult<void>>

deleteMessagesForMe

Parameters

messages: Message<any>[]

Returns Promise<NCResult<void>>

Static getMessagesByIds

Parameters

params: GetMessagesByIdsParams

Returns Promise<NCResult<Record<string, undefined | Message<any>>>>

deleteMessageForAll

Parameters