Meetings - Embedded Apps Reference | Webex for Developers

Embedded Apps Reference

anchorBasic Usage

To add the Embedded Apps Framework to your web application add the following to the <HEAD> of your app's main HTML page:

<script src="https://binaries.webex.com/static-content-pipeline/webex-embedded-app/v1/webex-embedded-app-sdk.js" defer></script>

In your app's main index.js file create a new Webex.Application instance and create a function to handle the onReady() promise when it resolves successfully.

var app = new window.Webex.Application();

app.onReady().then(function () {
  console.log('App is ready. App info:', app);
});

anchorClasses

anchor

Webex.Application

Main application object you use to set sharing URLs, register event listeners, and get information about the application and its context.

Example usage

var app = new window.Webex.Application();

app.onReady().then(() => {
  // Create event listeners
  app.listen()
    .then(() => {
      app.on("application:shareStateChanged", (event) => {
        // Call custom function
        handleShareStateChange(event);
      })
      app.on("application:themeChanged", (event) => {
        // Call custom function
        handleThemeChange(event);
      })
});

Webex.Application.Context

Application context object that exposes methods for getting information about users, meetings, and spaces. It is exposed as a context property on the Webex Application instance.

Example usage

var app = new window.Webex.Application();

app.onReady().then(() =>  {
  app.context.getUser().then((user) => {
      console.log("getUser() promise resolved. User", user);
    }
  ).catch((error) => {
      console.log("getUser() promise failed " + error.message);
    })
});

Webex.Application

Main application object you use to set sharing URLs, register event listeners, and get information about the application and its context.

Example usage

var app = new window.Webex.Application();

app.onReady().then(() => {
  // Create event listeners
  app.listen()
    .then(() => {
      app.on("application:shareStateChanged", (event) => {
        // Call custom function
        handleShareStateChange(event);
      })
      app.on("application:themeChanged", (event) => {
        // Call custom function
        handleThemeChange(event);
      })
});

Webex.Application
webex.Application.deviceType : string
webex.Application.isPrivateDataAvailable : boolean
webex.Application.displayContext : string
webex.Application.isShared : boolean
webex.Application.capabilities : Array.<string>
webex.Application.sdkVersion : string
webex.Application.theme : string
webex.Application.about : string
webex.Application.language : string
webex.Application.setShareUrl(internalUrl, externalUrl, title, optionals) ⇒ Promise.<number>
webex.Application.clearShareUrl()
webex.Application.on(eventName, callback)
webex.Application.off(eventName)
webex.Application.listen() ⇒ Promise.<void>
webex.Application.stopListening()
webex.Application.onReady() ⇒ Promise.<void>
Webex.Application.ErrorCodes