Orchestration SDK 5.10.1
Loading...
Searching...
No Matches
<UserManagerProtocol> Protocol Reference

#include <UserManagerProtocol.h>

Inherits <NSObject>.

Instance Methods

(BOOL) - isUserActivated:error:
 
(id< UserInformationProtocol > _Nullable) - userInformationForOrchestrationUser:error:
 
(BOOL) - deleteUserWithOrchestrationUser:error:
 
(BOOL) - deleteAllOrchestrationUsersWithError:
 
("use [UserManagerProtocol usersWithError:] to have the error") - __deprecated_msg
 
(NSArray< OrchestrationUser * > *_Nullable) - usersWithError:
 

Detailed Description

The UserManagerProtocol allows to handle user management related features.

Method Documentation

◆ __deprecated_msg

Retrieves the list of activated users.

Returns
a list of OrchestrationUser

◆ deleteAllOrchestrationUsersWithError:

- (BOOL) deleteAllOrchestrationUsersWithError: (NSError **) error

Deactivates all the user.

Parameters
errora 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
errora NSError raised if there is an error during the process.
orchestrationUserthe 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
orchestrationUserthe user to check
errora 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:

- (id< UserInformationProtocol > _Nullable) userInformationForOrchestrationUser: (OrchestrationUser *) orchestrationUser
error: (NSError **) error 

Retrieves the information related to a specific user.

Parameters
orchestrationUserthe user
errora NSError raised if there is an error during the process.
Returns
nil if an error occured, or a UserInformationProtocol object

◆ usersWithError:

- (NSArray< OrchestrationUser * > *_Nullable) usersWithError: (NSError **) error

Retrieves the list of activated users.

Parameters
errora 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: