Interface IWebexAppsApplicationState

Type definition for app.application.state

Hierarchy

  • IWebexAppsApplicationState

Properties

about capabilities deviceType displayContext embeddedSdkVersion isPrivateDataAvailable isShared language sdkVersion theme viewState

Properties

Readonly about

about: null | string

General information about the host. This format is subject to change and should only be used for diagnostic purposes.

Readonly capabilities

capabilities: null | string[]

Indicates the capabilities of the given device.

Note - Currently not in use and subject to change.

An empty string array is returned.

Readonly deviceType

deviceType: null | string

The given device form factor.

One of "DESKTOP", "MOBILE", "BROWSER"

Readonly displayContext

displayContext: null | string

Display context (frame) in which the 3rd party app is being rendered.

One of the following strings "MEETING_SIDEBAR", "MEETING_STANDALONE_WINDOW", "MEETING_MAINVIEW", or "SPACETAB".

Default is "MEETING_SIDEBAR".

Readonly embeddedSdkVersion

embeddedSdkVersion: null | string

Indicates the version of the embedded app sdk.

Readonly isPrivateDataAvailable

isPrivateDataAvailable: null | boolean

Indicates if real Ids are being used or derived ids are avaliable. This is based on the ControlHub setting for the given app.

Readonly isShared

isShared: null | boolean

Indicates if the embedded app’s link (specified using the setShareUrl method) has been added to the meeting or space by the user.

Readonly language

language: null | string

Indicates the given language being used by the given meetings client.

Example values: "en-US", "da-DK", etc.

Readonly sdkVersion

sdkVersion: null | string

Indicates the SDK version the given meetings client implements.

Example values: "1.x" for 41.6 to 41.9.

Readonly theme

theme: null | string

Indicates the given theme of the given meetings client, either Theme.LIGHT, or Theme.DARK.

Readonly viewState

viewState: null | string

Indicates the application's current view state, IN_FOCUS or OUT_OF_FOCUS.

Settings

Member Visibility

Theme