RLMSyncUser Class Reference

+allUsers
A dictionary of all valid, logged-in user identities corresponding to their user objects.
Declaration
Objective-C

+ (nonnull NSDictionary<NSString *, RLMSyncUser *> *)allUsers;
Swift

class func __allUsers() -> [String : RLMSyncUser]
Show on GitHub
+currentUser
The logged-in user. nil if none exists.

Warning
Throws an exception if more than one logged-in user exists.
Declaration
Objective-C

+ (nullable RLMSyncUser *)currentUser;
Swift

class func __current() -> RLMSyncUser?
Show on GitHub
identity
The unique Realm Object Server user ID string identifying this user.
Declaration
Objective-C

@property (readonly, nonatomic, nullable) NSString *identity;
Swift

var identity: String? { get }
Show on GitHub
authenticationServer
The URL of the authentication server this user will communicate with.
Declaration
Objective-C

@property (readonly, nonatomic, nullable) NSURL *authenticationServer;
Swift

var authenticationServer: URL? { get }
Show on GitHub
isAdmin
Whether the user is a Realm Object Server administrator. Value reflects the state at the time of the last successful login of this user.
Declaration
Objective-C

@property (readonly, nonatomic) BOOL isAdmin;
Swift

var isAdmin: Bool { get }
Show on GitHub


                    
                    
                    state

The current state of the user.

Declaration

Objective-C

@property (readonly, nonatomic) RLMSyncUserState state;

Swift

var state: RLMSyncUserState { get }

Show on GitHub

Lifecycle


                    
                    
                    +logInWithCredentials:authServerURL:timeout:onCompletion:

Create, log in, and asynchronously return a new user object, specifying a custom timeout for the network request. Credentials identifying the user must be passed in. The user becomes available in the completion block, at which point it is ready for use.

Declaration

Objective-C

+ (void)logInWithCredentials:(nonnull RLMSyncCredentials *)credentials
               authServerURL:(nonnull NSURL *)authServerURL
                     timeout:(NSTimeInterval)timeout
                onCompletion:(nonnull RLMUserCompletionBlock)completion;

Swift

class func __logIn(with credentials: RLMSyncCredentials, authServerURL: URL, timeout: TimeInterval, onCompletion completion: @escaping RLMUserCompletionBlock)

Show on GitHub

+logInWithCredentials:authServerURL:onCompletion:
Create, log in, and asynchronously return a new user object. Credentials identifying the user must be passed in. The user becomes available in the completion block, at which point it is ready for use.
Declaration
Objective-C

+ (void)logInWithCredentials:(nonnull RLMSyncCredentials *)credentials authServerURL:(nonnull NSURL *)authServerURL onCompletion:(nonnull RLMUserCompletionBlock)completion;
Show on GitHub
-logOut
Log a user out, destroying their server state, unregistering them from the SDK, and removing any synced Realms associated with them from on-disk storage on next app launch. If the user is already logged out or in an error state, this method does nothing.

This method should be called whenever the application is committed to not using a user again unless they are recreated. Failing to call this method may result in unused files and metadata needlessly taking up space.
Declaration
Objective-C

- (void)logOut;
Swift

func logOut()
Show on GitHub
errorHandler
An optional error handler which can be set to notify the host application when the user encounters an error. Errors reported by this error handler are always RLMSyncAuthErrors.

Note

Check for RLMSyncAuthErrorInvalidAccessToken to see if the user has been remotely logged out because its refresh token expired, or because the third party authentication service providing the user’s identity has logged the user out.

Warning

Regardless of whether an error handler is defined, certain user errors will automatically cause the user to enter the logged out state.
Declaration
Objective-C

@property (assign, readwrite, nonatomic, nullable) RLMUserErrorReportingBlock errorHandler;
Swift

var __errorHandler: RLMUserErrorReportingBlock? { get set }
Show on GitHub

Sessions

-sessionForURL:
Retrieve a valid session object belonging to this user for a given URL, or nil if no such object exists.
Declaration
Objective-C

- (nullable RLMSyncSession *)sessionForURL:(nonnull NSURL *)url;
Swift

func session(for url: URL) -> RLMSyncSession?
Show on GitHub
-allSessions
Retrieve all the valid sessions belonging to this user.
Declaration
Objective-C

- (nonnull NSArray<RLMSyncSession *> *)allSessions;
Swift

func allSessions() -> [RLMSyncSession]
Show on GitHub

Passwords


                    
                    
                    -changePassword:completion:

Change this user’s password asynchronously.

Warning

Changing a user’s password using an authentication server that doesn’t use HTTPS is a major security flaw, and should only be done while testing.

Declaration

Objective-C

- (void)changePassword:(nonnull NSString *)newPassword
            completion:(nonnull RLMPasswordChangeStatusBlock)completion;

Swift

func changePassword(_ newPassword: String, completion: @escaping RLMPasswordChangeStatusBlock)

Parameters

`newPassword`	The user’s new password.
`completion`	Completion block invoked when login has completed or failed. The callback will be invoked on a background queue provided by `NSURLSession`.

Show on GitHub


                    
                    
                    -changePassword:forUserID:completion:

Change an arbitrary user’s password asynchronously.

Note

The current user must be an admin user for this operation to succeed.

Warning

Changing a user’s password using an authentication server that doesn’t use HTTPS is a major security flaw, and should only be done while testing.

Declaration

Objective-C

- (void)changePassword:(nonnull NSString *)newPassword
             forUserID:(nonnull NSString *)userID
            completion:(nonnull RLMPasswordChangeStatusBlock)completion;

Swift

func changePassword(_ newPassword: String, forUserID userID: String, completion: @escaping RLMPasswordChangeStatusBlock)

Parameters

`newPassword`	The user’s new password.
`userID`	The identity of the user whose password should be changed.
`completion`	Completion block invoked when login has completed or failed. The callback will be invoked on a background queue provided by `NSURLSession`.

Show on GitHub

Administrator API


                    
                    
                    -retrieveInfoForUser:identityProvider:completion:

Given a Realm Object Server authentication provider and a provider identifier for a user (for example, a username), look up and return user information for that user.

Declaration

Objective-C

- (void)retrieveInfoForUser:(nonnull NSString *)providerUserIdentity
           identityProvider:(nonnull RLMIdentityProvider)provider
                 completion:(nonnull RLMRetrieveUserBlock)completion;

Swift

func retrieveInfo(forUser providerUserIdentity: String, identityProvider provider: RLMIdentityProvider, completion: @escaping RLMRetrieveUserBlock)

Parameters

`providerUserIdentity`	The username or identity of the user as issued by the authentication provider. In most cases this is different from the Realm Object Server-issued identity.
`provider`	The authentication provider that manages the user whose information is desired.
`completion`	Completion block invoked when request has completed or failed. The callback will be invoked on a background queue provided by `NSURLSession`.

Show on GitHub

Value-based Permissions API

-retrievePermissionsWithCallback:
Asynchronously retrieve all permissions associated with the user calling this method.

The results will be returned through the callback block, or an error if the operation failed. The callback block will be run on the same thread the method was called on.

Warning

This method must be called from a thread with a currently active run loop. Unless you have manually configured a run loop on a side thread, this will usually be the main thread.

See

RLMSyncPermissionResults
Declaration
Objective-C

- (void)retrievePermissionsWithCallback: (nonnull RLMPermissionResultsBlock)callback;
Swift

func retrievePermissions(callback: @escaping RLMPermissionResultsBlock)
Show on GitHub
-applyPermission:callback:
Apply a given permission.

The operation will take place asynchronously, and the callback will be used to report whether the permission change succeeded or failed. The user calling this method must have the right to grant the given permission, or else the operation will fail.

See
RLMSyncPermissionValue
Declaration
Objective-C

- (void)applyPermission:(nonnull RLMSyncPermissionValue *)permission callback:(nonnull RLMPermissionStatusBlock)callback;
Swift

func applyPermission(_ permission: RLMSyncPermissionValue, callback: @escaping RLMPermissionStatusBlock)
Show on GitHub
-revokePermission:callback:
Revoke a given permission.

The operation will take place asynchronously, and the callback will be used to report whether the permission change succeeded or failed. The user calling this method must have the right to grant the given permission, or else the operation will fail.

See
RLMSyncPermissionValue
Declaration
Objective-C

- (void)revokePermission:(nonnull RLMSyncPermissionValue *)permission callback:(nonnull RLMPermissionStatusBlock)callback;
Swift

func revokePermission(_ permission: RLMSyncPermissionValue, callback: @escaping RLMPermissionStatusBlock)
Show on GitHub

Realm Object-based Permissions API

-managementRealmWithError:
Returns an instance of the Management Realm owned by the user.

This Realm can be used to control access permissions for Realms managed by the user. This includes granting other users access to Realms.
Declaration
Objective-C

- (nonnull RLMRealm *)managementRealmWithError: (NSError *_Nullable *_Nullable)error;
Swift

func __managementRealmWithError(_ error: NSErrorPointer) -> RLMRealm
Show on GitHub
-permissionRealmWithError:
Returns an instance of the Permission Realm owned by the user.

This read-only Realm contains RLMSyncPermission objects reflecting the synchronized Realms and permission details this user has access to.
Declaration
Objective-C

- (nonnull RLMRealm *)permissionRealmWithError: (NSError *_Nullable *_Nullable)error;
Swift

func __permissionRealmWithError(_ error: NSErrorPointer) -> RLMRealm
Show on GitHub