ClassFeedChannelModule

constructor

• new FeedChannelModule(): FeedChannelModule

• Returns FeedChannelModule

name

addFeedChannelHandler

• addFeedChannelHandler(key, handler): void

• Parameters

  • key: string
  • handler: FeedChannelHandler

  Returns void

  Description

  Adds a FeedChannelHandler with a key.

buildFeedChannelFromSerializedData

• buildFeedChannelFromSerializedData(serialized): FeedChannel

• Parameters

  • serialized: object

  Returns FeedChannel

  Description

  Builds GroupChannel instance from serialized data generated by serialize.

createMyFeedChannelListQuery

• createMyFeedChannelListQuery(params?): FeedChannelListQuery

• Parameters

  • params: FeedChannelListQueryParams = {}

  Returns FeedChannelListQuery

  Description

  Creates a FeedChannelListQuery.

getChannel

• getChannel(channelUrl): Promise<FeedChannel>

• Parameters

  • channelUrl: string

  Returns Promise<FeedChannel>

  Description

  Gets a FeedChannel with given channel URL.

getGlobalNotificationChannelSetting

• getGlobalNotificationChannelSetting(): Promise<GlobalNotificationChannelSetting>

• Returns Promise<GlobalNotificationChannelSetting>

  Description

  Gets GlobalNotificationChannelSetting.

getMyFeedChannelChangeLogsByTimestamp

• getMyFeedChannelChangeLogsByTimestamp(timestamp, params?): Promise<FeedChannelChangelogs>

• Parameters

  • timestamp: number
  • params: FeedChannelChangeLogsParams = {}

  Returns Promise<FeedChannelChangelogs>

  Description

  Gets FeedChannel changelogs since the timestamp.

getMyFeedChannelChangeLogsByToken

• getMyFeedChannelChangeLogsByToken(token, params?): Promise<FeedChannelChangelogs>

• Parameters

  • token: string
  • params: FeedChannelChangeLogsParams = {}

  Returns Promise<FeedChannelChangelogs>

  Description

  Gets FeedChannel changelogs by pagination token.

getNotificationTemplate

• getNotificationTemplate(key): Promise<NotificationTemplate>

• Parameters

  • key: string

  Returns Promise<NotificationTemplate>

  Description

  Gets NotificationTemplate for a key.

getNotificationTemplateListByToken

• getNotificationTemplateListByToken(token, params?): Promise<NotificationTemplateListResult>

• Parameters

  • token: string
  • params: NotificationTemplateListParams = {}

  Returns Promise<NotificationTemplateListResult>

  Description

  Gets NotificationTemplates by pagination token.

getTotalUnreadMessageCount

• getTotalUnreadMessageCount(params?): Promise<number>

• Parameters

  • params: TotalUnreadMessageCountParams = {}

  Returns Promise<number>

  Deprecated

  since version 4.13.0

getTotalUnreadNotificationCount

• getTotalUnreadNotificationCount(): Promise<number>

• Returns Promise<number>

  Promise

  Description

  Gets total unread notification message count.

refreshNotificationCollections

• refreshNotificationCollections(): void

• Returns void

  Description

  Refreshes all NotificationCollections.

removeAllFeedChannelHandlers

• removeAllFeedChannelHandlers(): void

• Returns void

  Description

  Removes all FeedChannelHandlers.

removeFeedChannelHandler

• removeFeedChannelHandler(key): void

• Parameters

  • key: string

  Returns void

  Description

  Removes a FeedChannelHandler for a key.