Classes
- IllegalArgumentException
- InvalidOperationException
- NullArgumentException
- PureWebColor
- PurewebException
Namespaces
Members
-
<static> PureWebKnownColor → pureweb.PureWebColor
-
Enumeration of the cross-platform canonical colors used by PureWeb acetate tools.
Properties:
-
<static> RemoteImageFormat → string
-
An enumeration of the possible remote image formats.
Properties:
Name Type Default Description JPEGstring Jpeg JPEG image format. PNGstring Png PNG image format. BASE64_JPEGstring Base64Jpeg Base64 encoded JPEG image format. BASE64_PNGstring Base64Png Base64 encoded PNG image format. -
<static> SupportedEncoderMimeType → string
-
A list of the supported mime types for image encoding.
Properties:
Name Type Default Description JPEGstring image/jpeg JPEG mime type. PNGstring image/png PNG mime type. BASE64_JPEGstring image/jpeg;base64 Base64 encoded JPEG mime type. BASE64_PNGstring image/png;base64 Base64 encoded JPEG mime type. -
<static> version → string
-
The current version of the PureWeb JavaScript API.
Method Detail
<static> connect(uri, authinfo, opt_logoutOnClose, opt_connectSessionParams)
Connects using the client of the default framework. This is a helper function.
Parameters:
| Name | Type | Argument | Description |
|---|---|---|---|
uri |
string | The connection URI. | |
authinfo |
Object |
<optional> |
The authentication information object. |
opt_logoutOnClose |
boolean |
<optional> |
Terminate the logged in session when this connection ends. |
opt_connectSessionParams |
Object |
<optional> |
Any additional connection parameters. |
<static> disconnect()
Disconnects using the client of the default framework. This is a helper function.
<static> getClient() → {pureweb.client.WebClient}
Returns the client of the default framework. This is a helper function.
<static> getFramework() → {pureweb.client.Framework}
Returns the default instance of Framework, which provides a one-to-one correspondence with a remote application.
This is a helper function.
<static> getServiceAppName(uri) → {string}
Returns the name of the service application from the specified connection URI.
Parameters:
| Name | Type | Description |
|---|---|---|
uri |
string | The connection URI. |
<static> joinSession(uri, password)
Joins collaborative sessions with the default framework.
Parameters:
| Name | Type | Description |
|---|---|---|
uri |
string | The connection URI. |
password |
string | The session password. |
<static> listen(src, type, listener, opt_capture, opt_handler)
Adds an event listener for a specific event on a DOM Node or an object. A
listener can only be added once to an object; if it is added again, the
key for the listener is returned.
Parameters:
| Name | Type | Argument | Description |
|---|---|---|---|
src |
pureweb.events.EventTarget | The node on which to listen to events. | |
type |
string | Array.<string> | A single event type, or an array of event types. | |
listener |
function | The callback method, or an object with a
handleEvent function. |
|
opt_capture |
boolean |
<optional> |
A Boolean value indicating whether to fire in capture phase (defaults to
false). |
opt_handler |
Object |
<optional> |
The element in whose scope to call the listener. |
<static> reportException()
The exception event.
<static> unlisten(src, type, listener, opt_capture, opt_handler) → {boolean}
Removes an event listener which was added with
Returns a Boolean value that indicates whether the listener was there to remove.
listen.
Returns a Boolean value that indicates whether the listener was there to remove.
Parameters:
| Name | Type | Argument | Description |
|---|---|---|---|
src |
pureweb.events.EventTarget | The target on which to stop listening to events. | |
type |
string | Array.<string> | The name of the event, without the 'on' prefix. | |
listener |
function | The callback method, or an object with a
handleEvent function. |
|
opt_capture |
boolean |
<optional> |
A Boolean value that indicates whether the listener is fired during the capture or bubble phase of the event; this only applies to DOM-compliant browsers. |
opt_handler |
Object |
<optional> |
The element in whose scope to call the listener. |