Constructor for Arvia Chat.

var arviaChat = new ArviaChat('5b4f145ac4dbc95dcf926a52');

Set user id.

arviaChat.setUserId('12345');

Get user id of this user.

arviaChat.getUserId();
// returns '12345'

Set test user.

arviaChat.setTestUser(true);
// Test users will connect to a test room automatically

Get test status of this user.

arviaChat.getTestUser();
// returns true

Set room name.

// Top-level room
arviaChat.setRoomName('my-room');

// Dynamic room ([projectId]/[roomName])
arviaChat.setRoomName('5b4f145ac4dbc95dcf926a52/my-room');
// You can also set the dynamic room name using setDynamicRoomName method. setDynamicRoomName method only expects the room name as the parameter. Project id is added automatically as a prefix.

Get room name.

arviaChat.getRoomName();
// returns 'my-room' if the room is a top-level room

// if current room is a dynamic room, this method returns [projectId]/[roomName] (E.g: '5b4f145ac4dbc95dcf926a52/my-room')

Set dynamic room name.

arviaChat.setDynamicRoomName('my-room');

// Actual room name will be [projectId]/[roomName] (E.g: '5b4f145ac4dbc95dcf926a52/my-room')

Get room name.

arviaChat.getDynamicRoomName();
// returns 'my-room'

// If current room is not a dynamic room, this method returns empty string.

Get user name.

arviaChat.getUserName();
// returns 'John Smith'

Set user email.

arviaChat.setUserEmail('name@example.com');

Get user email.

arviaChat.getUserEmail();
// returns 'ame@example.com'

Set user telephone number.

arviaChat.setUserTel('+1 (123) 456 78 90');

Get user telephone number.

arviaChat.getUserTel();
// returns '+1 (123) 456 78 90'

Set user info.

arviaChat.setUserDetails('Calling from San Jose. Interested in annual contracts. Requests more info about pricing.');

Get user info.

arviaChat.getUserDetails();
// returns 'Calling from San Jose. Interested in annual contracts. Requests more info about pricing'

Set user tags.

arviaChat.setUserTags(['Speaks-English', 'From-USA', '25-year-old']);

Get user tags.

arviaChat.getUserTags();
// returns ['Speaks-English', 'From-USA', '25-year-old']

Set authentication object.

arviaChat.setAuthentication({token: awqwr7632s76xfew68rhb68hwf8et});

Get authentication object.

arviaChat.getAuthentication();
// returns {token: awqwr7632s76xfew68rhb68hwf8et}

Get the number of users in the room.

arviaChat.getUserCount();
// returns 2

Set visibility of the user names on videos.

arviaChat.setVideoUserNamesVisibility(true);

Get visibility status of the user names on videos.

arviaChat.getVideoUserNamesVisibility();
// returns true

Set local media buttons visibility status.

arviaChat.setLocalMediaButtonsVisibility(true);

Get local media buttons visibility status.

arviaChat.getLocalMediaButtonsVisibility();
// returns true

Set visibility status of remote users' media options buttons.

arviaChat.setRemoteMediaButtonsVisibility(true);

Get visibility status of remote users' media options buttons.

arviaChat.getRemoteMediaButtonsVisibility();
// returns true

Set visibility status of message box.

arviaChat.setMessageBoxVisibility(true);

Get visibility status of message box.

arviaChat.getMessageBoxVisibility();
// returns true

Set visibility status of media message button.

arviaChat.setMediaMessageButtonVisibility(true);

Get visibility status of media message button.

arviaChat.getMediaMessageButtonVisibility();
// returns true

Set visibility status of end call button.

arviaChat.setEndCallButtonButtonVisibility(true);

Get visibility status of end call button.

arviaChat.getEndCallButtonVisibility();
// returns true

Enable or disable default notifications which are sent by the SDK.

arviaChat.setDefaultNotificationsEnabled(true);

Get if the default notifications are enabled or not.

arviaChat.getDefaultNotificationsEnabled();
// returns true

Get device info. Audio/video input and output sources.

arviaChat.getDeviceInfo();
// ArviaChatEvent.DEVICE_INFO event is dispatched when device info is generated.
arviaChat.on(ArviaChatEvent.DEVICE_INFO, 
  function (e) {
    console.log(e);
  }
);

Create the chat interface in the target div element.

arviaChat.init('arviaChatDiv');

Connect and join the room.

arviaChat.connect();

Switch the audio output to next available speaker/earphone.

arviaChat.switchAudioOutput();

Switch the audio input to next available microphone.

arviaChat.switchMicrophone();

Get the outgoing audio stream source device id .

Switch the video input to next available camera.

arviaChat.switchCamera();

Get the outgoing video stream source device id .

arviaChat.getCamera();

Toggles sharing screen start/stop.

arviaChat.toggleScreenSharing();

Disconnect and terminate the chat interface.

arviaChat.close();

Set user name.

arviaChat.setUserName('John Smith');

Set the outgoing audio stream source device.

arviaChat.setMicrophone(true);

Set the outgoing video stream source device.

arviaChat.setCamera(true);

Start or stop sharing screen.

arviaChat.shareScreen(true);

Stops broadcasting audio and video.

arviaChat.stopAudioVideo();

Disconnect and exit the room.

arviaChat.disconnect();

Turn on microphone and broadcast your audio.

arviaChat.turnOnMicrophone();

Turn off microphone and mute your audio.

arviaChat.turnOffMicrophone();

Turn on camera and broadcast your video.

arviaChat.turnOnCamera();

Turn off camera and put outgoing video on hold.

arviaChat.turnOffCamera();

Call this method to update chat if the size of the target div element is changed.

arviaChat.resize();

Show a notification using the Arvia Chat's built in notifications.

arviaChat.showNotification('Please wait while connecting...');

Dispatched when the room you are trying to join is full.

arviaChat.on(ArviaChatEvent.ROOM_FULL, 
 function (e) {
   arviaChat.showNotification('This room is full');
   console.log(e);
 }
);

Dispatched when trying to connect.

arviaChat.on(ArviaChatEvent.CONNECTING, 
 function (e) {
   arviaChat.showNotification('Please wait while connecting...');
 }
);

Dispatched when connect failed.

arviaChat.on(ArviaChatEvent.CONNECT_ERROR, 
 function (e) {
   arviaChat.showNotification('Connect error!');
   console.log(e);
 }
);

Dispatched when disconnected.

arviaChat.on(ArviaChatEvent.DISCONNECT, 
 function (e) {
   arviaChat.showNotification('Disconnected from server!');
 }
);

Dispatched when the room is locked, someone wants to join the room and you are the room agent.

arviaChat.on(ArviaChatEvent.JOIN_REQUEST, 
 function (e) {
   arviaChat.showNotification('Someone wants to join the room');
   console.log(e);
 }
);

Dispatched when you can not enter the room.

arviaChat.on(ArviaChatEvent.JOIN_ROOM_ERROR, 
 function (e) {
   arviaChat.showNotification('Can not join the room');
   console.log(e);
 }
);

Dispatched when a user joins room.

arviaChat.on(ArviaChatEvent.USER_JOIN, 
 function (e) {
   arviaChat.showNotification('Someone joined the room');
   console.log(e);
 }
);

Dispatched when the user joins or leaves the room.

arviaChat.on(ArviaChatEvent.USER_LIST, 
 function (e) {
   arviaChat.showNotification('User list updated');
   console.log(e);
 }
);

Dispatched when the room you are trying to join is locked and waiting for the agent to let you in.

arviaChat.on(ArviaChatEvent.WAITING_FOR_PERMISSION, 
 function (e) {
   arviaChat.showNotification('Waiting for permission from the room agent');
   console.log(e);
 }
);

Dispatched when connected.

arviaChat.on(ArviaChatEvent.CONNECT, 
 function (e) {
   arviaChat.showNotification('Connected to room');
 }
);

Dispatched after the getDeviceInfo is called and when the device info is generated.

arviaChat.getDeviceInfo();
// ArviaChatEvent.DEVICE_INFO event is dispatched when device info is generated.
arviaChat.on(ArviaChatEvent.DEVICE_INFO, 
  function (e) {
    console.log(e);
  }
);

Dispatched after the getDeviceInfo is called and when the device info can not be generated.

arviaChat.getDeviceInfo();
// ArviaChatEvent.DEVICE_INFO_ERROR event is dispatched when device info can not be generated.
arviaChat.on(ArviaChatEvent.DEVICE_INFO_ERROR, 
  function (e) {
    console.log('Can not get device info!');
  }
);

Dispatched when the camera access granted.

arviaChat.on(ArviaChatEvent.LOCAL_STREAM, 
 function (e) {
   arviaChat.showNotification('Got video stream from the camera.');
   console.log(e);
 }
);

Dispatched if the camera can not be accessed.

arviaChat.on(ArviaChatEvent.LOCAL_STREAM_ERROR, 
 function (e) {
   arviaChat.showNotification('Can not access camera.');
   console.log(e);
 }
);

Dispatched when the screen access granted.

arviaChat.on(ArviaChatEvent.SCREEN_SHARE, 
 function (e) {
   arviaChat.showNotification('Got screen display to share.');
   console.log(e);
 }
);

Dispatched if the screen can not be shared.

arviaChat.on(ArviaChatEvent.SCREEN_SHARE_ERROR, 
 function (e) {
   arviaChat.showNotification('Can not get screen display.');
   console.log(e);
 }
);

Dispatched when a message is received.

arviaChat.on(ArviaChatEvent.MESSAGE, 
 function (e) {
   arviaChat.showNotification('Message received.');
   console.log(e.detail.userName);
   console.log(e.detail.userId);
   console.log(e.detail.message);
   console.log(e.detail.date);
 }
);

Dispatched if the authentication fails.

arviaChat.on(ArviaChatEvent.AUTHENTICATION_ERROR, 
 function (e) {
   arviaChat.showNotification('Authentication failed.');
   console.log(e);
 }
);