クラス ユーザー.ApiKeyClient

ユーザーがクライアントから API キーを管理するための機能を公開するクラス。 スコープは常に特定のユーザーに限定され、 ApiKeys経由でのみアクセスできます。

継承
オブジェクト
ユーザー.ApiKeyClient
名前空間: Realm 。同期
組み立て: Realm.dll
構文
public class User.ApiKeyClient

メソッド

| このページを編集 ソースを表示

CreateAsync(string)

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

宣言
public Task<ApiKey> CreateAsync(string name)
パラメーター
タイプ 名前 説明
string name

キーのサポート名。
戻り値
タイプ 説明
Task < ApiKey >

非同期操作を表す待機可能なTask<TResult> 。 正常に完了した場合は、 ApiKeyがサーバー上に作成され、その値を使用してApiKey(string)を作成できることを示します。
コメント

返された API キーの値は、表示される唯一の時間であるため、この時点で永続化する必要があります。 キーは作成時に有効になっています。 DisableAsync(ObjectId)を呼び出すことで無効にすることができます。

| このページを編集 ソースを表示

DeleteAsync(ObjectId)

ID で API キーを削除します。

宣言
public Task DeleteAsync(ObjectId id)
パラメーター
タイプ 名前 説明
ObjectId id

削除するキーの ID。
戻り値
タイプ 説明
タスク

非同期削除操作を表す待機可能なタスク。
| このページを編集 ソースを表示

DisableAsync(ObjectId)

ID で API キーを無効にします。

宣言
public Task DisableAsync(ObjectId id)
パラメーター
タイプ 名前 説明
ObjectId id

無効にするキーの ID。
戻り値
タイプ 説明
タスク

非同期無効操作を表す 待機可能なタスク。
その他の参照
| このページを編集 ソースを表示

enableAsync(ObjectId)

ID で API キーを有効にします。

宣言
public Task EnableAsync(ObjectId id)
パラメーター
タイプ 名前 説明
ObjectId id

有効にするキーの ID。
戻り値
タイプ 説明
タスク

非同期有効操作を表す待機可能なタスク。
その他の参照
| このページを編集 ソースを表示

FetchAllAsync()

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

宣言
public Task<IEnumerable<ApiKey>> FetchAllAsync()
戻り値
タイプ 説明
Task < IEnumerable < ApiKey >

非同期検索操作を表す待機可能なタスク。 完了すると、結果にはそのユーザーのすべての API キーのコレクションが含まれます。
| このページを編集 ソースを表示

FetchAsync(ObjectId)

ID で特定のユーザー API キーを取得します。

宣言
public Task<ApiKey?> FetchAsync(ObjectId id)
パラメーター
タイプ 名前 説明
ObjectId id

取得するキーの ID。
戻り値
タイプ 説明
Task < ApiKey >

非同期検索操作を表す待機可能なTask<TResult> 。