respoke.Endpoints are users of a Respoke app. An Endpoint can be a person in a browser or device, or an app using Respoke APIs from a server. A Client can interact with endpoints through messages, audio or video calls, or direct connections. An Endpoint may be authenticated from multiple devices to the same app (each of which is represented by a Connection).

var jim = client.getEndpoint({ id: 'jim' });

The number this endpoint's connections that are joined to groups. So if an endpoint has 3 connections in the same group, the groupConnectionCount for that endpoint would be 3.

A direct connection to this endpoint. This can be used to send direct messages.

Array of connections for this endpoint.

Represents the presence status. Typically a string, but other types are supported. Defaults to 'unavailable'.

Do not modify this directly - it won't update presence with Respoke. Presence must be updated by the remote endpoint.

Deprecated: use endpoint.presence instead.

Return the presence.

Send a message to the endpoint through the infrastructure.

endpoint.sendMessage({
    message: "wassuuuuup"
});

Using callbacks will disable promises.

Create a new audio-only call.

endpoint.startAudioCall({
    onConnect: function (evt) {}
});

Create a new call with audio and video.

endpoint.startVideoCall({
    onConnect: function (evt) {}
});

The endpoint who calls endpoint.startScreenShare will be the one whose screen is shared. If you'd like to implement this as a screenshare request in which the endpoint who starts the call is the watcher and not the sharer, it is recommended that you use endpoint.sendMessage to send a control message to the user whose screenshare is being requested so that user's app can call endpoint.startScreenShare.

By default, the call will be one-way screen share only, with the recipient sending nothing. To turn it into a bidirectional call with the recipient sending video and both parties sending audio, set params.sendOnly to false.

NOTE: At this time, screen sharing only works with Chrome and Firefox, and both require browser extensions to access screen sharing features. Please see instructions at https://github.com/respoke/respoke-chrome-extension and https://github.com/respoke/respoke-firefox-screen-sharing-extension.

endpoint.startScreenShare({
    onConnect: function (evt) {}
});

Create a new call.

endpoint.startCall({
    onConnect: function (evt) {}
});

Create a new DirectConnection. This method creates a new Call as well, attaching this DirectConnection to it for the purposes of creating a peer-to-peer link for sending data such as messages to the other endpoint. Information sent through a DirectConnection is not handled by the cloud infrastructure. If there is already a direct connection open, this method will resolve the promise with that direct connection instead of attempting to create a new one.

endpoint.startDirectConnection({
    onOpen: function (evt) {}
});

This event indicates that the presence for this endpoint has been updated.