GS2-Auth SDK for Game Engine API リファレンス
モデル
EzAccessToken
| 型 | 必須 | デフォルト | 値の制限 | 説明 |
---|
token | string | ✓ | | ~ 1024文字 | アクセストークン |
userId | string | ✓ | | ~ 128文字 | ユーザーID |
expire | long | ✓ | 現在時刻からの差分(1時間) | 有効期限 | |
メソッド
login
指定したユーザIDでGS2にログイン
body と signature には GS2-Account::Authentication の結果を指定します。
body と signature の検証に成功すると、 アクセストークン
を応答します。
アクセストークン
は有効期限が1時間の一時的な認証情報で、GS2内の各サービスでゲームプレイヤーを識別するために使用されます。
なおUnityとCocos2d-x向けにGS2-Account::AuthenticationとこのAPIをひとまとめにしたGS2-Profile::Loginを用意しています。
GS2-Profile::Loginははじめかた⇒サンプルプログラムで解説しています。
Request
| 型 | 必須 | デフォルト | 値の制限 | 説明 |
---|
keyId | string | ✓ | | ~ 1024文字 | 暗号鍵GRN |
body | string | ✓ | | ~ 1048576文字 | アカウント認証情報の署名対象 |
signature | string | ✓ | | ~ 1024文字 | 署名 |
Result
| 型 | 説明 |
---|
token | string | アクセストークン |
userId | string | ユーザーID |
expire | long | 有効期限 |
実装例
var domain = gs2.Auth.AccessToken(
);
var result = await domain.LoginAsync(
keyId: "key-0001",
body: "body",
signature: "signature"
);
var token = result.Token;
var userId = result.UserId;
var expire = result.Expire;
var domain = gs2.Auth.AccessToken(
);
var future = domain.Login(
keyId: "key-0001",
body: "body",
signature: "signature"
);
yield return future;
if (future.Error != null)
{
onError.Invoke(future.Error, null);
yield break;
}
var token = future.Result.Token;
var userId = future.Result.UserId;
var expire = future.Result.Expire;
const auto Domain = Gs2->Auth->AccessToken(
);
const auto Future = Domain->Login(
"key-0001",
"body",
"signature"
);
Future->StartSynchronousTask();
if (Future->GetTask().IsError())
{
return false;
}
const auto Token = Result->Token;
const auto UserId = Result->UserId;
const auto Expire = Result->Expire;