Class Index | File Index

Classes


Class finesse.restservices.Team

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

Class Summary
Constructor Attributes Constructor Name and Description
 
Method Summary
Method Attributes Method Name and Description
 
Getter for the team id.
 
Getter for the team name.
 
Getter for a teamLayoutConfig object that is associated with Team.
 
Getter for a teamNotReadyReasonCodes collection object that is associated with Team.
 
getTeamPhoneBooks(callbacks)
Getter for a teamPhoneBooks collection object that is associated with Team.
 
Getter for a teamSignOutReasonCodes collection object that is associated with Team.
 
Getter for a teamWrapUpReasons collection object that is associated with Team.
 
Getter for the team uri.
 
getUsers(constructor)
Constructs and returns a collection of users
Class Detail
finesse.restservices.Team(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
{String} getId()
Getter for the team id.
Returns:
{String} The team id.

{String} getName()
Getter for the team name.
Returns:
{String} The team name

{teamLayoutConfig} getTeamLayoutConfig(callbacks)
Getter for a teamLayoutConfig object that is associated with Team.
Parameters:
callbacks
Returns:
{teamLayoutConfig}

{teamNotReadyReasonCodes} getTeamNotReadyReasonCodes(callbacks)
Getter for a teamNotReadyReasonCodes collection object that is associated with Team.
Parameters:
callbacks
Returns:
{teamNotReadyReasonCodes} A teamNotReadyReasonCodes collection object.

{teamPhoneBooks} getTeamPhoneBooks(callbacks)
Getter for a teamPhoneBooks collection object that is associated with Team.
Parameters:
callbacks
Returns:
{teamPhoneBooks} A teamPhoneBooks collection object.

{teamSignOutReasonCodes} getTeamSignOutReasonCodes(callbacks)
Getter for a teamSignOutReasonCodes collection object that is associated with Team.
Parameters:
callbacks
Returns:
{teamSignOutReasonCodes} A teamSignOutReasonCodes collection object.

{teamWrapUpReasons} getTeamWrapUpReasons(callbacks)
Getter for a teamWrapUpReasons collection object that is associated with Team.
Parameters:
callbacks
Returns:
{teamWrapUpReasons} A teamWrapUpReasons collection object.

{String} getUri()
Getter for the team uri.
Returns:
{String} The team uri

{finesse.restservices.Users} getUsers(constructor)
Constructs and returns a collection of users
Parameters:
{options} constructor
options
Returns:
{finesse.restservices.Users} Users collection of User objects

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