Objective-C
@interface RLMApp : NSObject
Swift
@_nonSendable(_assumed) class RLMApp : NSObject, @unchecked Sendable
The RLMApp
has the fundamental set of methods for communicating with a Realm application backend.
This interface provides access to login and authentication.
The configuration for this Realm app.
Get a dictionary containing all users keyed on id.
DeclarationObjective-C
@property (nonatomic, readonly) NSDictionary<NSString *, RLMUser *> *_Nonnull allUsers;
Swift
var allUsers: [String : RLMUser] { get }
Get the current user logged into the Realm app.
DeclarationObjective-C
@property (nonatomic, readonly, nullable) RLMUser *currentUser;
Swift
var currentUser: RLMUser? { get }
The app ID for this Realm app.
DeclarationObjective-C
@property (nonatomic, readonly) NSString *_Nonnull appId;
Swift
var appId: String { get }
A client for the email/password authentication provider which can be used to obtain a credential for logging in.
Used to perform requests specifically related to the email/password provider.
Get an application with a given appId and configuration.
DeclarationObjective-C
+ (nonnull instancetype)appWithId:(nonnull NSString *)appId;
Swift
convenience init(id appId: String)
Parameters appId
The unique identifier of your Realm app.
Get an application with a given appId and configuration.
DeclarationObjective-C
+ (nonnull instancetype)appWithId:(nonnull NSString *)appId
configuration:(nullable RLMAppConfiguration *)configuration;
Parameters appId
The unique identifier of your Realm app.
configuration
A configuration object to configure this client.
Login to a user for the Realm app.
Parameters credentials
The credentials identifying the user.
completion
A callback invoked after completion.
Switches the active user to the specified user.
This sets which user is used by all RLMApp operations which require a user. This is a local operation which does not access the network. An exception will be throw if the user is not valid. The current user will remain logged in.
DeclarationObjective-C
- (nonnull RLMUser *)switchToUser:(nonnull RLMUser *)syncUser;
Parameters syncUser
The user to switch to. @returns The user you intend to switch to
A client which can be used to register devices with the server to receive push notificatons
DeclarationObjective-C
- (nonnull RLMPushClient *)pushClientWithServiceName:
(nonnull NSString *)serviceName;
Unavailable
Use +appWithId or appWithId:configuration:.
RLMApp instances are cached internally by Realm and cannot be created directly.
Use +[RLMRealm appWithId]
or +[RLMRealm appWithId:configuration:]
to obtain a reference to an RLMApp.
Objective-C
- (nonnull instancetype)init;
Unavailable
Use +appWithId or appWithId:configuration:.
RLMApp instances are cached internally by Realm and cannot be created directly.
Use +[RLMRealm appWithId]
or +[RLMRealm appWithId:configuration:]
to obtain a reference to an RLMApp.
Objective-C
+ (nonnull instancetype)new;
Use this delegate to be provided a callback once authentication has succeed or failed.
DeclarationObjective-C
@property (nonatomic, weak, nullable) id<RLMASLoginDelegate> authorizationDelegate;
Sets the ASAuthorizationControllerDelegate to be handled by RLMApp
Objective-C
- (void)setASAuthorizationControllerDelegateForController:
(nonnull ASAuthorizationController *)controller;
Parameters controller
The ASAuthorizationController in which you want RLMApp
to consume its delegate.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4