Class finesse.restservices.LayoutConfig
JavaScript representation of a LayoutConfig object. Also exposes
methods to operate on the object against the server.
Defined in: TeamLayoutConfig.js.
Constructor Attributes | Constructor Name and Description |
---|---|
finesse.restservices.LayoutConfig(options)
|
Method Attributes | Method Name and Description |
---|---|
createPutSuccessHandler(contact, contentBody, successHandler)
|
|
get()
Retrieve the TeamLayoutConfig.
|
|
Getter for the category.
|
|
Getter for the code.
|
|
put(newValues, handlers)
|
Class Detail
finesse.restservices.LayoutConfig(options)
- Parameters:
- {Object} options
- An object with the following properties:
- id: The id of the object being constructed
- onLoad(this): (optional) when the object is successfully loaded from the server
- onChange(this): (optional) when an update notification of the object is received
- onAdd(this): (optional) when a notification that the object is created is received
- onDelete(this): (optional) when a notification that the object is deleted is received
- onError(rsp): (optional) if loading of the object fails, invoked with the error response object:
- status: {Number} The HTTP status code returned
- content: {String} Raw string of response
- object: {Object} Parsed object of response
- error: {Object} Wrapped exception that was caught:
- errorType: {String} Type of error that was caught
- errorMessage: {String} Message associated with error
- parentObj: (optional) The parent object
Method Detail
createPutSuccessHandler(contact, contentBody, successHandler)
- Parameters:
- contact
- contentBody
- successHandler
{finesse.restservices.TeamLayoutConfig}
get()
Retrieve the TeamLayoutConfig.
- Returns:
- {finesse.restservices.TeamLayoutConfig}
{String}
getLayoutXML()
Getter for the category.
- Returns:
- {String} The category.
getRestUrl()
{String}
getUseDefault()
Getter for the code.
- Returns:
- {String} The code.
put(newValues, handlers)
- Parameters:
- newValues
- handlers