WebsocketEndpoint

extends Endpoint

• websocketEndpointConfigId: String
• constructor(identifier: string, websocketEndpointConfigId: string)
• identifier(): String
• displayIdentifier(): String

websocketEndpointConfigId : string

Readonly property representing the ID of your websocket endpoint configuration.

constructor(identifier, websocketEndpointConfigId)

Description

Creates a new instance of WebsocketEndpoint.

Arguments

• identifier: string - Identifier of the participant on this endpoint
• websocketEndpointConfigId: string - ID of your websocket endpoint configuration.

Example

let websocketEndpoint = new WebscoketEndpoint("identifier", "websocketEndpoitntConfigId");
console.log(`This endpoints identifier is: ${webrtcEndpoint.identifier} and the display identifier is: ${webrtcEndpoint.displayIdentifier}`);

identifier()

Description

Returns the value of the identifier on this endpoint represented by the participant's identifier.

Arguments

• none

Returns

• string - Identifier of the participant on this endpoint

Example

console.log(`Identifier of the participant on this endpoint: ${endpoint.identifier}`);

displayIdentifier()

Description

Returns the value of the display identifier on this endpoint represented by the participant's identifier.

Arguments

• none

Returns

• string - Display identifier of the participant on this endpoint

Example

console.log(`Display identifier of the participant on this endpoint: ${endpoint.displayIdentifier}`);