AccountManagement Class Reference
| Inherits from | DefaultConfiguration : NSObject |
|---|---|
| Declared in | AccountManagement.h |
– createAnAccount:
Create an account with a name.
- (CloudResponse *)createAnAccount:(NSString *)accountNameParameters
accountName |
name of the account to be created. |
|---|
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
AccountManagement.h
– getAccountInformation
Get the information about an account.
- (CloudResponse *)getAccountInformationReturn 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
AccountManagement.h
– getAccountActivationCode
Get the account activation code which is the transient code that can be used to activate devices for the account. It expires after one hour.
- (CloudResponse *)getAccountActivationCodeReturn 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
AccountManagement.h
– renewAccountActivationCode
Force a renewal of the account activation code.
- (CloudResponse *)renewAccountActivationCodeReturn 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
AccountManagement.h
– updateAnAccount:andOptionalAttributesWithSimpleKeyValues:
Update the account with a list of attributes
- (CloudResponse *)updateAnAccount:(NSString *)accountNameToUpdate andOptionalAttributesWithSimpleKeyValues:(NSDictionary *)attributesParameters
accountNameToUpdate |
the name that identifies the account to be updated |
|---|---|
attributes |
the optional list of name value pair of attributes to be updated |
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
AccountManagement.h
– addAnotherUserToAccount:UserGettingInvited:Admin:
Add another user to your account.
- (CloudResponse *)addAnotherUserToAccount:(NSString *)accountId UserGettingInvited:(NSString *)inviteeUserId Admin:(BOOL)isAdminParameters
accountId |
The account id of the other user. |
|---|---|
inviteeUserId |
The user id of the other user. |
isAdmin |
The role for this user in the current account. |
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
AccountManagement.h
– deleteAnAccount
Delete the current account.
- (CloudResponse *)deleteAnAccountReturn 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
AccountManagement.h