pureweb. client

The client namespace provides the core classes for creating and managing PureWeb HTML5 clients. These include methods for connecting to the service application, for displaying views and configuring the image encoder format, for interacting with application state, and for sending commands.

Classes

AcquireException
ApplicationState
AppShare
CollaborationManager
CommandFilterEventArgs
CommandResponseEventArgs
ConnectedChangedEvent
ConnectException
CustomRenderer
EncoderConfiguration
EncoderFormat
EncoderParameter
ExceptionDetail
Framework
MultipartHandlerExceptionEventArgs
MultipartHandlerExceptionOccurred
MultiWindow
RequestException
ResponseException
SessionStorage
SessionStorageChangedEventArgs
ValueChangedEventArgs
View
ViewRenderer
ViewUpdatedEventArgs
WebClient

Namespaces

collaboration
diagnostics

Members

<static> EventType → string

An enumeration of supported types of state change events.
Properties:
Name Type Default Description
CHANGE string A PureWeb state change event.

<static> ModifierKey → number

Numeric flags representing each modifier key pressed. These values are used when sending event commands to the service application.
Properties:
Name Type Default Description
NONE number 0 No modifier key.
SHIFT number 1 Shift key.
CONTROL number 2 Control (Ctrl).
ALT number 4 Alt.
META number 8 Meta key.
APPLE number 8 Apple key.
WINDOWS number 16 Windows key.

<static> MouseButton → number

Numeric flags representing each mouse button pressed. These values are used when sending event commands to the service application.
Properties:
Name Type Default Description
NONE number 0 No mouse buttons have been pressed.
LEFT number 1 The left mouse button.
RIGHT number 2 The right mouse button.
MIDDLE number 4 The middle mouse button / scroll wheel.
XBUTTON1 number 8 Extra mouse button 1, for a mouse with 4 buttons.
XBUTTON2 number 16 Extra mouse button 2, for a mouse with 5 buttons.

<static, constant> RESPONSE_EXCEPTION_STACK_TRACE_TAG → string

StackTrace tag.

<static> SessionState → number

An enumeration of supported values for session state.
Properties:
Name Type Default Description
ACTIVE number 1 The session is active and healthy.
CONNECTING number 2 The connection to the service application is pending.
DISCONNECTED number 3 The session is disconnected.
FAILED number 4 The session has failed and lost its connection to the service application, or an attempt to connect has failed.
STALLED number 5 Between ACTIVE and FAILED, indicates that a timely keep-alive from the service application was not received. It is possible that a client will never see this session state, as PureWeb will try indefinitely to reconnect the channels. In this case, it is up to application developers to decide how long to attempt reconnection before giving up, without more information.
UNKNOWN number 6 The state of the session is unknown.

<static> SessionStorageMessageType → number

An enumeration specifying the kinds of changes that can occur to a value in session storage.
Properties:
Name Type Default Description
Set number 0 A value was set (inserted or modified).
Remove number 1 A value was deleted.
NoOp_ number 2 Nothing has changed, but a suppressed handler has been acked