@555platform/555-js-sdk v4.4.27

555-js-sdk

555 JavaScript SDK

555-js-sdk provides simple APIs to build chat based applications using 555 Platform.

Getting started

npm i @555platform/555-js-sdk

Usage - Examples

import SDK from '@555platform/555-js-sdk';

1. Make connection using 555token, ConnectOptions and MessageAdapter

   const sdk = SDK.Client.create(
   	    	userData.access_token,
   	    	{
   		  url: '',
   		  automaticReconnect: true
   	    	},
   	    	new SDK.QueuedMessageAdapter<SDK.MessagePayload>()
   	    );
   	
       
   sdk.chat.connect();

2. Get list of rooms current user is a member of.

   const iter: SDK.Paginator<
       SDK.RoomDescriptor,
       SDK.RoomIterator
     > = await sdk.chat.getUserRoomDescriptors(0, 0);

3. Callbacks and Events from SDK.

   SDK.Client.Chat.on(
   	SDK.CMF.ChatServerEventTypes.RoomAdded,
   	this.onRoomsChanged
    );
   
   SDK.Client.Chat.on(
     SDK.CMF.ChatServerEventTypes.UserJoinedRoom,
     this.onRoomsChanged
   );
   
   SDK.Client.Chat.on(
     SDK.CMF.ChatServerEventTypes.UserLeftRoom,
     this.onRoomsChanged
   );
   
   SDK.Client.Chat.on(
     SDK.CMF.ChatServerEventTypes.RoomReceivedMessage,
     this.onRoomReceivedMessage
   );
   
   sdk.onTokenAboutToExpire(() =>
    // renewToken is a function you need to implement to fetch new token
    // from application server
    renewToken(renewedToken => sdk.updateToken(renewedToken));
   );

APIs

Connect

Methods

<static> create(accessToken, ConnectOptions, messageAdapter)

Factory method to create and initialize Client

Parameters

Returns

Type

Client|Error

updateToken(accessToken)

Updates current token. Used to update Client with refreshed token.

Parameters

Returns

Type

void

connect()

Connect to platform.

Parameters

Returns

Type

Promise.<Client|void>

disconnect()

Manually disconnect the client.

Returns

Type

Promise.<void|Error>

on(event, callback)

Register handler for event.

Parameters

AccessTokenAboutToExpire

Triggered 5 minutes before access token is to expire.

client.onTokenAboutToExpire(() =>
  // renewToken is a function you need to implement to fetch new token
  // from application server
  renewToken(renewedToken => sdk.updateToken(renewedToken));
);

Options

ConnectOptions

These options are parameters for connecting to platform.

Type

Object

Properties

Chat

Methods

createRoom(options)

Create room on the server with current user as the member.

Parameters

Returns

Type

Promise.<Room>

getRoomById(roomId)

Get room by its ID.

Parameters

Returns

Type

Promise.<Room>

getPublicRoomDescriptors()

Get list of public rooms.

Returns

Type

Promis.<Paginator.<RoomDescriptor>>

getUserRoomDescriptors()

Get list of rooms current user is a member of.

Returns

Type

Promise.<Paginator.<RoomDescriptor>>

getUser(userId)

Return User object for the user ID.

Parameters

Returns

Type

Promise.<User>

getCurrentUser()

Return User object for currently logged in user.

Returns

Type

Promise.<User>

disconnect()

Gracefully disconnect SDK from the platform

Returns

Type

Promise.<void>

updateLastConsumedMessageIndex(index)

Set last consumed message index to new index.

Parameters

Returns

Type

Promise.<number|Error>

Events

roomReceivedMessage

Type

Object

Properties

UserJoinedRoom

Triggered when user joins the room.

Type

User

UserLeftRoom

Triggered when user leaves the room.

Type

User

MessageUpdated

Triggered when message was updated.

Type

Object

Properties

UserIsTyping

Triggered when a user in the room started typing.

Type

User

Options

CreateRoomOptions

These options are parameters for creating a room.

Type

Object

Properties

Room

Properties

Methods

inviteUsers(userId)

Invite a user to the room.

Parameters

Returns

Type

Promise.<Room|Error>

leaveRoom(options)

Leave the Room.

Returns

Type

Promise.<Room|Error>

options

Properties

removeUser(roomId, userId)

Remove user from the Room.

Returns

Type

Promise.<Room|Error>

archiveRoom()

Archives the Room.

Returns

Type

Promise.<Room|Error>

deleteRoom()

Deletes the Room.

Returns

Type

Promise.<Room|Error>

updateRoom(room)

Update the Room.

Returns

Type

Promise.<Void|Error>

updateMessage(messageId, messageUpdate)

update message.

Returns

Type

Promise.<Void|Error>

deleteMessage(options)

delete message.

Returns

Type

Promise.<Message|Error>

options

Properties

removeUser(userId)

Remove user from this Room.

Parameters

Returns

Type

Promise.<void|Error>

Events

UserJoinedRoom

Triggered when user joins the room.

Type

User

UserLeftRoom

Triggered when user leaves the room.

Type

User

MessageUpdated

Triggered when message was updated.

Type

Object

Properties

UserIsTyping

Triggered when a user in the room started typing.

Type

User

RTC JS SDK

Import JS SDK as below:

import { JSSDK } from '@555platform/555-js-sdk';

And declare global variables inside .ts wrapper to access Rtc components via window object.

declare var window: any;

or

declare var IrisRtcSession: any;

JS SDK Documenation is available here