类身份验证子系统
用于处理与 Unity 身份验证系统连接的子系统。
包含
#include "AuthenticationSubsystem.h"语法
UCLASS()
class AUTHENTICATION_API UAuthenticationSubsystem : public UGameInstanceSubsystem构造函数
UAuthenticationSubsystem()
身份验证子系统的默认构造函数。
声明
UAuthenticationSubsystem()UAuthenticationSubsystem(FVTableHelper&)
用于前向声明的重写构造函数。
声明
UAuthenticationSubsystem(FVTableHelper& Helper)参数
| 名称 | 描述 |
|---|---|
| 助手 | 用于调用专用热重载构造函数的助手类。 |
析构函数
~UAuthenticationSubsystem()
身份验证子系统的默认析构函数。
声明
virtual ~UAuthenticationSubsystem()重写
Initialize(FSubsystemCollectionBase&)
从 USubsystem 重写初始化。
声明
virtual void Initialize(FSubsystemCollectionBase& Collection) overrideDeinitialize()
从 USubsystem 重写初始化。
声明
virtual void Deinitialize() overrideShouldCreateSubsystem(UObject*)
从 USubsystem 重写初始化。
声明
virtual bool ShouldCreateSubsystem(UObject* Outer) const override方法
SignInAnonymously(FAuthenticationSignInOptions, Unity::Services::Core::THandler<FAuthenticationResponse>)
以匿名方式登录当前用户。不需要凭据，会话仅限于当前设备。
声明
void SignInAnonymously(FAuthenticationSignInOptions Options, Unity::Services::Core::THandler<FAuthenticationResponse> ResponseHandler)参数
| 名称 | 类型 | 描述 |
|---|---|---|
选项 | FAuthenticationSignInOptions | 登录选项。 |
响应处理程序 | THandler<FAuthenticationResponse> | API 返回响应时执行的处理程序。 |
GetUserInfo(Unity::Services::Core::THandler<FAuthenticationUserResponse>)
返回当前玩家的玩家信息，例如帐户创建时间和链接的外部 ID。
声明
void GetUserInfo(Unity::Services::Core::THandler<FAuthenticationUserResponse> ResponseHandler)参数
| 名称 | 类型 | 描述 |
|---|---|---|
响应处理程序 | THandler<FAuthenticationUserResponse> | API 返回响应时执行的处理程序。 |
DeleteUser(Unity::Services::Core::THandler<bool>)
永久删除当前登录的用户。
声明
void DeleteUser(Unity::Services::Core::THandler<bool> ResponseHandler)参数
| 名称 | 类型 | 描述 |
|---|---|---|
响应处理程序 | THandler<bool> | API 返回响应时执行的处理程序。 |
RegisterStateChangedCallback(Unity::Services::Core::THandler<FAuthenticationStateChangedResponse>)
挂钩到身份验证状态更改时执行的委托。
声明
void RegisterStateChangedCallback(Unity::Services::Core::THandler<FAuthenticationStateChangedResponse> ResponseHandler)参数
| 名称 | 类型 | 描述 |
|---|---|---|
响应处理程序 | THandler<FAuthenticationStateChangedResponse> | 身份验证状态更改时执行的处理程序。 |
SignOut(bool)
在提供的配置文件名称下注销当前用户。
声明
bool SignOut(bool bClearCredentials = false)参数
| 名称 | 类型 | 描述 |
|---|---|---|
bClearCredentials | bool | 清除会话令牌的选项，该令牌允许登录到同一个帐户。 |
SwitchProfile(const FString&)
将当前配置文件切换到新的配置文件名称。如果在该名称下找不到配置文件，则会创建一个新的配置文件。
声明
void SwitchProfile(const FString& ProfileName) const参数
| 参数名称 | 参数类型 | 描述 |
|---|---|---|
ProfileName | FString | 要切换到的配置文件名称，或者如果它尚不存在，则添加它。 |
ProfileExists(const FString&)
检查配置文件是否存在。
声明
const bool ProfileExists(const FString& ProfileName) const参数
| 名称 | 类型 | 描述 |
|---|---|---|
ProfileName | FString | 要检查的配置文件名称。 |
返回
| 类型 | 描述 |
|---|---|
bool | 如果配置文件存在，则为真，否则为假。 |
GetCurrentProfileName()
返回当前配置文件的名称。
声明
const FString GetCurrentProfileName() const返回
| 类型 | 描述 |
|---|---|
| FString | 当前配置文件的名称。 |
GetProfileNames()
返回所有活动玩家配置文件名称。
声明
const TArray<FString> GetProfileNames() const返回
| 类型 | 描述 |
|---|---|
| TArray<FString> | 所有活动玩家配置文件名称。 |
RegisterProfileChangedCallback(Unity::Services::Core::THandler<FAuthenticationPlayerProfileChangedResponse>)
挂钩到玩家配置文件更改时执行的处理程序。
声明
void RegisterProfileChangedCallback(Unity::Services::Core::THandler<FAuthenticationPlayerProfileChangedResponse> ResponseHandler)参数
| 名称 | 类型 | 描述 |
|---|---|---|
响应处理程序 | THandler<FAuthenticationPlayerProfileChangedResponse> | 玩家配置文件更改时执行的处理程序。 |
RegisterProfileDeletedCallback(Unity::Services::Core::THandler<FAuthenticationPlayerProfileDeletedResponse> ResponseHandler)
挂钩到玩家配置文件被删除时执行的处理程序。
声明
void RegisterProfileDeletedCallback(Unity::Services::Core::THandler<FAuthenticationPlayerProfileDeletedResponse> ResponseHandler)参数
| 名称 | 类型 | 描述 |
|---|---|---|
响应处理程序 | THandler<FAuthenticationPlayerProfileDeletedResponse> | 玩家配置文件被删除时执行的处理程序。 |
IsSignedIn()
检查用户是否已登录。
A user can remain signed in but have an expired session.
声明
bool IsSignedIn() const返回
| 类型 | 描述 |
|---|---|
bool | 如果用户已登录，则为真，否则为假。 |
IsAnonymous()
检查用户是否以匿名方式登录。
声明
bool IsAnonymous() const返回
| 类型 | 描述 |
|---|---|
bool | 如果用户以匿名方式登录，则为真，否则为假。 |
IsAuthorized()
检查用户是否仍然获得授权。
A user is authorized as long as his access token remains valid.
声明
bool IsAuthorized() const返回
| 类型 | 描述 |
|---|---|
bool | 如果用户获得授权，则为真，否则为假。 |
IsExpired()
检查用户会话是否已过期。
声明
bool IsExpired() const返回
| 类型 | 描述 |
|---|---|
bool | 如果用户会话已过期，则为 true，否则为 false。 |
SessionTokenExists()
检查当前配置文件是否存储了现有会话令牌。
声明
bool SessionTokenExists() const返回
| 类型 | 描述 |
|---|---|
bool | 如果当前配置文件存储了现有会话令牌，则为 true。 |
GetUnityProjectId()
返回 Unity 项目 ID。
声明
const FGuid GetUnityProjectId() const返回
| 类型 | 描述 |
|---|---|
| FGuid | Unity 项目 ID。 |
GetUnityEnvironmentName()
返回 Unity 环境名称。
声明
const FString GetUnityEnvironmentName() const返回
| 类型 | 描述 |
|---|---|
| FString | Unity 环境名称。 |
GetAccessToken()
返回当前用户的访问令牌。
声明
FString GetAccessToken() const返回
| 类型 | 描述 |
|---|---|
| FString | 当前用户登录时的访问令牌字符串，否则为空字符串。 |
GetSessionToken()
返回当前用户的会话令牌。
声明
const const FString GetSessionToken() const返回
| 类型 | 描述 |
|---|---|
| FString | 当前用户登录时的会话令牌字符串，否则为空字符串。 |
GetUserId()
当前用户登录时的 ID。
声明
const FString GetUserId() const返回
| 类型 | 描述 |
|---|---|
| FString | 当前用户登录时的 ID，否则为空字符串。 |
GetState()
身份验证子系统的当前状态。
声明
const EAuthenticationStates GetState() const返回
| 类型 | 描述 |
|---|---|
| EAuthenticationStates | 身份验证子系统的当前状态。 |
SetUnityProjectId(FGuid)
设置 Unity 项目 ID。
声明
void SetUnityProjectId(FGuid Value)参数
| 名称 | 类型 | 描述 |
|---|---|---|
| Value | FGuid | 新的 Unity 项目 ID。 |
SetUnityEnvironmentName(FString)
设置 Unity 环境名称。
声明
void SetUnityEnvironmentName(FString Value)参数
| 名称 | 类型 | 描述 |
|---|---|---|
| Value | FString | 新的 Unity 环境 ID。 |