クラス Authentication サブシステム
Reference the Authentication Subsystem class for handling connections to Unity Authentication.
Unity Authentication システムへの接続を処理するためのサブシステム。
Include (含める)
#include "AuthenticationSubsystem.h"
構文
UCLASS()class AUTHENTICATION_API UAuthenticationSubsystem : public UGameInstanceSubsystem
コンストラクター
UAuthenticationSubsystem()
Authentication サブシステムのデフォルトコンストラクター。
宣言
UAuthenticationSubsystem()
UAuthenticationSubsystem(FVTableHelper&)
前方宣言のためのオーバーライドコンストラクター。
宣言
UAuthenticationSubsystem(FVTableHelper& Helper)
パラメーター
名前 | 説明 |
|---|
| Helper | 特別なホットリロードコンストラクターを呼び出すためのヘルパークラス。 |
デストラクター
UAuthenticationSubsystem()
Authentication サブシステムのデフォルトデストラクター。
宣言
virtual ~UAuthenticationSubsystem()
Override
Initialize(FSubsystemCollectionBase&)
USubsystem からオーバーライドを初期化します。
宣言
virtual void Initialize(FSubsystemCollectionBase& Collection) override
Deinitialize()
USubsystem からオーバーライドを初期化します。
宣言
virtual void Deinitialize() override
ShouldCreateSubsystem(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)
パラメーター
GetUserInfo(Unity::Services::Core::THandler<FAuthenticationUserResponse>)
現在のプレイヤーの情報を返します (アカウント作成日時やリンクされた外部 ID など)。
宣言
void GetUserInfo(Unity::Services::Core::THandler<FAuthenticationUserResponse> ResponseHandler)
パラメーター
DeleteUser(Unity::Services::Core::THandler<bool>)
現在サインインしているユーザーを完全に削除します。
宣言
void DeleteUser(Unity::Services::Core::THandler<bool> ResponseHandler)
パラメーター
RegisterStateChangedCallback(Unity::Services::Core::THandler<FAuthenticationStateChangedResponse>)
認証状態が変更された際に実行されるデリゲートにフックします。
宣言
void RegisterStateChangedCallback(Unity::Services::Core::THandler<FAuthenticationStateChangedResponse> ResponseHandler)
パラメーター
SignOut(bool)
指定されたプロファイル名で現在のユーザーをサインアウトします。
宣言
bool SignOut(bool bClearCredentials = false)
パラメーター
名前 | 型 | 説明 |
|---|
| | 同じアカウントへのログインを可能にするセッショントークンを消去するオプション。 |
SwitchProfile(const FString&)
現在のプロファイルを新しいプロファイル名に切り替えます。その名前のプロファイルが見つからなかった場合は、新しいプロファイルが作成されます。
宣言
void SwitchProfile(const FString& ProfileName) const
パラメーター
パラメーター名 | パラメーターの種類 | 説明 |
|---|
| FString | 切り替えるプロファイルの名前 (まだ存在しない場合は追加するプロファイルの名前)。 |
ProfileExists(const FString&)
プロファイルが存在するかどうかを確認します。
宣言
const bool ProfileExists(const FString& ProfileName) const
パラメーター
戻り値
型 | 説明 |
|---|
| プロファイルが存在する場合は true、存在しない場合は false。 |
GetCurrentProfileName()
現在のプロファイルの名前を返します。
宣言
const FString GetCurrentProfileName() const
戻り値
GetProfileNames()
すべてのアクティブなプレイヤープロファイルの名前を返します。
宣言
const TArray<FString> GetProfileNames() const
戻り値
RegisterProfileChangedCallback(Unity::Services::Core::THandler<FAuthenticationPlayerProfileChangedResponse>)
プレイヤープロファイルが変更された際に実行されるハンドラーにフックします。
宣言
void RegisterProfileChangedCallback(Unity::Services::Core::THandler<FAuthenticationPlayerProfileChangedResponse> ResponseHandler)
パラメーター
RegisterProfileDeletedCallback(Unity::Services::Core::THandler<FAuthenticationPlayerProfileDeletedResponse> ResponseHandler)
プレイヤープロファイルが削除された際に実行されるハンドラーにフックします。
宣言
void RegisterProfileDeletedCallback(Unity::Services::Core::THandler<FAuthenticationPlayerProfileDeletedResponse> ResponseHandler)
パラメーター
IsSignedIn()
ユーザーがサインインしているかどうかを確認します。
注
ユーザーはサインインしたままで、セッションが期限切れになることがあります。
宣言
戻り値
型 | 説明 |
|---|
| ユーザーがサインインしている場合は true、それ以外の場合は false。 |
IsAnonymous()
ユーザーが匿名でサインインしているかどうかを確認します。
宣言
戻り値
型 | 説明 |
|---|
| ユーザーが匿名でサインインしている場合は true、それ以外の場合は false。 |
IsAuthorized()
ユーザーがまだ認証されているかどうかを確認します。
注
ユーザーは、アクセストークンが有効である限り、認証された状態で維持されます。
宣言
bool IsAuthorized() const
戻り値
型 | 説明 |
|---|
| ユーザーが認証されている場合は true、それ以外の場合は false。 |
IsExpired()
ユーザーセッションが期限切れかどうかを確認します。
宣言
戻り値
型 | 説明 |
|---|
| ユーザーのセッションが期限切れである場合は true、それ以外の場合は false。 |
SessionTokenExists()
現在のプロファイル用に保存されているセッショントークンがあるかどうかを確認します。
宣言
bool SessionTokenExists() const
戻り値
型 | 説明 |
|---|
| 現在のプロファイル用に保存されているセッショントークンがある場合は true。 |
GetUnityProjectId()
Unity プロジェクト ID を返します。
宣言
const FGuid GetUnityProjectId() const
戻り値
GetUnityEnvironmentName()
Unity 環境名を返します。
宣言
const FString GetUnityEnvironmentName() const
戻り値
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
戻り値
SetUnityProjectId(FGuid)
Unity プロジェクト ID を設定します。
宣言
void SetUnityProjectId(FGuid Value)
パラメーター
名前 | 型 | 説明 |
|---|
| 値 | FGuid | 新しい Unity プロジェクト ID。 |
SetUnityEnvironmentName(FString)
Unity 環境名を設定します。
宣言
void SetUnityEnvironmentName(FString Value)
パラメーター