Class GroupChannelModule

name

addGroupChannelHandler

• addGroupChannelHandler(key, handler): void

• Parameters

  • key: string

  • handler: GroupChannelHandler

  Returns void

buildGroupChannelFromSerializedData

• buildGroupChannelFromSerializedData(serialized): GroupChannel

• Parameters

  • serialized: object

  Returns GroupChannel

buildGroupChannelListQueryFromSerializedData

• buildGroupChannelListQueryFromSerializedData(serialized): GroupChannelListQuery

• Parameters

  • serialized: object

  Returns GroupChannelListQuery

buildMemberFromSerializedData

• buildMemberFromSerializedData(serialized): Member

• Parameters

  • serialized: object

  Returns Member

createChannel

• createChannel(params?): Promise<GroupChannel>

• Parameters

  • params: GroupChannelCreateParams = {}

  Returns Promise<GroupChannel>

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>

createDistinctChannelIfNotExist

• createDistinctChannelIfNotExist(params?): Promise<GroupChannel>

• Parameters

  • params: GroupChannelCreateParams = {}

  Returns Promise<GroupChannel>

createGroupChannelCollection

• createGroupChannelCollection(params?): GroupChannelCollection

• Parameters

  • params: GroupChannelCollectionParams = {}

  Returns GroupChannelCollection

createMyGroupChannelListQuery

• createMyGroupChannelListQuery(params?): GroupChannelListQuery

• Parameters

  • params: GroupChannelListQueryParams = {}

  Returns GroupChannelListQuery

createPublicGroupChannelListQuery

• createPublicGroupChannelListQuery(params?): PublicGroupChannelListQuery

• Parameters

  • params: PublicGroupChannelListQueryParams = {}

  Returns PublicGroupChannelListQuery

createScheduledMessageListQuery

• createScheduledMessageListQuery(params?): ScheduledMessageListQuery

• Parameters

  • params: ScheduledMessageListQueryParams = {}

  Returns ScheduledMessageListQuery

getChannel

• getChannel(channelUrl): Promise<GroupChannel>

• Parameters

  • channelUrl: string

  Returns Promise<GroupChannel>

getChannelWithoutCache

• getChannelWithoutCache(channelUrl): Promise<GroupChannel>

• Parameters

  • channelUrl: string

  Returns Promise<GroupChannel>

getGroupChannelCount

• getGroupChannelCount(params): Promise<number>

• Parameters

  • params: GroupChannelCountParams

  Returns Promise<number>

getMyGroupChannelChangeLogsByTimestamp

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

• Parameters

  • ts: number

  • params: GroupChannelChangeLogsParams = {}

  Returns Promise<GroupChannelChangelogs>

getMyGroupChannelChangeLogsByToken

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

• Parameters

  • token: string

  • params: GroupChannelChangeLogsParams = {}

  Returns Promise<GroupChannelChangelogs>

getSubscribedCustomTypeTotalUnreadMessageCount

• getSubscribedCustomTypeTotalUnreadMessageCount(): number

• Returns number

getSubscribedCustomTypeUnreadMessageCount

• getSubscribedCustomTypeUnreadMessageCount(customType): number

• Parameters

  • customType: string

  Returns number

getSubscribedTotalUnreadMessageCount

• getSubscribedTotalUnreadMessageCount(): number

• Returns number

getTotalScheduledMessageCount

• getTotalScheduledMessageCount(params?): Promise<number>

• Parameters

  • params: TotalScheduledMessageCountParams = {}

  Returns Promise<number>

getTotalUnreadChannelCount

• getTotalUnreadChannelCount(): Promise<number>

• Returns Promise<number>

getTotalUnreadMessageCount

• getTotalUnreadMessageCount(params?): Promise<number>

• Parameters

  • params: TotalUnreadMessageCountParams = {}

  Returns Promise<number>

getUnreadItemCount

• getUnreadItemCount(params?): Promise<UnreadItemCount>

• Parameters

  • params: UnreadItemCountParams = {}

  Returns Promise<UnreadItemCount>

markAsDelivered

• markAsDelivered(channelUrl): Promise<void>

• Parameters

  • channelUrl: string

  Returns Promise<void>

markAsReadAll

• markAsReadAll(): Promise<void>

• Returns Promise<void>

markAsReadWithChannelUrls

• markAsReadWithChannelUrls(channelUrls): Promise<void>

• Parameters

  • channelUrls: string[]

  Returns Promise<void>

removeAllGroupChannelHandlers

• removeAllGroupChannelHandlers(): void

• Returns void

removeGroupChannelHandler

• removeGroupChannelHandler(key): void

• Parameters

  • key: string

  Returns void