|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
@RpcInterface(value="ucp.v30.requests.userState") @UciService(value="ucp.v30.requests.userState") public interface UcpUserStateRequests
This interface defines the requests used to alter the user's state provided by the UCI server.
| Nested Class Summary | |
|---|---|
static interface |
UcpUserStateRequests.AvatarImageFileUpload
This interface defines the RPC methods that can be used to upload the image files |
| Field Summary | |
|---|---|
static String |
SERVICE_NAME
The UCI service name used for this interface |
| Method Summary | |
|---|---|
Map<String,Object> |
getAvatarImage()
This request can be used by the UCI client to retrieve the user's avatar image. |
String |
getUserName()
This request can be used by the UCI client to get the name of the current user. |
Map<String,Object> |
getUserState()
This request can be used by the UCI client to obtain the current user's state with information about his DND, telefony, chat and avatar state. |
void |
setAvatarImage(Map<String,Object> image)
This request can be used by the UCI client to set a new avatar image for the user. |
void |
setAvatarImageFile(String fileId)
This request can be used by the UCI client to set a new avatar image for the user. |
void |
setChatPresenceMessage(String message)
This request can be used by the UCI client to set the chat presence message of the user. |
void |
setDoNotDisturbSetting(boolean active)
This request can be used by the UCI client to set the user do not disturb setting. |
| Field Detail |
|---|
static final String SERVICE_NAME
| Method Detail |
|---|
Map<String,Object> getUserState()
throws UciException
Map with the values defined in
UserState
UciException - if the request is not valid as defined by the UCI specification. This may be the case
if the request with the given parameters is not allowed to the user (
UciIllegalAccessException) or if the request is placed while the UCI client
is not connected (UcpNotConnectedException).
void setDoNotDisturbSetting(boolean active)
throws UciException
active - the new state for the do not disturb setting
UciException - if the request is not valid as defined by the UCI specification. This may be the case
if the request with the given parameters is not allowed to the user (
UciIllegalAccessException) or if the request is placed while the UCI client
is not connected (UcpNotConnectedException).
void setChatPresenceMessage(String message)
throws UciException
message - the new presence message to be set
UciException - if the request is not valid as defined by the UCI specification. This may be the case
if one of the request's arguments has an illegal value (
UciIllegalArgumentException) or if the request with the given parameters is
not allowed to the user (UciIllegalAccessException) or if the request is
placed while the UCI client is not connected (UcpNotConnectedException).
Map<String,Object> getAvatarImage()
throws UciException
UserStateProperties.avatarHash property holds an non
empty hash of the image.
Map with values as defined in
ImageProperties.
UciException - if the request is not valid as defined by the UCI specification. This may be the case
if the request with the given parameters is not allowed to the user (
UciIllegalAccessException) or if the request is placed while the UCI client
is not connected (UcpNotConnectedException).
void setAvatarImage(Map<String,Object> image)
throws UciException
image - the new image to be set as Map with values as defined in
ImageProperties.
UciException - if the request is not valid as defined by the UCI specification. This may be the case
if one of the request's arguments has an illegal value (
UciIllegalArgumentException) or if the request with the given parameters is
not allowed to the user (UciIllegalAccessException) or if the request is
placed while the UCI client is not connected (UcpNotConnectedException).
void setAvatarImageFile(String fileId)
throws UciException
UcpUserStateRequests.AvatarImageFileUpload RPC interface.
fileId - the id of the file transfer used to upload the new image file.
UciException - if the request is not valid as defined by the UCI specification. This may be the case
if one of the request's arguments has an illegal value (
UciIllegalArgumentException) or if the request with the given parameters is
not allowed to the user (UciIllegalAccessException) or if the request is
placed while the UCI client is not connected (UcpNotConnectedException).
String getUserName()
throws UciException
UciException - if the request is not valid as defined by the UCI specification. This may be the case
if one of the request's arguments has an illegal value (
UciIllegalArgumentException) or if the request with the given parameters is
not allowed to the user (UciIllegalAccessException) or if the request is
placed while the UCI client is not connected (UcpNotConnectedException).
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||