Client Framework API

Namespace: Connection

Connection

Manages connectivity, holds connection and user criteria, and handles packets.

Source:

Members

<static> ajaxCheckTimeout :number

Length of time before AJAX internet connectivity check times out (ms).

Type:
  • number
Source:

<static> ajaxCheckUrl :string

URL for AJAX internet connectivity check.

Type:
  • string
Source:

<static> cache :object

Hashlike object of cached data.

Type:
  • object
Source:

<static> connected :boolean

Whether Framework is connected to user server via XMPP.

Type:
  • boolean
Source:

<static> connectedOnce :boolean

Whether Framework has connected to user server once since starting.

Type:
  • boolean
Source:

<static> create_video_sessions :number

Feature: Whether user can create video sessions.

Type:
  • number
Source:

<static> domain :string

XMPP server domain.

Type:
  • string
Source:
See:

<static> download_url :string

User's download path (possibly unused).

Type:
  • string
Source:

<static> features :array

Array of feature objects from API.

Type:
  • array
Source:

<static> focused :boolean

State: Whether any Framework windows are focused.

Type:
  • boolean
Source:

<static> hidden :boolean

State: Whether any Framework windows are hidden.

Type:
  • boolean
Source:

<static> internet :boolean

Whether Framework is able to access the internet. Assumed true until proven otherwise.

Type:
  • boolean
Source:

<static> isOnLinkCallbackSet :boolean

Whether Connection's WebView is about to unload.

Type:
  • boolean
Source:

<static> lightboxes :array

Array of reserved WebView names to handle as lightboxes.

Type:
  • array
Source:

<static> minimized :boolean

State: Whether any Framework windows are minimized.

Type:
  • boolean
Source:

<static> mouse :boolean

State: Whether any Framework windows contain mouse pointer.

Type:
  • boolean
Source:

<static> my_customer :number

User's customer id.

Type:
  • number
Source:

<static> my_email :string

User's email address.

Type:
  • string
Source:

<static> my_extension :number

User's default extension id.

Type:
  • number
Source:

<static> my_extension_number :string

User's default extension number.

Type:
  • string
Source:

<static> my_location :number

User's location id.

Type:
  • number
Source:

<static> my_user_id :number

User's user id.

Type:
  • number
Source:

<static> notificationsDismissed :number

Last time a notification was dismissed (ms timestamp).

Type:
  • number
Source:

<static> operator_mode :number

Feature: Whether user interacts with calls and extensions as an operator.

Type:
  • number
Source:

<static> overlays :object

Hashlike object of overlay states.

Type:
  • object
Properties:
Name Type Description
shoebox Boolean

Whether shoebox is open.
navigation Boolean

Whether navigation is open.
lightbox Boolean

Whether a lightbox is open.
Source:

<static> password :string

XMPP password credential.

Type:
  • string
Source:
See:

<static> pingCheck :number

Interval to check time since last user server ping (ms).

Type:
  • number
Source:

<static> pingInterval :number

Expected interval between incoming user server pings (ms).

Type:
  • number
Source:

<static> pingLast :number

Time of last ping packet from XMPP user server (ms timestamp).

Type:
  • number
Source:

<static> pingMisses :number

Number of missed pings before XMPP connection is presumed lost.

Type:
  • number
Source:

<static> pingTolerance :number

Length of time before an incoming user server ping is considered missed (ms).

Type:
  • number
Source:

<static> pongCheck :number

Interval to wait before checking for a pong from server (ms).

Type:
  • number
Source:

<static> release_notes :number

Whether user has seen running Framework version's release notes.

Type:
  • number
Source:

<static> reloading :boolean

Whether Connection's WebView is going to load again after unloading.

Type:
  • boolean
Source:

<static> sessionId :number

User's user server session id.

Type:
  • number
Source:

<static> sessionNick :string

User's user server session nick.

Type:
  • string
Source:

<static> shortcuts :object

Hashlike object of shortcut mappings.

Type:
  • object
Source:

<static> show_unavailable :number

Setting: Whether unavailable extensions are shown.

Type:
  • number
Source:

<static> sleeping :boolean

Whether framework will be or has been in system sleep state.

Type:
  • boolean
Source:

<static> splash :boolean

Whether WebView "framework_splash_screen" is open.

Type:
  • boolean
Source:

<static> starlets :object

Hashlike object of starlet objects.

Type:
  • object
Source:

<static> subscriptions :object

Hashlike object of packet subscriptions.

Type:
  • object
Source:

<static> unloading :boolean

Whether Connection's WebView is about to unload.

Type:
  • boolean
Source:

<static> url :string

XMPP server path.

Type:
  • string
Source:
See:

<static> user_id :number

User's user id. (REDUNDANT)

Type:
  • number
Source:
See:

<static> username :string

XMPP username credential.

Type:
  • string
Source:
See:

<static> view_all_calls :number

Feature: Whether user can see all calls.

Type:
  • number
Source:

<static> view_all_conferences :number

Feature: Whether user can view all conferences.

Type:
  • number
Source:

<static> view_privacy :number

Feature: Whether user can view other private users.

Type:
  • number
Source:

<static> visible :boolean

State: Whether any Framework windows are visible to the user.

Type:
  • boolean
Source:

<private, inner> onBeforeExit :callbackGeneric

Fires before Framework exits.

Type:
Source:

<private, inner> onBeforeUnload :callbackGeneric

Fires before Connection's WebView is unloaded.

Type:
Source:

<private, inner> onConnect :callbackGeneric

Fires after user server XMPP connection is established.

Type:
Source:

<private, inner> onDisconnect :callbackGeneric

Fires after user server XMPP connection is terminated.

Type:
Source:

<private, inner> onPng :callbackGeneric

Fires when user server XMPP ping is received.

Type:
Source:

<private, inner> onReadyAPI :callbackGeneric

Fires when API is ready to query.

Type:
Source:

<private, inner> onReadyData :callbackGeneric

Fires after basic user data is retrieved.

Type:
Source:

<private, inner> onReadyDom :callbackGeneric

Fires when DOM signals readiness.

Type:
Source:

<private, inner> onReadyFramework :callbackProv

Fires when framework signals readiness.

Type:
Source:

<private, inner> onRun :callbackGeneric

Fires when Connection is ready to initiate user server XMPP connection.

Type:
Source:

<private, inner> readyData :object

Synchronizer promise representing data readiness.

Type:
  • object
Source:

<private, inner> readyDom :object

Synchronizer promise representing DOM readiness.

Type:
  • object
Source:

<private, inner> readyFramework :object

Synchronizer promise representing Framework readiness.

Type:
  • object
Source:

Methods

<private, static> checkAjax()

Initiate internet connectivity checking. Mutually exclusive of Connection.checkPing.

Source:

<private, static> checkPing()

Initiate XMPP user server ping checking. Mutually exclusive of Connection.checkAjax.

Source:

<static> publish(packet, action, data, source, message)

Publish data and/or message to all starlets subscribing to a specific packet name.

Parameters:
Name Type Argument Description
packet object

DataPacket object.
action string

REST-like intention for recipient interface.
data array | object

Single or multiple data rows for display or processing.
source string

Single or multiple informational objects to allow communication with recipient in non REST-like ways.
message array | object <optional>

Single or multiple sets of recipient header information.
Source:

<private, static> reload()

Reload a starlet specified by Framework WebView name.

Source:

<static> reply(packet) → {boolean}

Reply to specific starlet with data and/or message.

Parameters:
Name Type Description
packet object

DataPacket object.
Source:
Returns:

Success or failure (of data processing, not Starlet's receipt of packet).

Type
boolean