RMAAPIKeyAuth

Objective-C


@interface RLMAPIKeyAuth : RLMProviderClient

Swift

@_nonSendable(_assumed) class RLMAPIKeyAuth : RLMProviderClient, @unchecked Sendable

ユーザー API キーのプロバイダー クライアント。

  • 現在のユーザーとして認証するために使用できるユーザー API キーを作成します。

    宣言

    Objective-C

    - (void)createAPIKeyWithName:(nonnull NSString *)name
                      completion:(nonnull RLMOptionalUserAPIKeyBlock)completion;

    Swift

    func createAPIKey(named name: String) async throws -> RLMUserAPIKey

    パラメーター

    name

    作成する API キーの名前。

    completion

    呼び出しが完了したときに呼び出されるコールバック。

  • 現在のユーザーに関連付けられているユーザー API キーを取得します。

    宣言

    Objective-C

    - (void)fetchAPIKey:(nonnull RLMObjectId *)objectId
             completion:(nonnull RLMOptionalUserAPIKeyBlock)completion;

    Swift

    func fetchAPIKey(_ objectId: RLMObjectId) async throws -> RLMUserAPIKey

    パラメーター

    objectId

    取得する API キーの ObjectId 。

    completion

    呼び出しが完了したときに呼び出されるコールバック。

  • 現在のユーザーに関連付けられているユーザー API キーを取得します。

    宣言

    Objective-C

    - (void)fetchAPIKeysWithCompletion:(nonnull RLMUserAPIKeysBlock)completion;

    Swift

    func fetchAPIKeys() async throws -> [RLMUserAPIKey]

    パラメーター

    completion

    呼び出しが完了したときに呼び出されるコールバック。

  • 現在のユーザーに関連付けられているユーザー API キーを削除します。

    宣言

    Objective-C

    - (void)deleteAPIKey:(nonnull RLMObjectId *)objectId
              completion:(nonnull RLMAPIKeyAuthOptionalErrorBlock)completion;

    Swift

    func deleteAPIKey(_ objectId: RLMObjectId) async throws

    パラメーター

    objectId

    削除する API キーの ObjectId 。

    completion

    呼び出しが完了したときに呼び出されるコールバック。

  • 現在のユーザーに関連付けられているユーザー API キーを有効にします。

    宣言

    Objective-C

    - (void)enableAPIKey:(nonnull RLMObjectId *)objectId
              completion:(nonnull RLMAPIKeyAuthOptionalErrorBlock)completion;

    Swift

    func enableAPIKey(_ objectId: RLMObjectId) async throws

    パラメーター

    objectId

    有効にする API キーの ObjectId 。

    completion

    呼び出しが完了したときに呼び出されるコールバック。

  • 現在のユーザーに関連付けられているユーザー API キーを無効にします。

    宣言

    Objective-C

    - (void)disableAPIKey:(nonnull RLMObjectId *)objectId
               completion:(nonnull RLMAPIKeyAuthOptionalErrorBlock)completion;

    Swift

    func disableAPIKey(_ objectId: RLMObjectId) async throws

    パラメーター

    objectId

    無効にする API キーの ObjectId 。

    completion

    呼び出しが完了したときに呼び出されるコールバック。