API Docs for:
Show:

ConnectHTMLSDK Class

Defined in: Connect_CustomPod_SDK\src\ConnectCustomPodSDK.js:60

This class has all the methods, events and Properties which are exposed by the Connect HTML SDK

Methods

allowParticipantPublish

(
  • msgName
  • allowFlag
)
Void

Defined in Connect_CustomPod_SDK\src\ConnectCustomPodSDK.js:537

Available since 10.8

[Host Only] This method will allow/block the participants from sending a sync event

Parameters:

  • msgName String

    name of the message for which the permission will be set

  • allowFlag Boolean

    if true then participants will be allowed

Returns:

Void:

Example:

    customPodObject.allowParticipantPublish("name", true)

dispatchSyncMessage

(
  • msgName
  • msgValue
  • isDelta
  • echoBack
)

Defined in Connect_CustomPod_SDK\src\ConnectCustomPodSDK.js:593

Available since 10.0

Method to send a sync message to other participants

Parameters:

  • msgName String

    name of the message to be sent -- should be meaningful to the pod running on other participant's machines

  • msgValue Object

    the contents of the message to be sent, the format to be determined by your own custom pod

  • isDelta Boolean

    if true, then all of the events matching this message name will be sent to new particpants. If false, then only the last known event will be sent.

  • echoBack Boolean

    if true, then this instance of the custom pod will receive a corresponding sync message back, otherwise only the other participants will receive this message.

Example:

    customPodObject.dispatchSyncMessage("name", ["Himanshu"], true, true)

getBreakoutRoomDetails

(
  • breakoutId
)
Object

Defined in Connect_CustomPod_SDK\src\ConnectCustomPodSDK.js:374

Available since 11.0

[Host Only Function] This method will return an object with information about a breakout room

Parameters:

  • breakoutId Number

Returns:

Object:

Object that has two values breakoutRoom id and breakout room name, returns null if participant calls this function

Example:

     let borObj = customPodObject.getBreakoutRoomDetails(1)
     let name = borObj.name
     let id = borObj.id

getBreakoutRoomsList

() Array

Defined in Connect_CustomPod_SDK\src\ConnectCustomPodSDK.js:391

Available since 11.0

[Host Only Function] This method will return the list of breakout rooms

Returns:

Array:

array that contains the list of breakout rooms object that contains room id and name, returns null if participant calls this function

Example:

    let borList = customPodObject.getBreakoutRoomsList()
    let room1Name = borList[0].name
    let room1Id = borList[0].id

getConfig

() Object

Defined in Connect_CustomPod_SDK\src\ConnectCustomPodSDK.js:148

Available since 10.0

This method returns configuration of the meeting like accountId, isAddin, isWhiteBoardOn

Returns:

Object:

configuration

Example:

     let data = customPodObject.getConfig();
     data.accountId
     data.archiveDuration
     data.isAddin
     data.isArchive
     data.isBreakOutSession
     data.isCaughtUp
     data.isPointerOn
     data.isSecure
     data.isWhiteBoardOn
     data.language
     data.playState
     data.podTitle
     data.role
     data.roomSCOID
     data.url
     data.userID
     data.userName

getMeetingInfo

() Object

Defined in Connect_CustomPod_SDK\src\ConnectCustomPodSDK.js:260

Available since 10.0

This method will return a meeting info object

Returns:

Object:

object that has accountId, scoId, lang, url

Example:

     let data = customPodObject.getMeetingInfo()
     data.accountId
     data.lang
     data.url

getMyBreakoutRoomDetails

() Object

Defined in Connect_CustomPod_SDK\src\ConnectCustomPodSDK.js:408

Available since 11.0

This method will return the Object that contains the details of the bor in which calling user is currently in

Returns:

Object:

name, id

Example:

    let myBorObj = customPodObject.getMyBreakoutRoomDetails()
    let borId = myBorObj.id
    let borName = myBorObj.name

getMyUserDetails

() Object

Defined in Connect_CustomPod_SDK\src\ConnectCustomPodSDK.js:301

Available since 10.0

This method will return a user data object for the current user

Returns:

Object:

object that has two properties message and data

Example:

     let myUserData = customPodObject.getMyUserDetails()
     myUserData.message   // "Success" for live meeting and "Access Denied" for recording
     myUserData.data.name
     myUserData.data.fullName
     myUserData.data.role
     myUserData.data.id
     myUserData.data.status // this will be an array containing all the status set by this user

getPodInfo

() Object

Defined in Connect_CustomPod_SDK\src\ConnectCustomPodSDK.js:282

Available since 10.0

This method will return a pod info object

Returns:

Object:

object that has podTitle, isWhiteBoardOn

Example:

     let data = customPodObject.getPodInfo()
     data.isWhiteBoardOn
     data.podTitle

getUserDetails

(
  • userID
)
Object

Defined in Connect_CustomPod_SDK\src\ConnectCustomPodSDK.js:227

Available since 10.0

[Host Only Function]This method will return a user data object, assuming that the user is a host and that a valid UserID is provided

Parameters:

  • userID String

    ID of the user

Returns:

Object:

object with user details, return null if participant call this function

Example:

     let userData = customPodObject.getUserDetails(userId)
     userData.message    //"Success" for livemeeting and "Access Denied" for recording
     userData.data.breakoutId
     userData.data.breakoutRoomName
     userData.data.fullName
     userData.data.name
     userData.data.role

getUserList

() Object

Defined in Connect_CustomPod_SDK\src\ConnectCustomPodSDK.js:333

Available since 10.0

This method will the object that has userIds of all the users in the meeting

Returns:

Object:

object that has two properties message and data

Example:

     let userListData = customPodObject.getUserList()
     userListData.message  // "Success" for live meeting and "Access Denied" for recording
     userListData.data  //Array containing userIds of the user present in meeting

isBreakOutSessionOn

() Boolean

Defined in Connect_CustomPod_SDK\src\ConnectCustomPodSDK.js:359

Available since 10.0

This method will return a boolean that denote whether BreakoutRoom is started or not

Returns:

Boolean:

flag that denotes whether breakoutSession is started or not

Example:

    let flag = customPodObject.isBreakOutSessionOn()

isWhiteBoardOn

() Boolean

Defined in Connect_CustomPod_SDK\src\ConnectCustomPodSDK.js:427

Available since 10.0

This method will return a boolean that denote whether BreakoutRoom is started or not

Returns:

Boolean:

flag that denotes whether whiteboard is started or not

Example:

    let flag = customPodObject.isWhiteBoardOn

maximize

(
  • show
)
Void

Defined in Connect_CustomPod_SDK\src\ConnectCustomPodSDK.js:439

Available since 10.8

[Host Only] This method will switch Custom Pod b/w maximize and minimize state

Parameters:

  • show Boolean

Returns:

Void:

Example:

    customPodObject.maximize(true)  // this will maximize the pod but only if function called from host side
    customPodObject.maximize(false) // this will restore the pod but only if function called from host side

podVisible

(
  • showFlag
)
Void

Defined in Connect_CustomPod_SDK\src\ConnectCustomPodSDK.js:487

Available since 10.8

This method will show/hide the sharePod in which custom pod is loaded

Parameters:

  • showFlag Boolean

Returns:

Void:

Example:

     customPodObject.podVisible = true  // to show the pod
     customPodObject.podVisible = false  // to hide the pod

setMenuBarControlsVisibility

(
  • showFlag
)
Void

Defined in Connect_CustomPod_SDK\src\ConnectCustomPodSDK.js:455

Available since 10.8

This method will show/hide the app bar items

Parameters:

  • showFlag Boolean

Returns:

Void:

Example:

     customPodObject.setMenuBarControlsVisibility(true)  // to show the app bar items
     customPodObject.setMenuBarControlsVisibility(false)  // to hide the app bar items

setMyStatus

(
  • status
)
Void

Defined in Connect_CustomPod_SDK\src\ConnectCustomPodSDK.js:503

Available since 10.8

Allows user to set his own status.

Accepted Status Values are :

  • speechQuestion : Raise Hand
  • speechQuestionLower : Lower Raised Hand
  • speechAgree : Agree
  • speechDisagree : Disagree
  • speechAgreeClear : Clear Agree or Disagree
  • steppedAway : Step Away
  • stepIn : Step In
  • speechLouder : Speak Louder
  • speechQuieter : Speak Softer
  • speechFaster : Speed Up
  • speechSlower : Slow Down
  • speechLaughter : Laughter
  • speechApplause : Applause
  • clearStatus : Clear Status

Parameters:

  • status String

    statusValue

Returns:

Void:

Example:

        setMyStatus("speechQuestion")

setPodControlsVisibility

(
  • showFlag
)
Void

Defined in Connect_CustomPod_SDK\src\ConnectCustomPodSDK.js:471

Available since 10.8

This method will show/hide the pod menu Items

Parameters:

  • showFlag Boolean

Returns:

Void:

Example:

     customPodObject.setPodControlsVisibility(true)  // to show the pod options
     customPodObject.setPodControlsVisibility(false)  // to hide the pod options

Properties

AGREE

String

Defined in Connect_CustomPod_SDK\src\ConnectCustomPodSDK.js:1030

Available since 10.8

A String value that is used to set the "Agree" user status

AGREE_DISAGREE_CLEAR

String

Defined in Connect_CustomPod_SDK\src\ConnectCustomPodSDK.js:1042

Available since 10.8

A String value that is used to clear the Agree or disagree status

Example:

    sdkobject.setMyStatus(sdkObject.AGREE_DISAGREE_CLEAR)

APPLAUSE

String

Defined in Connect_CustomPod_SDK\src\ConnectCustomPodSDK.js:1056

Available since 10.8

A String value that is used to set the "Applause" status in connect

archiveDuration

Number

Defined in Connect_CustomPod_SDK\src\ConnectCustomPodSDK.js:954

Available since 10.5

This specifies the duration of the recording

BUILD_NO

String

Defined in Connect_CustomPod_SDK\src\ConnectCustomPodSDK.js:1211

Available since 10.8

This String defaults to "2.0"

CLEAR_STATUS

String

Defined in Connect_CustomPod_SDK\src\ConnectCustomPodSDK.js:1198

Available since 10.8

User status value used as an argument of setMyStatus function This String that is used to clear the status"

connectVersion

Number

Defined in Connect_CustomPod_SDK\src\ConnectCustomPodSDK.js:942

Available since 10.0

A boolean that tells which version of connect you are using

DATE

String

Defined in Connect_CustomPod_SDK\src\ConnectCustomPodSDK.js:1225

Available since 11.0

This String value that will give today's date

DISAGREE

String

Defined in Connect_CustomPod_SDK\src\ConnectCustomPodSDK.js:1068

Available since 10.8

User status value used as an argument of setMyStatus function A String value that is used to set the "Disagree" status

isSynced

Number

Defined in Connect_CustomPod_SDK\src\ConnectCustomPodSDK.js:930

Available since 10.0

A boolean that tells whether share pod is Synced or not

k_HOST

String

Defined in Connect_CustomPod_SDK\src\ConnectCustomPodSDK.js:978

Available since 10.8

A String value that denotes the host role in connect application

k_PARTICIPANT

String

Defined in Connect_CustomPod_SDK\src\ConnectCustomPodSDK.js:991

Available since 10.8

A String value that denotes the participant role in connect application

k_PRESENTER

String

Defined in Connect_CustomPod_SDK\src\ConnectCustomPodSDK.js:1004

Available since 10.8

A String value that denotes the presenter role in connect application

language

String

Defined in Connect_CustomPod_SDK\src\ConnectCustomPodSDK.js:1016

Available since 10.8

A String value that denotes the language set in connect application

LAUGHTER

String

Defined in Connect_CustomPod_SDK\src\ConnectCustomPodSDK.js:1081

Available since 10.8

User status value used as an argument of setMyStatus function A String value that is used to set the "Laughter" status

LOWER_HAND

String

Defined in Connect_CustomPod_SDK\src\ConnectCustomPodSDK.js:1094

Available since 10.8

User status value used as an argument of setMyStatus function A String value that is used to clear "Raise Hand" status

playState

String

Defined in Connect_CustomPod_SDK\src\ConnectCustomPodSDK.js:966

Available since 10.5

A String that specifies the playState of the recording

podHeight

Number

Defined in Connect_CustomPod_SDK\src\ConnectCustomPodSDK.js:870

Available since 10.8

A number that specifies the height of the pod containing the application.

podID

Number

Defined in Connect_CustomPod_SDK\src\ConnectCustomPodSDK.js:918

Available since 11.0

A number that specifies the podId in which custom pod is loaded.

podMinHeight

Number

Defined in Connect_CustomPod_SDK\src\ConnectCustomPodSDK.js:906

Available since 10.8

A number that specifies the minimum height of the pod containing the application.

podMinWidth

Number

Defined in Connect_CustomPod_SDK\src\ConnectCustomPodSDK.js:894

Available since 10.8

A number that specifies the minimum width of the pod containing the application.

podWidth

Number

Defined in Connect_CustomPod_SDK\src\ConnectCustomPodSDK.js:882

Available since 10.8

A number that specifies the width of the pod containing the application.

RAISE_HAND

String

Defined in Connect_CustomPod_SDK\src\ConnectCustomPodSDK.js:1107

Available since 10.8

User status value used as an argument of setMyStatus function A String value that is used to set the "Raise Hand" status

SLOW_DOWN

String

Defined in Connect_CustomPod_SDK\src\ConnectCustomPodSDK.js:1120

Available since 10.8

User status value used as an argument of setMyStatus function A String value that is used to set the "Slow Down" status

SPEAK_LOUDER

String

Defined in Connect_CustomPod_SDK\src\ConnectCustomPodSDK.js:1133

Available since 10.8

User status value used as an argument of setMyStatus function A String value that is used to set the "Speak Louder" status

SPEAK_SOFTER

String

Defined in Connect_CustomPod_SDK\src\ConnectCustomPodSDK.js:1146

Available since 10.8

User status value used as an argument of setMyStatus function A String value that is used to set the "Speak Softer" status

SPEED_UP

String

Defined in Connect_CustomPod_SDK\src\ConnectCustomPodSDK.js:1159

Available since 10.8

User status value used as an argument of setMyStatus function A String value that is used to set the "Speed Up" status

STEP_AWAY

String

Defined in Connect_CustomPod_SDK\src\ConnectCustomPodSDK.js:1172

Available since 10.8

User status value used as an argument of setMyStatus function A String value that is used to set the "Step Away" status

STEP_IN

String

Defined in Connect_CustomPod_SDK\src\ConnectCustomPodSDK.js:1185

Available since 10.8

User status value used as an argument of setMyStatus function A String value that is used to set the "Step In" status

VERSION

String

Defined in Connect_CustomPod_SDK\src\ConnectCustomPodSDK.js:1238

Available since 10.8

This String value that dafaults to 2.0"

Events

caughtUp

Defined in Connect_CustomPod_SDK\src\ConnectCustomPodSDK.js:612

Available since 10.0

Event that indicates that the caughtUp phase is complete, but also is an indication that it is now safe to send messages more freely to the Connect application.

Event Payload:

  • UNKNOWN Void

Example:

     customPodObject.registerCallback("caughtUp",() => ( this.caughtUp() ));
                         this.caughtUp(){
                             console.log("Here my event got caught I will put my logic here");
                         }

playStateChanged

Defined in Connect_CustomPod_SDK\src\ConnectCustomPodSDK.js:814

Available since 10.5

[RECORDING]: When playStateChanged from play to pause or vice versa

Event Payload:

  • event Object

    this object has playState property

Example:

    customPodObject.registerCallback("playStateChanged",(evt) => ( this.playStateChanged(evt) ));
                         this.roleChanged(evt){
                             evt.playState
                             evt.type // 'playStateChanged'
                         }

podClosed

Defined in Connect_CustomPod_SDK\src\ConnectCustomPodSDK.js:850

Available since 11.0

When pod is hidden / closed

Event Payload:

  • event Object

    this object only contains event type

Example:

    customPodObject.registerCallback("podClosed",(evt) => ( this.podClosed(evt) ));
                         this.podClosed(evt){
                             evt.type // 'sizeChanged'
                         }

podTitleChanged

Defined in Connect_CustomPod_SDK\src\ConnectCustomPodSDK.js:745

Available since 10.0

When title of pod in which custom pod is shared is changed

Event Payload:

  • event Object

    this object has podTitle as property that gives the new title

Example:

    customPodObject.registerCallback("podTitleChanged",(evt) => ( this.podTitleChanged(evt) ));
                         this.podTitleChanged(evt){
                             evt.podTitle
                             evt.type // 'podTitleChanged'
                         }

pointerToggle

Defined in Connect_CustomPod_SDK\src\ConnectCustomPodSDK.js:762

Available since 10.0

When state of pointer is toggled

Event Payload:

  • event Object

    this object has isPointerOn property

Example:

    customPodObject.registerCallback("pointerToggle",(evt) => ( this.pointerToggle(evt) ));
                         this.pointerToggle(evt){
                             evt.isPointerOn
                             evt.type // 'pointerToggle'
                         }

roleChanged

Defined in Connect_CustomPod_SDK\src\ConnectCustomPodSDK.js:796

Available since 10.0

When role of a user is changed

Event Payload:

  • event Object

    this object has type, newRole and userId as property

Example:

    customPodObject.registerCallback("roleChanged",(evt) => ( this.roleChanged(evt) ));
                         this.roleChanged(evt){
                             evt.newRole
                             evt.type // 'roleChanged'
                             evt.userId
                         }

sizeChanged

Defined in Connect_CustomPod_SDK\src\ConnectCustomPodSDK.js:832

Available since 11.0

When pod Size is Changed

Event Payload:

  • event Object

    this object has updated width and height as property

Example:

    customPodObject.registerCallback("sizeChanged",(evt) => ( this.sizeChanged(evt) ));
                         this.sizeChanged(evt){
                             evt.width
                             evt.height 
                             evt.type // 'sizeChanged'
                         }

syncMessageReceived

Defined in Connect_CustomPod_SDK\src\ConnectCustomPodSDK.js:687

Available since 10.0

when sync messages are received

Event Payload:

  • event Object

    this object has msgNm and msgVal

Example:

    customPodObject.registerCallback("syncMessageReceived",(evt) => ( this.syncMessageReceived(evt) ));
                         this.syncMessageReceived(evt){
                             evt.isDelta
                             evt.msgNm
                             evt.msgVal
                             evt.type // 'syncMessageReceived'
                             evt.uID  // userId of the user sending the sync message
                         }

syncModeChanged

Defined in Connect_CustomPod_SDK\src\ConnectCustomPodSDK.js:707

Available since 10.0

When Sync Mode of share pod is changed

Event Payload:

  • event Object

    this object has two properties didISync and isSynced

Example:

    customPodObject.registerCallback("syncModeChanged",(evt) => ( this.syncModeChanged(evt) ));
                         this.syncModeChanged(evt){
                             evt.didISync
                             evt.isSynced
                             evt.type // 'syncModeChanged'
                         }

userDetailsChanged

Defined in Connect_CustomPod_SDK\src\ConnectCustomPodSDK.js:725

Available since 10.0

When user details get changed such as name of the user is changed

Event Payload:

  • event Object

    this object has type property that denotes the type of the event, fullName and userId of the user

Example:

    customPodObject.registerCallback("userDetailsChanged",(evt) => ( this.userDetailsChanged(evt) ));
                         this.userDetailsChanged(evt){
                             evt.fullName
                             evt.name
                             evt.type // 'userDetailsChanged'
                             evt.userId
                         }

userJoined

Defined in Connect_CustomPod_SDK\src\ConnectCustomPodSDK.js:628

Available since 10.0

Event fired when user enters the meeting

Event Payload:

  • event Object

    this object has user property that holds details of the user joined and type property that shows type of event

Example:

     customPodObject.registerCallback("userJoined",(evt) => ( this.userJoined(evt) ));
                         this.userJoined(evt){
                             evt.type       // 'userJoined'
                             evt.user.breakoutId
                             evt.user.breakoutRoomName
                             evt.user.fullName
                             evt.user.id
                             evt.user.name
                             evt.user.role
                         }

userLeft

Defined in Connect_CustomPod_SDK\src\ConnectCustomPodSDK.js:652

Available since 10.0

when user joins the meeting

Event Payload:

  • event Object

    this object has type property and userId property

Example:

     customPodObject.registerCallback("userLeft",(evt) => ( this.userLeft(evt) ));
                         this.userLeft(evt){
                             evt.type  // "userLeft"
                             evt.userID
                         }

userStatusChanged

Defined in Connect_CustomPod_SDK\src\ConnectCustomPodSDK.js:669

Available since 10.0

when user status gets changed

Event Payload:

  • event Object

    this object has userId and status as its property

Example:

    customPodObject.registerCallback("userStatusChanged",(evt) => ( this.userStatusChanged(evt) ));
                         this.userStatusChanged(evt){
                             evt.type  // 'userStatusChanged'
                             evt.status  // Array containing all the status of this user
                             evt.userId
                         }

whiteBoardToggle

Defined in Connect_CustomPod_SDK\src\ConnectCustomPodSDK.js:779

Available since 10.0

When state of whiteboard is toggled

Event Payload:

  • event Object

    this object has isWhiteBoardOn property

Example:

    customPodObject.registerCallback("whiteBoardToggle",(evt) => ( this.whiteBoardToggle(evt) ));
                         this.whiteBoardToggle(evt){
                             evt.isWhiteBoardOn
                             evt.type // 'whiteBoardToggle'
                         }