new Manager(win, control, fnReady)
Manager Class Constructor function--please ensure that the FVSessions.config.msgAPI is set
to correspond with the API JS file you are using (see FVSessions.Manager class documentation)
Parameters:
| Name | Type | Description |
|---|---|---|
win |
Object | The Window object for the environment this Manager will run in |
control |
SessionDef | Settings for the events and sessions, with objects keyed by sessionID key property for each session is connection |
fnReady |
function | Completion function called when ready--includes a reference to the sessions object, indexed by session ids |
- Source:
Methods
FVSMGR.FindSessionByKey(sessionKey) → {Session}
Find a Session object based on a sessionKey
Parameters:
| Name | Type | Description |
|---|---|---|
sessionKey |
String | The SessionKey to use in the search |
- Source:
Returns:
Found session or null
- Type
- Session
FVSMGR.ResizeSessions(width, height)
Resize all Sessions
Parameters:
| Name | Type | Description |
|---|---|---|
width |
Integer | New Width for each Session |
height |
Integer | New height for each sessions |
- Source:
FVSMGR.ServerCall(url, data, options, fnReady) → {FVSMGR.ServerCall}
Call a server function that supports the session manager
Parameters:
| Name | Type | Description |
|---|---|---|
url |
String | Action portion of the url |
data |
Object | (Optional) - For a post, the object that will be sent as JSON stringified null value is ignored |
options |
Object | (optional) properties include method (GET/POST), mimeType, credUser and credPW all optional--null is ignored |
fnReady |
function | Completion function called with returned object converted from JSON |
- Source:
Returns:
object
- Type
- FVSMGR.ServerCall
FVSMGR.StartSession(id, styles, parentElem, fnReady)
Start a Session
Parameters:
| Name | Type | Description |
|---|---|---|
id |
String | The ID of the session - must match one of the sessions defined in the constructor |
styles |
Object | (Optional) - If not null, an object with property names matching styles to attach to the new session's iFrame |
parentElem |
Object | Parent DOM element--if not included, the document.body element will be the parent of the new iFrame |
fnReady |
function | Completion function called when the session has been started |
- Source: