RLMSyncUser

@interface RLMSyncUser : NSObject

A RLMSyncUser instance represents a single Realm App user account.

A user may have one or more credentials associated with it. These credentials uniquely identify the user to the authentication provider, and are used to sign into a MongoDB Realm user account.

Note that user objects are only vended out via SDK APIs, and cannot be directly initialized. User objects can be accessed from any thread.

  • The unique MongoDB Realm user ID string identifying this user.

    Declaration

    Objective-C

    @property (readonly, nonatomic, nullable) NSString *identity;
    Show on GitHub

  • Returns an array of identities currently linked to a user.

    Declaration

    Objective-C

    - (nonnull NSArray<RLMSyncUserIdentity *> *)identities;
    Show on GitHub

  • The user’s refresh token used to access the Realm Applcation.

    This is required to make HTTP requests to the Realm App’s REST API for functionality not exposed natively. It should be treated as sensitive data.

    Declaration

    Objective-C

    @property (readonly, nonatomic, nullable) NSString *refreshToken;
    Show on GitHub

  • The user’s refresh token used to access the Realm Application.

    This is required to make HTTP requests to MongoDB Realm’s REST API for functionality not exposed natively. It should be treated as sensitive data.

    Declaration

    Objective-C

    @property (readonly, nonatomic, nullable) NSString *accessToken;
    Show on GitHub

  • The current state of the user.

    Declaration

    Objective-C

    @property (readonly, nonatomic) RLMSyncUserState state;
    Show on GitHub

Lifecycle

  • Create a query-based configuration instance for the given url.

    Declaration

    Objective-C

    - (nonnull RLMRealmConfiguration *)configurationWithPartitionValue:
    (nonnull id<RLMBSON>)partitionValue;

    Parameters

    partitionValue

    FIXME

    Return Value

    A default configuration object with the sync configuration set to use the given partition value.

    Show on GitHub

Sessions

Custom Data