クラス ApiKey

ユーザーの API キーを表すクラス。 これは、通常の認証情報の代わりにログインするときにユーザーを表すために使用できます。 これらのキーは、 ApiKeysを通じて作成または取得されます。
API キーの値は、キーが作成されたときにのみ使用でき、その後は取得できません。 つまり、作成時に API キーの値を安全に保存するのは呼び出し元の責任です。

継承

オブジェクト

apiKey

名前空間: Realm 。同期

組み立て: Realm.dll

構文

public class ApiKey

プロパティ

id

このキーの一意の識別子を取得します。

宣言

[Preserve]
public ObjectId Id { get; }

プロパティ値

タイプ	説明
ObjectId	キーを一意に識別する ID。

IsEnabled

このキーが現在有効になっているかどうかを示す値を取得します。

宣言

[Preserve]
public bool IsEnabled { get; }

プロパティ値

タイプ	説明
ブール	true キーが有効になっている場合、それ以外の場合は、 false 。

名前

キーの名前を取得します。

宣言

[Preserve]
public string Name { get; }

プロパティ値

タイプ	説明
string	CreateAsync(string)を呼び出すときに指定される、キーのわかりやすい名前。

値

キーの値を取得します。 これは、キーが作成されたときにのみ返されます。 その後は常にnullになります。

宣言

[Preserve]
public string? Value { get; }

プロパティ値

タイプ	説明
string	ApiKey(string)の構築時に指定する必要があるキーの値。

メソッド

ToString()

値の string 表現を返します。

宣言

public override string ToString()

戻り値

タイプ	説明
string	値の string 表現。

の上書き

object.ToString()

その他の参照

APIキー認証Docs