UsersRoutes

open class UsersRoutes

Routes for the users namespace

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

    Declaration

    Swift

    @discardableResult
    open func featuresGetValues(features: Array<Users.UserFeature>) -> RpcRequest<Users.UserFeaturesGetValuesBatchResultSerializer, Users.UserFeaturesGetValuesBatchErrorSerializer>

    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 Users.UserFeaturesGetValuesBatchResult object on success or a Users.UserFeaturesGetValuesBatchError object on failure.

  • Get information about a user’s account.

    Declaration

    Swift

    @discardableResult
    open func getAccount(accountId: String) -> RpcRequest<Users.BasicAccountSerializer, Users.GetAccountErrorSerializer>

    Parameters

    accountId

    A user’s account identifier.

    Return Value

    Through the response callback, the caller will receive a Users.BasicAccount object on success or a Users.GetAccountError object on failure.

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

    Declaration

    Swift

    @discardableResult
    open func getAccountBatch(accountIds: Array<String>) -> RpcRequest<ArraySerializer<Users.BasicAccountSerializer>, Users.GetAccountBatchErrorSerializer>

    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 Array<Users.BasicAccount> object on success or a Users.GetAccountBatchError object on failure.

  • Get information about the current user’s account.

    Declaration

    Swift

    @discardableResult
    open func getCurrentAccount() -> RpcRequest<Users.FullAccountSerializer, VoidSerializer>

    Return Value

    Through the response callback, the caller will receive a Users.FullAccount object on success or a Void object on failure.

  • Get the space usage information for the current user’s account.

    Declaration

    Swift

    @discardableResult
    open func getSpaceUsage() -> RpcRequest<Users.SpaceUsageSerializer, VoidSerializer>

    Return Value

    Through the response callback, the caller will receive a Users.SpaceUsage object on success or a Void object on failure.