クラス認証情報

ユーザーの認証に使用される認証情報を表す クラス 。

継承

オブジェクト

Credentials

名前空間: Realm 。同期

組み立て: Realm.dll

構文

public class Credentials

プロパティ

プロバイダー

これらの認証情報がどのCredentials.AuthProviderを使用しているかを示す値を取得します。

宣言

[Preserve]
public Credentials.AuthProvider Provider { get; }

プロパティ値

タイプ	説明
認証情報。 AuthProvider	これらの認証情報が使用するCredentials.AuthProvider 。

メソッド

匿名(ブール値)

匿名ユーザーを表す認証情報を作成します。

宣言

public static Credentials Anonymous(bool reuseExisting = true)

パラメーター

タイプ	名前	説明
ブール	再利用:Existing	匿名ユーザーを再利用するかどうかを示す値。 trueを渡すと、ユーザーがログアウトしていない限り、 app.LoginAsync(Credentials.Anonymous())を複数回呼び出した場合に同じ匿名ユーザーが返されます。 reuseExistingがfalseの場合、 LogInAsync(Credentials)を呼び出すたびに、サーバー上に新しいユーザーが作成されます。

戻り値

タイプ	説明
Credentials	匿名ユーザーを認証するために使用できる資格情報。

その他の参照

匿名認証Docs

ApiKey(string)

クライアント SDK によって生成された API キーを使用して、ログインを表す認証情報を作成します。

宣言

public static Credentials ApiKey(string key)

パラメーター

タイプ	名前	説明
string	キー	ログインに使用する API キー。

戻り値

タイプ	説明
Credentials	API キーでユーザーを認証するために使用できる 認証情報 。

その他の参照

APIキー認証Docs

Apple(string)

Apple ID アクセス トークンを使用して、ログインを表す認証情報を作成します。

宣言

public static Credentials Apple(string accessToken)

パラメーター

タイプ	名前	説明
string	accessToken	ユーザーの Apple ID を表す OAuth 2.0 アクセス トークン。

戻り値

タイプ	説明
Credentials	Apple ID 経由でユーザーを認証するために使用できる 認証情報 。

その他の参照

Apple ID認証Docs

EmailPassword(string, string)

メールとパスワードを使用して、ログインを表す認証情報を作成します。

宣言

public static Credentials EmailPassword(string email, string password)

パラメーター

タイプ	名前	説明
string	メールアドレス	ユーザーのメール。
string	パスワード	ユーザーのパスワード。

戻り値

タイプ	説明
Credentials	メールとパスワードを使用してユーザーを認証するために使用できる 認証情報 。

コメント

ユーザーは、アカウントを登録し、メールを確認した後にのみ、メールとパスワードを使用してログインできます。 SDK 経由でメール/パスワードユーザーを登録するには、 RegisterUserAsync(string, string)を使用します。 SDK からのメールを検証するには、 ConfirmUserAsync(string, string)を使用します。 また、メール/パスワード プロバイダーは、ユーザーを自動的に確認したり、ユーザー登録時にカスタム確認機能を実行したりするように構成できます。

その他の参照

メール/パスワード認証Docs

Facebook(string)

Facebook アクセス トークンを使用して、ログインを表す認証情報を作成します。

宣言

public static Credentials Facebook(string accessToken)

パラメーター

タイプ	名前	説明
string	accessToken	Facebook ユーザーを表す OAuth 2.0 アクセス トークン。

戻り値

タイプ	説明
Credentials	Facebook でユーザーを認証するために使用できる 認証情報 。

その他の参照

Facebook認証Docs

Function(object)

Realm 関数を使用してログインを表す認証情報を作成します。

宣言

public static Credentials Function(object payload)

パラメーター

タイプ	名前	説明
オブジェクト	ペイロード	サーバー関数への引数として渡されるペイロード。

戻り値

タイプ	説明
Credentials	サーバー関数を呼び出すことでユーザーを認証するために使用できる 認証情報 。

コメント

Realm 関数を呼び出すときに、ペイロード オブジェクトはシリアル化され、解析されます。 つまり、関数への参照や循環オブジェクト グラフなど、シリアル化できない値は機能しません。 さらに、フィールド/プロパティの名前は、関数に期待される名前と完全に一致する必要があります。

その他の参照

カスタム機能認証Docs

Google(string, GoogleCredentialType)

Google アカウントを使用して、ログインを表す認証情報を作成します。

宣言

public static Credentials Google(string credential, GoogleCredentialType type)

パラメーター

タイプ	名前	説明
string	Credentials	Google ユーザーを表す認証情報。
GoogleCredentialType	タイプ	認証情報のタイプ。

戻り値

タイプ	説明
Credentials	Google でユーザーを認証するために使用できる認証情報。

その他の参照

Google 認証Docs

JSON web token （ string ）

JSON web tokenトークンを使用してログインを表す認証情報を作成します。

宣言

public static Credentials JWT(string customToken)

パラメーター

タイプ	名前	説明
string	customToken	ユーザーを表すカスタムJSON web tokenトークン。

戻り値

タイプ	説明
Credentials	カスタムJSON web tokenトークンを使用してユーザーを認証するために使用できる認証情報。

その他の参照

カスタムJSON web token認証Docs

ServerApiKey(string)

サーバー UI で生成されたAPIキーを使用して、ログインを表す認証情報を作成します。

宣言

[Obsolete("Use Credentials.ApiKey instead.")]
public static Credentials ServerApiKey(string serverApiKey)

パラメーター

タイプ	名前	説明
string	serverApiKey	ログインに使用するサーバー API キー。

戻り値

タイプ	説明
Credentials	API キーでユーザーを認証するために使用できる 認証情報 。

その他の参照

APIキー認証Docs