Creating a Custom UI
  • 24 Aug 2023
  • 1 Minute to read
  • Dark
    Light
  • PDF

Creating a Custom UI

  • Dark
    Light
  • PDF

Article summary

If you would like to develop your own UI elements to start a session the following JavaScript methods are provided.

Open Modal

window.Cobrowse.modal.openModal()

will open the provided ScreenMeet session start modal. The ScreenMeet provided modal is not injected into the page until this method is called at least once.


Start Session

window.Cobrowse.modal.startSession(pin)

which given a 6 digit string of numbers will begin a cobrowsing session. This is intended to be used by an alternate UI element. This method returns a promise with a boolean, indicating if the session has started. It will immediately begin a cobrowse session on the client side. 


Prompt Session

window.Cobrowse.modal.promptSession(pin)

which given a 6 digit string of numbers will offer to begin a cobrowsing session. It will open a modal prompting the user to accept a session. The user may accept or decline. 


End Session

window.Cobrowse.modal.endSession()

will end any current cobrowse session.




Was this article helpful?