getAccountList


Purpose

Passes a map of all accounts with their public user data to the onSuccess callback.

Signature

getAccountList( callback )

Returns

This method does not return anything.

Parameter

Name Description Type Use
callback Passed while sending a reply to the request for a map of all accounts with their public user data. object required

Callback structure

The AccountList object's callback can be structured as follows:

{
	onFailure: function(error) { ... },
	onSuccess: function(accountList) { ... }
}

Methods

Name Description Return type
onFailure Indicates that a request was not processed. Passes the error object that contains two fields: code (a numeric value associated with an error) and description (the type of failure). Possible failure types are listed in the Constants table, in the AccountManager article. undefined
onSuccess Indicates that a request was successfully processed. Passes the accountList object that contains a map of public account data keyed by account identifier. undefined

Related topics

Public API reference
AccountManager
Legal notice | Copyright © 2017 and Confidential to Pegasystems Inc. All rights reserved
PDN | Pega Mobile Client | Feedback
Advanced...