Class PrivateChatService

events

chatHistoryByParticipant

• get chatHistoryByParticipant(): Map<string, ChatMessage[]>

• chatHistoryByParticipant, returns the map of participantGuids and corresponding private messages in a meeting. It also includes the participantGuids and the corresponding private messages of participants who've dropped off.

  Returns Map<string, ChatMessage[]>

eligibleParticipants

• get eligibleParticipants(): Participant[]

• eligibleParticipants, returns the array of participants, who can be sent private messages during a meeting session.

  Returns Participant[]

isPrivateChatConnected

• get isPrivateChatConnected(): boolean

• isPrivateChatConnected, returns a boolean value, whether private chat is connected in a meeting session.

  Returns boolean

isPrivateChatEnabled

• get isPrivateChatEnabled(): boolean

• isPrivateChatEnabled, returns a boolean value, whether private chat is enabled for a meeting.

  Returns boolean

unreadCountByParticipant

• get unreadCountByParticipant(): Map<string, number>

• unreadCountByParticipant, returns the map of participantGuids and their corresponding unread private message counts in a meeting.

  Returns Map<string, number>

unreadMessageCount

• get unreadMessageCount(): number

• unreadMessageCount, returns the total unread private message count in a meeting.

  Returns number

clearUnreadMessageCountForParticipant

• clearUnreadMessageCountForParticipant(participantGuid): void

• clearUnreadMessageCountForParticipant, takes a participantGuid and clears the unread private message count from the corresponding participantGuid.

  Parameters

  • participantGuid: string

  Returns void

observe

• observe(property, callback): void

• Allows observing changes to properties. Provide the property which you are interested in and a callback. Whenever the property value changes, you will be notified via the callback.

  Usage:

  Example

  sdk.meetingService.privateChatService.observe("unreadMessageCount", function() {
       console.info("unreadMessageCount changed to : ", sdk.meetingService.privateChatService.unreadMessageCount)
  });
  Copy

  Parameters

  • property: keyof PrivateChatService

    The name of the property to observe for changes.

  • callback: (() => void)

    on change event for the property.

    • • (): void

      • Returns void

  Returns void

sendMessage

• sendMessage(message, participantGuid): void

• sendMessage, takes a string message and a participantGuid and sends it in private chat to the corresponding participantGuid.

  Parameters

  • message: string

  • participantGuid: string

  Returns void