Class GroupChannelModule

Hierarchy

default
- GroupChannelModule

Methods

addGroupChannelHandler

addGroupChannelHandler(key: string, handler: GroupChannelHandler): void

Parameters
- key: string
- handler: GroupChannelHandler
Returns void

buildGroupChannelFromSerializedData

buildGroupChannelFromSerializedData(serialized: object): GroupChannel

Parameters
- serialized: object
Returns GroupChannel

buildGroupChannelListQueryFromSerializedData

buildGroupChannelListQueryFromSerializedData(serialized: object): GroupChannelListQuery

Parameters
- serialized: object
Returns GroupChannelListQuery

buildMemberFromSerializedData

buildMemberFromSerializedData(serialized: object): Member

Parameters
- serialized: object
Returns Member

createChannel

createChannel(params?: GroupChannelCreateParams): Promise<GroupChannel>

Parameters
- params: GroupChannelCreateParams = {}
Returns Promise<GroupChannel>

createChannelWithUserIds

createChannelWithUserIds(userIds: string[], isDistinct?: boolean, name?: string, coverUrlOrImageFile?: string | FileCompat, data?: string, customType?: string): Promise<GroupChannel>

Parameters
- userIds: string[]
- isDistinct: boolean = false
- name: string = null
- coverUrlOrImageFile: string | FileCompat = null
- data: string = ''
- customType: string = ''
Returns Promise<GroupChannel>

createDistinctChannelIfNotExist

createDistinctChannelIfNotExist(params?: GroupChannelCreateParams): Promise<GroupChannel>

Parameters
- params: GroupChannelCreateParams = {}
Returns Promise<GroupChannel>

createGroupChannelCollection

createGroupChannelCollection(params?: GroupChannelCollectionParams): GroupChannelCollection

Parameters
- params: GroupChannelCollectionParams = {}
Returns GroupChannelCollection

createMyGroupChannelListQuery

createMyGroupChannelListQuery(params?: GroupChannelListQueryParams): GroupChannelListQuery

Parameters
- params: GroupChannelListQueryParams = {}
Returns GroupChannelListQuery

createPublicGroupChannelListQuery

createPublicGroupChannelListQuery(params?: PublicGroupChannelListQueryParams): PublicGroupChannelListQuery

Parameters
- params: PublicGroupChannelListQueryParams = {}
Returns PublicGroupChannelListQuery

createScheduledMessageListQuery

createScheduledMessageListQuery(params?: ScheduledMessageListQueryParams): ScheduledMessageListQuery

Parameters
- params: ScheduledMessageListQueryParams = {}
Returns ScheduledMessageListQuery

getChannel

getChannel(channelUrl: string): Promise<GroupChannel>

Parameters
- channelUrl: string
Returns Promise<GroupChannel>

getChannelWithoutCache

getChannelWithoutCache(channelUrl: string): Promise<GroupChannel>

Parameters
- channelUrl: string
Returns Promise<GroupChannel>

getGroupChannelCount

getGroupChannelCount(params: GroupChannelCountParams): Promise<number>

Parameters
- params: GroupChannelCountParams
Returns Promise<number>

getMyGroupChannelChangeLogsByTimestamp

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

Parameters
- ts: number
- params: GroupChannelChangeLogsParams = {}
Returns Promise<GroupChannelChangelogs>

getMyGroupChannelChangeLogsByToken

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

Parameters
- token: string
- params: GroupChannelChangeLogsParams = {}
Returns Promise<GroupChannelChangelogs>

getSubscribedCustomTypeTotalUnreadMessageCount

getSubscribedCustomTypeTotalUnreadMessageCount(): number

Returns number

getSubscribedCustomTypeUnreadMessageCount

getSubscribedCustomTypeUnreadMessageCount(customType: string): number

Parameters
- customType: string
Returns number

getSubscribedTotalUnreadMessageCount

getSubscribedTotalUnreadMessageCount(): number

Returns number

getTotalScheduledMessageCount

getTotalScheduledMessageCount(params?: TotalScheduledMessageCountParams): Promise<number>

Parameters
- params: TotalScheduledMessageCountParams = {}
Returns Promise<number>

getTotalUnreadChannelCount

getTotalUnreadChannelCount(): Promise<number>

Returns Promise<number>

getTotalUnreadMessageCount

getTotalUnreadMessageCount(params?: TotalUnreadMessageCountParams): Promise<number>

Parameters
- params: TotalUnreadMessageCountParams = {}
Returns Promise<number>

getUnreadItemCount

getUnreadItemCount(params?: UnreadItemCountParams): Promise<UnreadItemCount>

Parameters
- params: UnreadItemCountParams = {}
Returns Promise<UnreadItemCount>

markAsDelivered

markAsDelivered(channelUrl: string): Promise<void>

Parameters
- channelUrl: string
Returns Promise<void>

markAsReadAll

markAsReadAll(): Promise<void>

Returns Promise<void>

markAsReadWithChannelUrls

markAsReadWithChannelUrls(channelUrls: string[]): Promise<void>

Parameters
- channelUrls: string[]
Returns Promise<void>

removeAllGroupChannelHandlers

removeAllGroupChannelHandlers(): void

Returns void

removeGroupChannelHandler

removeGroupChannelHandler(key: string): void

Parameters
- key: string
Returns void

Constructors

constructor

new GroupChannelModule(): GroupChannelModule

Inherited from Module.constructor
Returns GroupChannelModule

Properties

Readonly moduleSpecifier

moduleSpecifier: "__module__"

name

name: "groupChannel" = 'groupChannel'

Generated using TypeDoc