类凭证

一个类，表示用于对User进行身份验证的凭证。

继承

对象

凭证

命名空间： Realm 。 Sync

程序集：Realm.dll

语法

public class Credentials

属性

提供商

获取一个值，该值指示这些凭证正在使用哪个Credentials.AuthProvider 。

声明

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

属性值

类型	说明
凭证。 AuthProvider	这些凭证使用的Credentials.AuthProvider 。

方法

Anonymous(bool)

创建代表匿名用户的档案。

声明

public static Credentials Anonymous(bool reuseExisting = true)

参数

类型	名称	说明
bool	reuseExisting	指示是否应重复使用匿名用户的值。 传递true意味着只要该用户未注销，对app.LoginAsync(Credentials.Anonymous())的多次调用都会返回同一匿名用户。 如果reuseExisting为false ，则每次调用LogInAsync(Credentials)时，都会在服务器上创建一个新用户。

返回：

类型	说明
凭证	A 可用于对匿名用户进行身份验证的凭证。

另请参阅

匿名身份验证文档

ApiKey(string)

使用客户端 SDK 生成的 API 密钥创建表示登录的凭证。

声明

public static Credentials ApiKey(string key)

参数

类型	名称	说明
字符串	key	用于登录的 API 密钥。

返回：

类型	说明
凭证	可用于通过 API 密钥对用户进行身份验证的凭证。

另请参阅

API 密钥身份验证文档

Apple(string)

使用 Apple ID 访问令牌创建表示登录的凭证。

声明

public static Credentials Apple(string accessToken)

参数

类型	名称	说明
字符串	访问令牌	代表用户 Apple ID 的 OAuth 2.0 访问令牌。

返回：

类型	说明
凭证	可用于通过 Apple ID 对用户进行身份验证的凭据。

另请参阅

Apple ID 身份验证文档

EmailPassword(string, string)

使用电子邮件和密码创建表示登录的凭证。

声明

public static Credentials EmailPassword(string email, string password)

参数

类型	名称	说明
字符串	电子邮件	用户的电子邮件。
字符串	密码	用户的密码。

返回：

类型	说明
凭证	A 凭证，可用于通过电子邮件和密码对用户进行身份验证。

备注

用户只有在注册帐户并验证电子邮件后才能使用电子邮件和密码登录。 要通过 SDK 注册电子邮件/密码用户，请使用RegisterUserAsync(string, string) 。 若要验证来自 SDK 的电子邮件，请使用ConfirmUserAsync(string, string) 。 电子邮件/密码提供商还可以配置为自动确认用户或在用户注册时运行自定义确认功能。

另请参阅

电子邮件/密码身份验证Docs

Facebook(string)

使用 Facebook 访问令牌创建表示登录的档案。

声明

public static Credentials Facebook(string accessToken)

参数

类型	名称	说明
字符串	访问令牌	代表 Facebook 用户的 OAuth 2.0 访问令牌。

返回：

类型	说明
凭证	可用于通过 Facebook 对用户进行身份验证的凭证。

另请参阅

Facebook 身份验证 Docs

函数（对象）

使用 Realm 函数创建表示登录的档案。

声明

public static Credentials Function(object payload)

参数

类型	名称	说明
对象	有效负载	将作为参数传递给服务器函数的有效负载。

返回：

类型	说明
凭证	可用于通过调用服务器功能对用户进行身份验证的凭证。

备注

调用 Realm 函数时，将序列化和解析有效负载对象。 这意味着不可序列化的值（例如对函数或循环对象图的引用）将不起作用。 此外，字段/属性的名称必须与函数期望的名称完全匹配。

另请参阅

自定义函数身份验证Docs

Google(string, GoogleCredentialType)

创建代表使用 Google 帐户登录的凭证。

声明

public static Credentials Google(string credential, GoogleCredentialType type)

参数

类型	名称	说明
字符串	凭证	代表 Google 用户的档案。
GoogleCredentialType	类型	凭证的类型。

返回：

类型	说明
凭证	可用于通过 Google 对用户进行身份验证的凭证。

另请参阅

Google 身份验证 Docs

JSON web token(string)

使用 JSON web token 令牌创建表示登录的凭证。

声明

public static Credentials JWT(string customToken)

参数

类型	名称	说明
字符串	customToken	代表用户的自定义 JSON web token 令牌。

返回：

类型	说明
凭证	可用于使用自定义 JWT 令牌对用户进行身份验证的凭证。

另请参阅

自定义 JSON web token 身份验证 Docs

ServerApiKey(string)

使用服务器用户界面中生成的 API 密钥创建表示登录的档案。

声明

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

参数

类型	名称	说明
字符串	serverApiKey	用于登录的服务器 API 密钥。

返回：

类型	说明
凭证	可用于通过 API 密钥对用户进行身份验证的凭证。

另请参阅

API 密钥身份验证文档