RLMApp

Objective-C


@interface RLMApp : NSObject

Swift

@_nonSendable(_assumed) class RLMApp : NSObject, @unchecked Sendable

RLMApp具有与 Realm 应用程序后端通信的一组基本方法。

此接口提供对登录和身份验证的访问。

  • 此Realm应用的配置。

    声明

    Objective-C

    @property (nonatomic, readonly) RLMAppConfiguration *_Nonnull configuration;

    Swift

    var configuration: RLMAppConfiguration { get }
  • 此Realm应用的RLMSyncManager

    声明

    Objective-C

    @property (nonatomic, readonly) RLMSyncManager *_Nonnull syncManager;

    Swift

    var syncManager: RLMSyncManager { get }
  • 获取包含以ID为键控的所有用户的字典。

    声明

    Objective-C

    @property (nonatomic, readonly) NSDictionary<NSString *, RLMUser *> *_Nonnull allUsers;

    Swift

    var allUsers: [String : RLMUser] { get }
  • 获取登录到 Realm 应用的当前用户。

    声明

    Objective-C

    @property (nonatomic, readonly, nullable) RLMUser *currentUser;

    Swift

    var currentUser: RLMUser? { get }
  • 此Realm应用的应用ID 。

    声明

    Objective-C

    @property (nonatomic, readonly) NSString *_Nonnull appId;

    Swift

    var appId: String { get }
  • 电子邮件/密码身份验证提供程序的客户端,可用于获取登录档案。

    用于执行与电子邮件/密码提供商特别相关的请求。

    声明

    Objective-C

    @property (nonatomic, readonly) RLMEmailPasswordAuth *_Nonnull emailPasswordAuth;

    Swift

    var emailPasswordAuth: RLMEmailPasswordAuth { get }
  • 获取具有给定 appId 和配置的应用程序。

    声明

    Objective-C

    + (nonnull instancetype)appWithId:(nonnull NSString *)appId;

    Swift

    convenience init(id appId: String)

    参数

    appId

    Realm应用的唯一标识符。

  • 获取具有给定 appId 和配置的应用程序。

    声明

    Objective-C

    + (nonnull instancetype)appWithId:(nonnull NSString *)appId
                        configuration:(nullable RLMAppConfiguration *)configuration;

    Swift

    convenience init(id appId: String, configuration: RLMAppConfiguration?)

    参数

    appId

    Realm应用的唯一标识符。

    configuration

    用于配置此客户端的配置对象。

  • 登录 Realm 应用程序的用户。

    声明

    Objective-C

    - (void)loginWithCredential:(nonnull RLMCredentials *)credentials
                     completion:(nonnull RLMUserCompletionBlock)completion;

    参数

    credentials

    标识用户的凭证。

    completion

    完成后调用的回调。

  • 将活动用户切换为指定用户。

    这将设置所有需要用户的 RLMApp 操作使用哪个用户。 这是不访问权限网络的本地操作。 如果用户无效,则会引发异常。 当前用户将保持登录状态。

    声明

    Objective-C

    - (nonnull RLMUser *)switchToUser:(nonnull RLMUser *)syncUser;

    Swift

    func `switch`(to syncUser: RLMUser) -> RLMUser

    参数

    syncUser

    要切换到的用户。 @returns 要切换到的用户

  • 客户端,可用于向服务器注册设备以接收推送通知

    声明

    Objective-C

    - (nonnull RLMPushClient *)pushClientWithServiceName:
        (nonnull NSString *)serviceName;

    Swift

    func pushClient(serviceName: String) -> RLMPushClient
  • 不可用

    使用 +appWithId 或 appWithId:configuration:。

    RLMApp 实例由 Realm 内部缓存,无法直接创建。

    使用+[RLMRealm appWithId]+[RLMRealm appWithId:configuration:]获取对 RLMApp 的引用。

    声明

    Objective-C

    - (nonnull instancetype)init;
  • 不可用

    使用 +appWithId 或 appWithId:configuration:。

    RLMApp 实例由 Realm 内部缓存,无法直接创建。

    使用+[RLMRealm appWithId]+[RLMRealm appWithId:configuration:]获取对 RLMApp 的引用。

    声明

    Objective-C

    + (nonnull instancetype)new;

ASLogin