McDewey

Multi-vendor documentation library · semantic search · MCP endpoint at /mcp

Page 468

↗ View in doc context
page
468
source
finesse/v12.5/developer-guide/developer-guide.md
chunk_id
finesse::v12.5::developer-guide::developer-guide::452

Example Description Parameter An example var _user id: '1 onLoad onErro // // } }); A callback that is invoked with the response object as the parameter when any of the operations such as, GET, PUT, POST and DELETE fails. The following are the parameters: • status—{Number} Returns the HTTP status code. • content—{String} The raw string response. • object—{Object} The parsed object response. • error—The type of API error returned from the REST API request. It can be accessed using rsp.object.ApiErrors. ApiError.ErrorType • errorType—{String} The type of error. • errorMessage—{String} The message that is associated with the error. onError RestCollectionBase Common Parameters The RestCollectionBase objects are automatically created by the Finesse JavaScript Library when applicable APIs are used. Thus, the RestCollectionBase objects do not have to be initialized manually. The RestCollectionBase class extends the RestBase and supports all the handlers of RestBase. The RestCollectionBase extends RestBase class. Hence, all the common parameters of the RestBase applies to RestCollectionBase. Fields borrowed from class finesse.restservices.RestBase: ajaxRequestTimeout, restResponseStatus. Methods borrowed from class finesse.restservices.RestCollectionBase: getCollection, refresh. Methods borrowed from class finesse.restservices.RestBase: addHandler, getData, getId, getProperty, hasProperty, isLoaded, removeHandler. Example of Common Configurations _user.getDialogs(options) // User REST API Object is composed of Dialogs Collection Object. _team.getUsers(options) // Team REST API Object is composed of a Users Collection Object.(Users who are the part of that team) _user.getMediaList(options) // User REST API Object is composed of MediaList Collection Object. _user.getQueues(options) // User REST API Object is composed of Queues Collection Object. _team.getTeamMessages(options) // Team REST API Object is composed of a TeamMessages Collection Object. Cisco Finesse Web Services Developer and JavaScript Guide, Release 12.5(1) 452 Cisco Finesse JavaScript APIs RestCollectionBase Common Parameters