Class GroupChannelModule

name

addGroupChannelHandler

• addGroupChannelHandler(key, handler): void

• Parameters

  • key: string

  • handler: GroupChannelHandler

  Returns void

  Description

  Adds a GroupChannelHandler with a key.

buildGroupChannelFromSerializedData

• buildGroupChannelFromSerializedData(serialized): GroupChannel

• Parameters

  • serialized: object

  Returns GroupChannel

  Description

  Builds GroupChannel instance from serialized data generated by serialize.

buildGroupChannelListQueryFromSerializedData

• buildGroupChannelListQueryFromSerializedData(serialized): GroupChannelListQuery

• Parameters

  • serialized: object

  Returns GroupChannelListQuery

  Description

  Builds GroupChannelListQuery instance from serialized data generated by serialize.

buildMemberFromSerializedData

• buildMemberFromSerializedData(serialized): Member

• Parameters

  • serialized: object

  Returns Member

  Description

  Builds Member instance from serialized data generated by serialize.

createChannel

• createChannel(params?): Promise<GroupChannel>

• Parameters

  • params: GroupChannelCreateParams = {}

  Returns Promise<GroupChannel>

  Description

  Creates GroupChannel with GroupChannelCreateParams.

createChannelWithUserIds

• createChannelWithUserIds(userIds, isDistinct?, name?, coverUrlOrImageFile?, data?, customType?): Promise<GroupChannel>

• Parameters

  • userIds: string[]

  • isDistinct: boolean = false

  • Optional name: string

  • Optional coverUrlOrImageFile: string | FileCompat

  • data: string = ''

  • customType: string = ''

  Returns Promise<GroupChannel>

  Deprecatead

  Description

  Creates GroupChannel with userIds and other parameters.

createDistinctChannelIfNotExist

• createDistinctChannelIfNotExist(params?): Promise<GroupChannel>

• Parameters

  • params: GroupChannelCreateParams = {}

  Returns Promise<GroupChannel>

  Description

  Creates distinct GroupChannel with GroupChannelCreateParams. When this method is executed, GroupChannelCreateParams.isDistinct will be ignored.

createGroupChannelCollection

• createGroupChannelCollection(params?): GroupChannelCollection

• Parameters

  • params: GroupChannelCollectionParams = {}

  Returns GroupChannelCollection

  Description

  Creates a GroupChannelCollection with the params.

createMyGroupChannelListQuery

• createMyGroupChannelListQuery(params?): GroupChannelListQuery

• Parameters

  • params: GroupChannelListQueryParams = {}

  Returns GroupChannelListQuery

  Description

  Creates a GroupChannelListQuery with the params.

createPublicGroupChannelListQuery

• createPublicGroupChannelListQuery(params?): PublicGroupChannelListQuery

• Parameters

  • params: PublicGroupChannelListQueryParams = {}

  Returns PublicGroupChannelListQuery

  Description

  Creates a PublicGroupChannelListQuery with the params.

createScheduledMessageListQuery

• createScheduledMessageListQuery(params?): ScheduledMessageListQuery

• Parameters

  • params: ScheduledMessageListQueryParams = {}

  Returns ScheduledMessageListQuery

  Description

  Creates a ScheduledMessageListQuery with the params.

getChannel

• getChannel(channelUrl): Promise<GroupChannel>

• Parameters

  • channelUrl: string

  Returns Promise<GroupChannel>

  Description

  Gets a GroupChannel with given channel URL.

getChannelWithoutCache

• getChannelWithoutCache(channelUrl): Promise<GroupChannel>

• Parameters

  • channelUrl: string

  Returns Promise<GroupChannel>

  Description

  Gets an GroupChannel with given channel URL from server.

getGroupChannelCount

• getGroupChannelCount(params): Promise<number>

• Parameters

  • params: GroupChannelCountParams

  Returns Promise<number>

  Description

  Gets the number of my GroupChannels.

getMyGroupChannelChangeLogsByTimestamp

• getMyGroupChannelChangeLogsByTimestamp(ts, params?): Promise<GroupChannelChangelogs>

• Parameters

  • ts: number

  • params: GroupChannelChangeLogsParams = {}

  Returns Promise<GroupChannelChangelogs>

  Description

  Requests the channel changelogs after given timestamp.

getMyGroupChannelChangeLogsByToken

• getMyGroupChannelChangeLogsByToken(token, params?): Promise<GroupChannelChangelogs>

• Parameters

  • token: string

  • params: GroupChannelChangeLogsParams = {}

  Returns Promise<GroupChannelChangelogs>

  Description

  Requests the channel changelogs after given token.

getSubscribedCustomTypeTotalUnreadMessageCount

• getSubscribedCustomTypeTotalUnreadMessageCount(): number

• Returns number

  Description

  Gets the total number of unread message of GroupChannels with subscribed custom types.

getSubscribedCustomTypeUnreadMessageCount

• getSubscribedCustomTypeUnreadMessageCount(customType): number

• Parameters

  • customType: string

  Returns number

  Description

  Gets the number of unread message of GroupChannel with subscribed custom type.

getSubscribedTotalUnreadMessageCount

• getSubscribedTotalUnreadMessageCount(): number

• Returns number

  Description

  Gets the subscribed total number of unread message of all GroupChannels the current user has joined.

getTotalScheduledMessageCount

• getTotalScheduledMessageCount(params?): Promise<number>

• Parameters

  • params: TotalScheduledMessageCountParams = {}

  Returns Promise<number>

  Description

  Gets the number of total scheduled messages.

getTotalUnreadChannelCount

• getTotalUnreadChannelCount(): Promise<number>

• Returns Promise<number>

  Description

  Gets the total number of unread GroupChannels the current user has joined.

getTotalUnreadMessageCount

• getTotalUnreadMessageCount(params?): Promise<number>

• Parameters

  • params: TotalUnreadMessageCountParams = {}

  Returns Promise<number>

  Description

  Gets the total number of unread message of GroupChannels with GroupChannelTotalUnreadMessageCountParams filter.

getUnreadItemCount

• getUnreadItemCount(params?): Promise<UnreadItemCount>

• Parameters

  • params: UnreadItemCountParams = {}

  Returns Promise<UnreadItemCount>

  Description

  Gets the unread item count of GroupChannels from keys.

markAsDelivered

• markAsDelivered(channelUrl): Promise<void>

• Parameters

  • channelUrl: string

  Returns Promise<void>

  Description

  Sends mark as delivered to this channel when you received push message from us.

markAsReadAll

• markAsReadAll(): Promise<void>

• Returns Promise<void>

  Description

  Sends mark as read to all joined GroupChannels. This method has rate limit. You can send one request per second.

markAsReadWithChannelUrls

• markAsReadWithChannelUrls(channelUrls): Promise<void>

• Parameters

  • channelUrls: string[]

  Returns Promise<void>

  Description

  Sends mark as read to joined GroupChannels. This method has rate limit. You can send one request per second.

removeAllGroupChannelHandlers

• removeAllGroupChannelHandlers(): void

• Returns void

  Description

  Removes all GroupChannelHandlers.

removeGroupChannelHandler

• removeGroupChannelHandler(key): void

• Parameters

  • key: string

  Returns void

  Description

  Removes a GroupChannelHandler for a key.