#include <UserManagerProtocol.h>
Inherits <NSObject>.
The UserManagerProtocol
allows to handle user management related features.
◆ __deprecated_msg
◆ deleteAllOrchestrationUsersWithError:
- (BOOL) deleteAllOrchestrationUsersWithError: |
|
(NSError **) | error |
|
Deactivates all the user.
- Parameters
-
error | a NSError raised if there is an error during the process. |
- Returns
- true if the call is successful, If an error occurred the reason will be put in the error.
◆ deleteUserWithOrchestrationUser:error:
- (BOOL) deleteUserWithOrchestrationUser: |
|
(OrchestrationUser *) | orchestrationUser |
error: |
|
(NSError **) | error |
Deactivates a specified user.
- Parameters
-
error | a NSError raised if there is an error during the process. |
orchestrationUser | the user to deactivate |
- Returns
- true if the call is successful, If an error occurred the reason will be put in the error.
◆ isUserActivated:error:
- (BOOL) isUserActivated: |
|
(OrchestrationUser *) | orchestrationUser |
error: |
|
(NSError **) | NS_SWIFT_NOTHROW |
Check whether the provided user identifier corresponds to an activated user.
- Parameters
-
orchestrationUser | the user to check |
error | a NSError raised if there is an error during the process. |
- Returns
- true if the user is activated, If an error occurred the reason will be put in the error.
◆ userInformationForOrchestrationUser:error:
Retrieves the information related to a specific user.
- Parameters
-
orchestrationUser | the user |
error | a NSError raised if there is an error during the process. |
- Returns
- nil if an error occured, or a
UserInformationProtocol
object
◆ usersWithError:
Retrieves the list of activated users.
- Parameters
-
error | a NSError raised if there is an error during the process. |
- Returns
- a list of
OrchestrationUser
The documentation for this protocol was generated from the following file: