API Description for Parlay X
User Status
The following sections describe the User Status API used for retrieving the status of an end user's terminal:
User status API
getUserStatus
Get the status of a mobile terminal.
Table 10-1 getUserStatus(endUser, requester)
|
Parameter Name
|
Type
|
Description
|
|
Input
|
|
endUser
|
EndUserIdentifier
|
End user for whom user status information is being requested.
|
|
requester
|
EndUserIdentifier
|
OPTIONAL. The address of the requester.
|
|
Returns
|
|
|
UserStatusData
|
User status of the end user.
|
|
Possible exceptions
|
|
UnknownEndUserException
|
|
ServiceException
|
|
InvalidArgumentException
|
|
PolicyException
|
Data Types
Table 10-2 Data types specific for User Status
|
Data type
|
Description
|
|
|
UserStatusData
|
Structure containing the following parameters:
|
|
|
userStatusIndicator
|
Indicates the status of the end user.
Datatype: UserStatusIndicator
|
|
|
additionalUserStatusInformation
|
Additional information if the userStatusIndicator is `Other'.
Datatype: String
|
|
UserStatusIndicator
|
Enumeration with the following values:
|
|
|
Online
|
User is online.
|
|
|
Offline
|
User is offline (in case of a mobile terminal: switched off, in case of other terminal: not connected to the service), or wants to appear to be offline.
|
|
|
Busy
|
User is busy.
|
|
|
Other
|
Custom user status information can be retrieved from additionalUserStatusInformation.
|
Exceptions
No exceptions specific for User status.
