Class Index | File Index

Classes

Any elements of the API not documented in the API reference are considered experimental and unsupported.
These may be removed in a future release.

Copyright (c) 2007-2015 by Cisco Systems, Inc.

Namespace aboutObject


Defined in: supplementaldocs.js.

Namespace Summary
Constructor Attributes Constructor Name and Description
 
Object returned from about method
Field Summary
Field Attributes Field Name and Description
 
Capabilities
 
Since: 3.0.4
Support for certificate validation.
 
Since: 3.0.1
Support for delayed user authorization dialog.
 
Since: 3.1.2
Support for external video window docking, see $.fn.cwic-dock and $.fn.cwic-undock.
 
Support for video calls.
 
Since: 3.1.0
Support for video plug-in objects in the browser, see $.fn.cwic-createVideoWindow.
 
Since: 3.1.0
Properties of channel extension to add-on.
 
ID of the browser extension, if applicable.
 
ID of html element that was appended to the web page.
 
System release information for the channel.
 
CWIC version of the Cisco Chrome extension channel.
 
JavaScript properties
 
Since: 2.1.1
JavaScript system release information.
 
JavaScript version
 
jQuery properties
 
jQuery version
 
Cisco Web Communicator add-on properties.
 
Version details for the loaded add-on.
 
CWIC version of the add-on.
 
Since: 2.1.1
System release information for the add-on.
 
cwic states
 
Currently registered device if any
 
Current system state (e.g.
 
Advice about possible upgrade.
 
Relevant if add-on version is later than the cwic.js JavaScript.
 
Relevant if the cwic.js JavaScript version is later than the add-on.
Namespace Detail
aboutObject
Object returned from about method
Field Detail
{Object} capabilities
Capabilities

{Boolean} capabilities:certValidation
Since: 3.0.4
Support for certificate validation. If true, certificate validation will be used unless explicitly disabled by calling $.fn.cwic-disableCertValidation. If false, certificate validation will not be available.

{Boolean} capabilities:delayedUserAuth
Since: 3.0.1
Support for delayed user authorization dialog.

{Boolean} capabilities:externalWindowDocking
Since: 3.1.2
Support for external video window docking, see $.fn.cwic-dock and $.fn.cwic-undock.

{Boolean} capabilities:video
Support for video calls.

{Boolean} capabilities:videoPluginObject
Since: 3.1.0
Support for video plug-in objects in the browser, see $.fn.cwic-createVideoWindow. If false, video can only be shown in an external video window.

{Object|null} channel
Since: 3.1.0
Properties of channel extension to add-on. Null if add-on is loaded directly (NPAPI or ActiveX plug-in).

{String} channel:cwicExtId
ID of the browser extension, if applicable.

{String} channel:objectId
ID of html element that was appended to the web page. If present, this element is used and required by the channel extension.

{String} channel:system_release
System release information for the channel.

{String} channel:version
CWIC version of the Cisco Chrome extension channel.

{Object} javascript
JavaScript properties

{String} javascript:system_release
Since: 2.1.1
JavaScript system release information.

{String} javascript:version
JavaScript version

{Object} jquery
jQuery properties

{String} jquery:version
jQuery version

{Object|null} plugin
Cisco Web Communicator add-on properties. Null if add-on could not be loaded.

{Object} plugin:version
Version details for the loaded add-on.

{String} plugin:version:plugin
CWIC version of the add-on.

{String} plugin:version:system_release
Since: 2.1.1
System release information for the add-on.

{Object} states
cwic states

{Object} states:device
Currently registered device if any

{String} states:system
Current system state (e.g. "eReady")

{Object} upgrade
Advice about possible upgrade.

{String} upgrade:javascript
Relevant if add-on version is later than the cwic.js JavaScript. Can be one of
  • "mandatory" The add-on and cwic.js versions are not compatible.
  • "recommended" The add-on may have features or bug fixes that require upgrade to cwic.js.
  • undefined if not relevant.

{String} upgrade:plugin
Relevant if the cwic.js JavaScript version is later than the add-on. Can be one of
  • "mandatory" The add-on and cwic.js versions are not compatible.
  • "recommended" The add-on may not provide all features or bug fixes available.
  • "unknown" Unable to determine version of the add-on.
  • undefined if not relevant.
Documentation generated by JsDoc Toolkit 2.4.0 on Wed Jul 08 2015 19:01:40 GMT+0200 (Central Europe Daylight Time)