DataChannelReceiver interface

Package:

@azure/communication-calling

DataChannel receiver

Properties

channelId
senderParticipantIdentifier

Methods

off("close", DataChannelReceiverCloseEvent)
off("messageReady", DataChannelReceiverMessageReadyEvent)
on("close", DataChannelReceiverCloseEvent)
on("messageReady", DataChannelReceiverMessageReadyEvent)
readMessage()

Property Details

channelId

channelId: number

Property Value

number

senderParticipantIdentifier

senderParticipantIdentifier: CommunicationIdentifierKind

Property Value

CommunicationIdentifierKind

Method Details

off("close", DataChannelReceiverCloseEvent)

function off(event: "close", listener: DataChannelReceiverCloseEvent)

Parameters

event

"close"

listener

DataChannelReceiverCloseEvent

off("messageReady", DataChannelReceiverMessageReadyEvent)

function off(event: "messageReady", listener: DataChannelReceiverMessageReadyEvent)

Parameters

event

"messageReady"

listener

DataChannelReceiverMessageReadyEvent

on("close", DataChannelReceiverCloseEvent)

function on(event: "close", listener: DataChannelReceiverCloseEvent)

Parameters

event

"close"

listener

DataChannelReceiverCloseEvent

on("messageReady", DataChannelReceiverMessageReadyEvent)

function on(event: "messageReady", listener: DataChannelReceiverMessageReadyEvent)

Parameters

event

"messageReady"

listener

DataChannelReceiverMessageReadyEvent

readMessage()

function readMessage(): undefined | DataChannelMessage

Returns

undefined | DataChannelMessage