ChatAdapterSubscribers interface

  • Reference
Package:
@azure/communication-react

Chat composite events that can be subscribed to.

Methods

off("error", (e: AdapterError) => void)

Unsubscribe function for 'error' event.
off("messageRead", MessageReadListener)

Unsubscribe function for 'messageRead' event.
off("messageReceived", MessageReceivedListener)

Unsubscribe function for 'messageReceived' event.
off("messageSent", MessageReceivedListener)

Unsubscribe function for 'messageSent' event.
off("participantsAdded", ParticipantsAddedListener)

Unsubscribe function for 'participantsAdded' event.
off("participantsRemoved", ParticipantsRemovedListener)

Unsubscribe function for 'participantsRemoved' event.
off("topicChanged", TopicChangedListener)

Unsubscribe function for 'topicChanged' event.
on("error", (e: AdapterError) => void)

Subscribe function for 'error' event.
on("messageRead", MessageReadListener)

Subscribe function for 'messageRead' event.
on("messageReceived", MessageReceivedListener)

Subscribe function for 'messageReceived' event.
on("messageSent", MessageReceivedListener)

Subscribe function for 'messageSent' event.
on("participantsAdded", ParticipantsAddedListener)

Subscribe function for 'participantsAdded' event.
on("participantsRemoved", ParticipantsRemovedListener)

Subscribe function for 'participantsRemoved' event.
on("topicChanged", TopicChangedListener)

Subscribe function for 'topicChanged' event.

Method Details

off("error", (e: AdapterError) => void)

Unsubscribe function for 'error' event.

function off(event: "error", listener: (e: AdapterError) => void)

Parameters

event

"error"

listener

(e: AdapterError) => void

off("messageRead", MessageReadListener)

Unsubscribe function for 'messageRead' event.

function off(event: "messageRead", listener: MessageReadListener)

Parameters

event

"messageRead"

listener
MessageReadListener

off("messageReceived", MessageReceivedListener)

Unsubscribe function for 'messageReceived' event.

function off(event: "messageReceived", listener: MessageReceivedListener)

Parameters

event

"messageReceived"

listener
MessageReceivedListener

off("messageSent", MessageReceivedListener)

Unsubscribe function for 'messageSent' event.

function off(event: "messageSent", listener: MessageReceivedListener)

Parameters

event

"messageSent"

listener
MessageReceivedListener

off("participantsAdded", ParticipantsAddedListener)

Unsubscribe function for 'participantsAdded' event.

function off(event: "participantsAdded", listener: ParticipantsAddedListener)

Parameters

event

"participantsAdded"

listener
ParticipantsAddedListener

off("participantsRemoved", ParticipantsRemovedListener)

Unsubscribe function for 'participantsRemoved' event.

function off(event: "participantsRemoved", listener: ParticipantsRemovedListener)

Parameters

event

"participantsRemoved"

listener
ParticipantsRemovedListener

off("topicChanged", TopicChangedListener)

Unsubscribe function for 'topicChanged' event.

function off(event: "topicChanged", listener: TopicChangedListener)

Parameters

event

"topicChanged"

listener
TopicChangedListener

on("error", (e: AdapterError) => void)

Subscribe function for 'error' event.

function on(event: "error", listener: (e: AdapterError) => void)

Parameters

event

"error"

listener

(e: AdapterError) => void

on("messageRead", MessageReadListener)

Subscribe function for 'messageRead' event.

function on(event: "messageRead", listener: MessageReadListener)

Parameters

event

"messageRead"

listener
MessageReadListener

on("messageReceived", MessageReceivedListener)

Subscribe function for 'messageReceived' event.

function on(event: "messageReceived", listener: MessageReceivedListener)

Parameters

event

"messageReceived"

listener
MessageReceivedListener

on("messageSent", MessageReceivedListener)

Subscribe function for 'messageSent' event.

function on(event: "messageSent", listener: MessageReceivedListener)

Parameters

event

"messageSent"

listener
MessageReceivedListener

on("participantsAdded", ParticipantsAddedListener)

Subscribe function for 'participantsAdded' event.

function on(event: "participantsAdded", listener: ParticipantsAddedListener)

Parameters

event

"participantsAdded"

listener
ParticipantsAddedListener

on("participantsRemoved", ParticipantsRemovedListener)

Subscribe function for 'participantsRemoved' event.

function on(event: "participantsRemoved", listener: ParticipantsRemovedListener)

Parameters

event

"participantsRemoved"

listener
ParticipantsRemovedListener

on("topicChanged", TopicChangedListener)

Subscribe function for 'topicChanged' event.

function on(event: "topicChanged", listener: TopicChangedListener)

Parameters

event

"topicChanged"

listener
TopicChangedListener