Class Index | File Index

Classes


Class finesse.restservices.TeamPhoneBooks

JavaScript representation of a TeamPhoneBooks collection object. Also exposes methods to operate on the object against the server.
Defined in: TeamPhoneBooks.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
Method Summary
Method Attributes Method Name and Description
 
createPutSuccessHandler(contact, contentBody, successHandler)
 
get()
Retrieve the Not Ready Reason Codes.
 
Overrides the parent class.
 
update(newValues, handlers)
Update - This should be all that is needed.
Class Detail
finesse.restservices.TeamPhoneBooks(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.TeamPhoneBooks} get()
Retrieve the Not Ready Reason Codes.
Returns:
{finesse.restservices.TeamPhoneBooks} This TeamPhoneBooks object to allow cascading.

getRestUrl()
Overrides the parent class. Returns the url for the PhoneBooks resource

update(newValues, handlers)
Update - This should be all that is needed.
Parameters:
newValues
handlers

Documentation generated by JsDoc Toolkit 2.3.2 on Wed Jul 24 2013 18:47:09 GMT-0400 (EDT)