UserManagement Class Reference
| Inherits from | DefaultConfiguration : NSObject |
|---|---|
| Declared in | UserManagement.h |
– createNewUserWith:AndPassword:
Create a new user
- (CloudResponse *)createNewUserWith:(NSString *)emailId AndPassword:(NSString *)passwordParameters
emailId |
the email id for the user which is used as an identifier |
|---|---|
password |
the password for the user |
Return Value
For async model, return CloudResponse which wraps true if the request of REST call is valid; otherwise false. The actual result from the REST call is return asynchronously as part HttpResponseDelegatee of DefaultConfiguration. For synch model, return CloudResponse which wraps HTTP return code and response. @throws JSONException
Declared In
UserManagement.h
– deleteUser:
Delete a user
- (CloudResponse *)deleteUser:(NSString *)userIdParameters
userId |
the identifier for the user to be deleted from the cloud |
|---|
Return Value
For async model, return CloudResponse which wraps true if the request of REST call is valid; otherwise false. The actual result from the REST call is return asynchronously as part HttpResponseDelegatee of DefaultConfiguration. For synch model, return CloudResponse which wraps HTTP return code and response.
Declared In
UserManagement.h
– getUserInfo:
Get user information
- (CloudResponse *)getUserInfo:(NSString *)userIdParameters
userId |
the identifier for the user for retrieving user information for |
|---|
Return Value
For async model, return CloudResponse which wraps true if the request of REST call is valid; otherwise false. The actual result from the REST call is return asynchronously as part HttpResponseDelegatee of DefaultConfiguration. For synch model, return CloudResponse which wraps HTTP return code and response.
Declared In
UserManagement.h
– updateUserAttributesOn:AndListOfAttributes:
Update the user attributes for a given user
- (CloudResponse *)updateUserAttributesOn:(NSString *)userId AndListOfAttributes:(NSDictionary *)listOfUserAttributesParameters
userId |
The identifier for the user to update the attributes for |
|---|---|
listOfUserAttributes |
A list of name value pairs that specify the user attributes for the user |
Return Value
For async model, return CloudResponse which wraps true if the request of REST call is valid; otherwise false. The actual result from the REST call is return asynchronously as part HttpResponseDelegatee of DefaultConfiguration. For synch model, return CloudResponse which wraps HTTP return code and response. @throws JSONException
Declared In
UserManagement.h
– requestChangePasswordOn:
Request for change of password
- (CloudResponse *)requestChangePasswordOn:(NSString *)emailIdParameters
emailId |
The email address of the user that requests for a change of password |
|---|
Return Value
For async model, return CloudResponse which wraps true if the request of REST call is valid; otherwise false. The actual result from the REST call is return asynchronously as part HttpResponseDelegatee of DefaultConfiguration. For synch model, return CloudResponse which wraps HTTP return code and response. @throws JSONException
Declared In
UserManagement.h
– updateForgotPassword:AndNewPassword:
Update the password
- (CloudResponse *)updateForgotPassword:(NSString *)mailToken AndNewPassword:(NSString *)newPasswordParameters
mailToken |
The token that is used access the cloud backend for updating the password |
|---|---|
newPassword |
The new password for the user |
Return Value
For async model, return CloudResponse which wraps true if the request of REST call is valid; otherwise false. The actual result from the REST call is return asynchronously as part HttpResponseDelegatee of DefaultConfiguration. For synch model, return CloudResponse which wraps HTTP return code and response. @throws JSONException
Declared In
UserManagement.h
– changePasswordOn:AndCurrentPassword:AndNewPassword:
Change the password for the user
- (CloudResponse *)changePasswordOn:(NSString *)emailId AndCurrentPassword:(NSString *)currentPassword AndNewPassword:(NSString *)newPasswordParameters
emailId |
The email address of the user |
|---|---|
currentPassword |
The current password for the user |
newPassword |
The new password for the user |
Return Value
For async model, return CloudResponse which wraps true if the request of REST call is valid; otherwise false. The actual result from the REST call is return asynchronously as part HttpResponseDelegatee of DefaultConfiguration. For synch model, return CloudResponse which wraps HTTP return code and response. @throws JSONException
Declared In
UserManagement.h