DBUSERSUserAuthRoutes

Objective-C

@interface DBUSERSUserAuthRoutes : NSObject

Swift

class DBUSERSUserAuthRoutes : NSObject

Routes for the Users namespace

client
An instance of the networking client that each route will use to submit a request.
Declaration
Objective-C

@property (nonatomic, readonly) id<DBTransportClient> _Nonnull client;
-init:
Initializes the DBUSERSUserAuthRoutes namespace container object with a networking client.
Declaration
Objective-C

- (nonnull instancetype)init:(nonnull id<DBTransportClient>)client;


                    
                    
                    -featuresGetValues:

Get a list of feature values that may be configured for the current account.

Declaration

Objective-C

- (nonnull DBRpcTask<DBUSERSUserFeaturesGetValuesBatchResult *,
                     DBUSERSUserFeaturesGetValuesBatchError *> *)
    featuresGetValues:(nonnull NSArray<DBUSERSUserFeature *> *)features;

Swift

func featuresGetValues(_ features: [DBUSERSUserFeature]) -> DBRpcTask<DBUSERSUserFeaturesGetValuesBatchResult, DBUSERSUserFeaturesGetValuesBatchError>

Parameters


                                features

A list of features in UserFeature. If the list is empty, this route will return UserFeaturesGetValuesBatchError.

Return Value

Through the response callback, the caller will receive a DBUSERSUserFeaturesGetValuesBatchResult object on success or a DBUSERSUserFeaturesGetValuesBatchError object on failure.


                    
                    
                    -getAccount:

Get information about a user’s account.

Declaration

Objective-C

- (nonnull DBRpcTask<DBUSERSBasicAccount *, DBUSERSGetAccountError *> *)
    getAccount:(nonnull NSString *)accountId;

Swift

func getAccount(_ accountId: String) -> DBRpcTask<DBUSERSBasicAccount, DBUSERSGetAccountError>

Parameters


                                accountId

A user’s account identifier.

Return Value

Through the response callback, the caller will receive a DBUSERSBasicAccount object on success or a DBUSERSGetAccountError object on failure.


                    
                    
                    -getAccountBatch:

Get information about multiple user accounts. At most 300 accounts may be queried per request.

Declaration

Objective-C

- (nonnull DBRpcTask<NSArray<DBUSERSBasicAccount *> *,
                     DBUSERSGetAccountBatchError *> *)getAccountBatch:
    (nonnull NSArray<NSString *> *)accountIds;

Swift

func getAccountBatch(_ accountIds: [String]) -> DBRpcTask<NSArray, DBUSERSGetAccountBatchError>

Parameters


                                accountIds

List of user account identifiers. Should not contain any duplicate account IDs.

Return Value

Through the response callback, the caller will receive a NSArray<DBUSERSBasicAccount *> object on success or a DBUSERSGetAccountBatchError object on failure.

-getCurrentAccount
Get information about the current user’s account.
Declaration
Objective-C

- (nonnull DBRpcTask<DBUSERSFullAccount *, DBNilObject *> *)getCurrentAccount;
Swift

func getCurrentAccount() -> DBRpcTask<DBUSERSFullAccount, DBNilObject>
Return Value

Through the response callback, the caller will receive a DBUSERSFullAccount object on success or a void object on failure.
-getSpaceUsage
Get the space usage information for the current user’s account.
Declaration
Objective-C

- (nonnull DBRpcTask<DBUSERSSpaceUsage *, DBNilObject *> *)getSpaceUsage;
Swift

func getSpaceUsage() -> DBRpcTask<DBUSERSSpaceUsage, DBNilObject>
Return Value

Through the response callback, the caller will receive a DBUSERSSpaceUsage object on success or a void object on failure.