|
Oracle© Collaboration Suite Workspaces Web Services API Reference 10g Release 1 (10.1.2.2) Part No. B28209-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
UsersService provides methods to operate on properties of users of workspaces.
The major operations supported include: retrieval of user properties, retrieval of all users in a group, retrieval of user preferences and updation of user preferences
The Axis specific code snippet given below, illustrates how users within a group can be retrieved.
// Invoke an instance of user service locator and get a handle to user service. UsersServiceServiceLocator ussl = new UsersServiceServiceLocator(); UsersService uService = ussl.getUsersService(); // Invoke method to list all users in a OID group given the group name. String[] attrRequest = {"invalid"}; oracle.workspaces.ws.beans.User[] users = uService.getMembersByGroupName("testgroup1", attrRequest);
Method Summary | |
User[] |
getMembersByGroupDN(java.lang.String groupDN, java.lang.String[] attrRequest) Lists all the users in the group specified. |
User[] |
getMembersByGroupName(java.lang.String groupCN, java.lang.String[] attrRequest) Lists all the users in the group specified. |
UserPreferences |
getMyPreferences() Returns the preferences of the current user. |
UserPresenceStatus[] |
getPresenceStatus(java.lang.String[] userNicknames) Retrieves the presence status, given the users' nicknames. |
User |
getUserFromNickName(java.lang.String userNickname, java.lang.String[] attrRequest) Retrieves the user, given his nickname. |
void |
updateMyPreferences(UserPreferences userPreferences) Update the preferences for the current user. |
Method Detail |
public User getUserFromNickName(java.lang.String userNickname, java.lang.String[] attrRequest) throws CwWSException
userNickname
-attrRequest
- - Can request optional user presence information like CLIENT_LAUNCH_URI - Uri to launch the RTC client for the user. STATUS_IMAGE_URL - Image indicating the status of the user. STATUS_URL - Url which gives the status of the user.CwWSException
public User[] getMembersByGroupDN(java.lang.String groupDN, java.lang.String[] attrRequest) throws CwWSException
groupDN
- - Distinguished name of the group in which the users are present.attrRequest
- - Can request optional user presence information like CLIENT_LAUNCH_URI - Uri to launch the RTC client for the user. STATUS_IMAGE_URL - Image indicating the status of the user. STATUS_URL - Url which gives the status of the user.CwWSException
public User[] getMembersByGroupName(java.lang.String groupCN, java.lang.String[] attrRequest) throws CwWSException
groupCN
- - CN of the group in which the users are present.attrRequest
- - Can request optional user presence information like CLIENT_LAUNCH_URI - Uri to launch the RTC client for the user. STATUS_IMAGE_URL - Image indicating the status of the user. STATUS_URL - Url which gives the status of the user.CwWSException
public UserPreferences getMyPreferences() throws CwWSException
CwWSException
public void updateMyPreferences(UserPreferences userPreferences) throws CwWSException
userPreferences
- - UserPreferences representing the preferences to be updated for the current logged in user. NOTE: Locale and TimeZone are read-only properties. Cannot be set using this call. Also, use the charset and language attributes while setting and not their display names. The display names are read-only.CwWSException
public UserPresenceStatus[] getPresenceStatus(java.lang.String[] userNicknames) throws CwWSException
userNicknames
- - Nicknames of the users whose presence status need to be retrieved.CwWSException
|
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |