Kandy Javascript SDK

Configuration options for the Logs feature.

Configuration options for the notification feature.

Configuration options for the Authentication feature.

Configuration options for the call feature.

Configuration options for the Connectivity feature.

Add an event listener for the specified event type.

• Error: Invalid event type

Removes an event listener for the specified event type.

• Error: Invalid event type

Adds a global event listener

• Error: Listener not a function

Removes a global event listener

• Error: Listener not a function

Connect to Kandy with user credentials.

kandy.connect({
username: 'alfred@example.kandy.io',
password: '********'
});

Disconnects from the backend. This will close the websocket and you will stop receiving events.

Updates the current connection.

kandy.updateConnection({
services: ['IM', 'Presence', 'call']
})

Returns the current logged in user and the current auth token.

Get the connection state.

Retrieves the services that the user is subscribed for.

Possible subscription states of the user.

Authentication state has changed. You can get the new state by calling kandy.getConnection().

There was an error with authentication.

Retrieves the state of calls made during the current session.

let calls = kandy.call.getAll();
let currentCalls = calls.filter(call => {
return call.state === kandy.call.states.IN_CALL;
});

Retrieves a call from state with a specific call ID.

States of a call.

kandy.on('call:stateChange', function(callInfo) {
 if(callInfo.state === kandy.call.states.ENDED) {
     // Call has ended.
 }
});

State of the media connection within a call.

Start an outgoing call.

let remoteContainer = document.getElementById('remote-container');
// Start a video call that only shows the remote media (not local).
let callId = kandy.call.make('sampleUser@kandy.io', {
isVideoEnabled: true,
sendInitialVideo: true,
remoteVideoContainer: remoteContainer
});

Answer an incoming call.

Ignore an incoming call.

Reject an incoming call.

End an on-going call.

Mute the local audio stream on an ongoing call.

Unmute the local audio stream on an ongoing call.

Start local video stream for an ongoing call.

Stop local video for an ongoing call.

Put an ongoing call on hold.

Return a held call to ongoing.

Starts sharing a screen over a call.

Stops sharing a screen over a call.

Send a DTMF tone over a call.

Forward an incoming call to another user.

Transfer a call to another user.

Transfer a call to another user.

Join two calls (both must be on hold and audio only). The joined call can be referenced via callId.

An outgoing call has successfully started.

A new incoming call has been received.

kandy.on('call:receive', function(callId) {
// We have received a call, prompt the user to respond.
promptUser(kandy.call.getById(callId));
});

Calls have been successfully joined.

A call has successfully been forwarded.

A call's state has changed.

kandy.on('call:stateChange', function(params) {
// We are now in call with another user, so update our app to show it.
if(params.state === kandy.call.states.IN_CALL) {
    renderCall(kandy.call.getById(params.callId));
}
});

A call's media state has changed.

Screensharing has been started turned on or off.

An error has occurred with a call.

Sets the selected devices as the default devices. They will be used for audio output for future calls. Changing speaker is supported on browser's that support HTMLMediaElement.setSinkId().

// Set only the default microphone and camera.
kandy.media.setDefaultDevices({
camera: 'abc123...',
microphone: 'def456...'
});

Retrieves the available media devices for use.

Starts the local video stream and displays it to the user.

``` javascript
var container = document.getElementById('local-video');
kandy.media.startPreviewVideo(container);
```

Stops the local video stream created in startPreviewVideo.

The status of previewing local video has changed.

An error has occurred when changing local video preview status.

A change has been made to default devices used for calls.

Media support has been checked.

Fetches the list of call logs and stores them locally. The API getCallLogs can then be used to get the logs from local state after it has been updated.

Deletes the specified call log.

Deletes all call logs.

Gets the list of call logs cached locally. The event callHistory:changed is used to indicate the local state of logs has been updated.

kandy.on('callHistory:change', function() {
// Get all call logs when they've been updated.
let callLogs = kandy.call.history.get();
});

Call history state has been updated. See getCallLogs() to retrieve new state.

An error occured while performing a call history operation.

Create and return a conversation object. If successfull, the event 'conversations:change' will be emitted. If a conversation with the given user already exists in the store, then no new one will be created. If no conversation exists, then a new conversation will be created in the store.

A change has occured in the conversation list. If a single conversation was affected/created, conversationId will be present as part of the event argument.

A change has occured in a specific conversations message list. If a single message was affected/created, messageId will be present as part of the event argument.

An error occured with messaging.

Create and return a message object. You must provide a text part as demonstrated in the example.

conversation.createMessage({type: 'text', text: 'This is the message'});

Clears all messages in this conversation from local state.

Get the messages associated with this conversation.

Subscribe to this conversations messages array.

Allows the user to fetch messages associated with a specific conversation from the server. When the operation is complete, a NEW_MESSAGE event will be emitted. Messages can then be retrieved using getMessages.

Sends the message.

Update the presence for the current user

Get (from state) the presence for the given user(s)

Fetch (from the server) the presence for the given users. This will update the store with the retrieved values, which can then be accessed using getPresence.

Subscribe to the presence of the given user(s).

Unsubscribe from the presence of the given user(s).

Received a presence event.

An error occured with presence.

Attempts to retrieve voicemail information from the server. A voicemail:new event is emitted upon completion.

Returns voicemail data from the store.

A voicemail event has been received.

An error has occured while attempting to retrieve voicemail data.

Subscribe for a sip event.

Update a subscription for a sip event.

Unsubscribe from a sip event.

Retrieve information about a specified sip event.

A change in SIP event subscriptions has occurred.

An error occurred while performing a SIP event action.

A SIP event notification has been received.

Get the state of the websocket.

Enables or disables connectivity checking.

The websocket to the server has changed state.

Registers a device token for push notifications.

Deregisters for push notifications.

Enables, or disables, the processing of websocket notifications.

Push notifications registration state has changed.

An error occured with push notifications.

Get user details from the server.

Fetch the current user's profile data.

Get user from local state.

Get currently logged in user data from the local state.

Refreshes the contacts in the state. This will get new contacts from the server.

Add a contact to a user's personal address book.

Remove a contact from a personal address book.

Update a contact from the user's personal address book.

Search the users in the directory.

Possible levels for the SDK logger.