API-BackboneClient
ネームスペース: Gimmebreak.Backbone.Core
インヘリタンス: Object → BackboneClient
バックボーンクライアントは、バックボーンバックエンドに反応して動作するエントリポイントです。
http APIクライアントをカプセル化し、より手軽な実装ができるよう非同期メソッドを提供します。
C#
public sealed class BackboneClient
プロパティ
ゲーム
ゲームのグローバルデータを取得します。 (ゲームID、グローバルプロパティなど)
C#
public GameData Game
{
get;
}
IsInitialized
クライアントが正常に初期化されたか判定します。
C#
public bool IsInitialized
{
get;
}
IsUserLoggedIn
ユーザーがログインしてAPI呼び出しを行う有効なセッションを持っているかどうか判定します。
C#
public bool IsUserLoggedIn
{
get;
}
Notifications
ユーザーの通知データを取得します。(トーナメントパーティ招待など)
C#
public NotificationData Notifications
{
get;
}
Season
現在のセッションデータを取得します。(開始日時、終了日時、ユーザーセッションステータスなど)
C#
public SeasonData Season
{
get;
}
Tournaments
ユーザーのトーナメントデータを取得します。(トーナメントリストなど)
C#
public TournamentData Tournaments
{
get;
}
User
ユーザーデータを取得します。(ニックネーム、プラットフォームID、ユーザープロパティなど)
C#
public UserData User
{
get;
}
メソッド
AcceptPartyInvite(long, long)
トーナメントパーティ招待を承諾します。
ユーザーはパーティ招待を承諾する前にトーナメントにサインアップする必要があります。
C#
public Gimmebreak.Backbone.Core.AsyncOperation<Gimmebreak.Backbone.Tournaments.TournamentAcceptPartyStatus> AcceptPartyInvite(long tournamentId, long partyInviteId)
パラメータ
tournamentId
: トーナメントID。partyInviteId
: トーナメントパーティ招待ID。
リターン
パーティ招待ステータスを承諾します。
備考
パーティ招待は通知(TournamentPartyInviteNotification)として受信され、tournamentIdとpartyInviteIdが含まれています。
AcceptPartyInvite(long, string)
共通パーティコードを提供してトーナメントパーティ招待を承諾します
ユーザーはパーティ招待を承諾する前にトーナメントにサインアップしている必要があります。
C#
public Gimmebreak.Backbone.Core.AsyncOperation<Gimmebreak.Backbone.Tournaments.TournamentAcceptPartyStatus> AcceptPartyInvite(long tournamentId, string partyCode)
パラメータ
tournamentId
: トーナメントID。partyCode
: トーナメントパーティーコード。
リターン
パーティ招待ステータスを承諾します。
備考
パーティコードはCreatePartyCodeForTournamentを呼び出すことでオンデマンドで作成されます。
パーティコードが作成されると、他のユーザーに共有してパーティに参加する(チャットなど)ため使用できるようになります。
ChangeNickname(string)
ユーザーのニックネームを変更します。
正常に行われると、一意のハッシュナンバーが与えられます。
C#
public Gimmebreak.Backbone.Core.AsyncOperation<bool> ChangeNickname(string nickName)
パラメータ
nickName
: 新しいニックネーム (最大 100 文字).
リターン
操作が正常に行こなわれた場合はTrue。
備考
特定のハッシュナンバー(独自のシステムにマッチさせるためなど)にする場合は、代わりにChangeNickname(string nickName, int preferredNickHash)を使用します。
ChangeNickname(string, int)
ユーザーのニックネームを変更します。
希望するハッシュナンバーが提供されますが、組み合わせが既に使用されている場合、一意のハッシュナンバーが提供されます。
C#
public Gimmebreak.Backbone.Core.AsyncOperation<bool> ChangeNickname(string nickName, int preferredNickHash)
パラメータ
nickName
: 新しいニックネーム (最大 100 文字)preferredNickHash
: 希望のハッシュナンバー。
リターン
操作が正常に行こなわれた場合はTrue。
ConnectTournamentHub(ITournamentHubCallbackHandler, Tournament)
特定のトーナメントのトーナメントハブを接続し初期化します。
パスされたトーナメントハブ(ITournamentHubCallbackHandler)は、切断されるまでコールバックを受信し続けるようになります。
主に実行中のトーナメントに使用され、トーナメントのステート変更をトーナメントハブを介して広めます。
C#
public void ConnectTournamentHub(Gimmebreak.Backbone.Tournaments.ITournamentHubCallbackHandler tournamentHub, Gimmebreak.Backbone.Tournaments.Tournament tournament)
パラメータ
tournamentHub
: ITournamentHubCallbackHandlerを実装しているトーナメントハブ。tournament
: トーナメントハブを初期化する特定のトーナメント
備考
トーナメントハブに接続できるのは1度に1つのトーナメントのみです。
Even if different tournament hub object is passed connecting to other tournament it will stop callbacks on previousely connected tournament hub.
CreateGameSession(IEnumerable<TournamentMatch.User>, long, byte)
特定のトーナメントマッチのゲームセッションを作成します。
パスされたユーザーは、トーナメントマッチで特定されたユーザーのサブセットである必要があります。
C#
public Gimmebreak.Backbone.Core.AsyncOperation<Gimmebreak.Backbone.GameSessions.GameSession> CreateGameSession(System.Collections.Generic.IEnumerable<Gimmebreak.Backbone.Tournaments.TournamentMatch.User> users, long tournamentMatchId, byte gameSessionType = 0)
パラメータ
users
: トーナメントマッチに参加しているユーザーtournamentMatchId
: トーナメントマッチIDgameSessionType
: ゲームセッションの種類 (ダッシュボードで定義済、 例. team match、deadmatch、capture flagなど。)
リターン
一意のIDを持つゲームセッションで、操作に失敗した場合はnull。結果の報告に必要となります。
備考
結果が送信され、ゲームセッションがクローズされるまで特定のトーナメントマッチIDに対し同じゲームセッションが返されます。
CreateGameSession(IEnumerable<GameSession.User>, long, byte)
特定のトーナメントマッチに新しいゲームセッションを作成します。
パスされたユーザーは、トーナメントマッチで特定されたユーザーのサブセットである必要があります。
C#
public Gimmebreak.Backbone.Core.AsyncOperation<Gimmebreak.Backbone.GameSessions.GameSession> CreateGameSession(System.Collections.Generic.IEnumerable<Gimmebreak.Backbone.GameSessions.GameSession.User> users, long tournamentMatchId, byte gameSessionType = 0)
パラメータ
users
: トーナメントマッチに参加しているユーザー。tournamentMatchId
: トーナメントマッチID。gameSessionType
: ゲームセッションの種類 (ダッシュボードで定義済、 例. team match、deadmatch、capture flagなど。)
リターン
一意のIDを持つゲームセッションで、操作に失敗した場合はnull。結果の報告に必要となります。
備考
結果が送信され、ゲームセッションがクローズされるまで特定のトーナメントマッチIDに対し同じゲームセッションが返されます。
CreatePartyCodeForTournament(long, bool)
共有してパーティに参加に使用するトーナメント用のパーティコードを作成します。
C#
public Gimmebreak.Backbone.Core.AsyncOperation<Gimmebreak.Backbone.Tournaments.PartyCodeResult> CreatePartyCodeForTournament(long tournamentId, bool recreate = False)
パラメータ
tournamentId
: トーナメントID。recreate
: trueに設定された場合は既存のパーティコードが新しいものに置き換わります。
リターン
パーティ作成コードプロセスの結果。
備考
「recreate」パラメータをtrueに設定してパーティコードが再作成されると、旧パーティコードが無効となりパーティ参加に使用できなくなります。
CreatePartyInviteForTournament(long, long)
ユーザーIDを提供してトーナメントへのパーティ招待を作成します。
C#
public Gimmebreak.Backbone.Core.AsyncOperation<Gimmebreak.Backbone.Tournaments.PartyInviteResult> CreatePartyInviteForTournament(long tournamentId, long inviteUserId)
パラメータ
tournamentId
: トーナメントID。inviteUserId
: パーティ招待を受け取るユーザーのID。
リターン
パーティ招待プロセスの結果。
CreatePartyInviteForTournament(long, LoginProvider.Platform, string)
特定のプラットフォームのユーザーIDを提供してトーナメントのパーティ招待を作成します。
C#
public Gimmebreak.Backbone.Core.AsyncOperation<Gimmebreak.Backbone.Tournaments.PartyInviteResult> CreatePartyInviteForTournament(long tournamentId, Gimmebreak.Backbone.User.LoginProvider.Platform inviteUserPlatformType, string inviteUserPlatformId)
パラメータ
tournamentId
: トーナメントID。inviteUserExternalId
: パーティ招待を受け取るユーザーの外部ID。inviteUserPlatformId
: 特定のプラットフォームのID
リターン
パーティ招待プロセスの結果。
CreatePartyInviteForTournament(long, string, int)
ニックネーム、ハッシュナンバーを提供してトーナメントへのパーティ招待を作成します。
C#
public Gimmebreak.Backbone.Core.AsyncOperation<Gimmebreak.Backbone.Tournaments.PartyInviteResult> CreatePartyInviteForTournament(long tournamentId, string inviteUserNick, int inviteUserHash)
パラメータ
tournamentId
: トーナメントID。inviteUserNick
: ユーザーのニックネーム。inviteUserHash
: ユーザーのハッシュナンバー。
リターン
パーティ招待プロセスの結果。
DeclinePartyInvite(long)
パーティ招待を辞退します。
C#
public Gimmebreak.Backbone.Core.AsyncOperation<bool> DeclinePartyInvite(long partyInviteId)
パラメータ
partyInviteId
: パーティ招待ID。
リターン
操作が正常に行こなわれた場合はTrue。
備考
招待を辞退しても、他のユーザーはもう一度招待できます。
DisconnectTournamentHub()
トーナメントハブを切断しコールバックを実行します。
C#
public void DisconnectTournamentHub()
DismissNotification(Notification)
ユーザー通知を却下し、アクティブリストから削除します。
次のリスト更新まで通知は有効です。
通知が却下済かどうか、IsDismissedプロパティを確認します。
C#
public Gimmebreak.Backbone.Core.AsyncOperation<bool> DismissNotification(Gimmebreak.Backbone.Notifications.Notification notification)
パラメータ
notification
: 却下する通知。
リターン
通知が却下された場合はTrue。
DownloadGameSessionReplay(GameSession)
有効な場合ゲームセッションリプレイをダウンロードし、ゲームセッションリプレイオブジェクト (GameSessions.GameSession.Replay)にサブミッションリストを追加します。
C#
public Gimmebreak.Backbone.Core.AsyncOperation<bool> DownloadGameSessionReplay(Gimmebreak.Backbone.GameSessions.GameSession gameSession)
パラメータ
gameSession
: 有効なゲームセッション。
リターン
操作が正常に行われた場合はTrue。
Initialize(IBackboneClientCallbackHandler)
デフォルトのBackboneClientSettingアセットから設定を使用してBackboneクライアントを初期化します。
C#
public static Gimmebreak.Backbone.Core.AsyncOperation<Gimmebreak.Backbone.Core.BackboneClient> Initialize(Gimmebreak.Backbone.Core.IBackboneClientCallbackHandler callbackHandler = null)
パラメータ
callbackHandler
: クライアントのコールバックをリッスンするハンドラーをパスします。
リターン
使用可能な初期化されたBackboneクライアント。
Initialize(BackboneClientSetting, IBackboneClientCallbackHandler)
デフォルトのBackboneClientSettingアセットから設定を使用してBackboneクライアントを初期化します。
C#
public static Gimmebreak.Backbone.Core.AsyncOperation<Gimmebreak.Backbone.Core.BackboneClient> Initialize(Gimmebreak.Backbone.Core.BackboneClientSetting settings, Gimmebreak.Backbone.Core.IBackboneClientCallbackHandler callbackHandler = null)
パラメータ
settings
: BackboneClientSettingアセット。callbackHandler
: クライアントのコールバックをリッスンするハンドラーをパスします。
リターン
使用可能な初期化されたBackboneクライアント。
Initialize(Uri, string, IBackboneClientCallbackHandler)
特定のサーバーとゲームのBackboneクライアントを初期化します。
C#
public static Gimmebreak.Backbone.Core.AsyncOperation<Gimmebreak.Backbone.Core.BackboneClient> Initialize(System.Uri server, string gameId, Gimmebreak.Backbone.Core.IBackboneClientCallbackHandler callbackHandler = null)
パラメータ
server
: サーバーURLまたはIP。gameId
: ダッシュボードで取得したゲームID。callbackHandler
: クライアントのコールバックをリッスンするハンドラーをパスします。
リターン
使用可能な初期化されたBackboneクライアント。
LoadNotifications()
ユーザーの有効な通知を読み込みます。 (例: news、 party invitesなど)
C#
public Gimmebreak.Backbone.Core.AsyncOperation<bool> LoadNotifications()
リターン
通知が読み込まれた場合はTrue。
LoadTournament(Tournament)
全てのトーナメントデータを読み込みます。 (Party users、matches、detailsなど)
C#
public Gimmebreak.Backbone.Core.AsyncOperation<bool> LoadTournament(Gimmebreak.Backbone.Tournaments.Tournament tournament)
パラメータ
tournament
: データを読み込むトーナメント。.
リターン
データが読み込まれたらTrue。
LoadTournament(long)
全てのトーナメントデータを読み込みます。(Party users、matches、detailsなど)
C#
public Gimmebreak.Backbone.Core.AsyncOperation<bool> LoadTournament(long tournamentId)
パラメータ
tournamentId
: データを読み込むトーナメント。
リターン
データが読み込まれたらTrue。
LoadTournamentList()
過去、未来、現在のトーナメントを含むトーナメントリストを読み込みます。
読み込まれたトーナメントにはすべてのメタデータは含まれません。
HasAllDataLoadedプロパティを確認します。
全てのデータを読み込むには、続いてLoadTournament()を呼び出します。
C#
public Gimmebreak.Backbone.Core.AsyncOperation<bool> LoadTournamentList()
リターン
正常にリストが更新された場合はTrue。
LoadTournamentMatches(long, IEnumerable<long>)
特定のフェーズのトーナメントマッチを読み込みます。
このメソッドを使用するとトーナメントのすべてのマッチを表示できます。
C#
public Gimmebreak.Backbone.Core.AsyncOperation<System.Collections.Generic.List<Gimmebreak.Backbone.Tournaments.TournamentMatch>> LoadTournamentMatches(long tournamentId, System.Collections.Generic.IEnumerable<long> matchIds)
パラメータ
tournamentId
: トーナメントID。matchIds
: 特定のトーナメントの試合ID(最大25)。
リターン
成功した場合のトーナメントマッチのリスト。それ以外の場合はnull。
LoadTournamentMatches(long, int, int, int, int, int, bool, int)
特定のフェーズのすべてのトーナメントマッチを読み込みます。
この方法ではトーナメントのすべての試合を閲覧できます。
C#
public Gimmebreak.Backbone.Core.AsyncOperation<Gimmebreak.Backbone.Tournaments.MatchesPaginatedResult> LoadTournamentMatches(long tournamentId, int phaseId, int fromRoundId, int toRoundId, int maxResults, int page, bool onlyInProgress, int groupId = 0)
パラメータ
tournamentId
: トーナメントID。phaseId
: マッチを読み込む特定のフェーズ。fromRoundId
:マッチを読み込むためのフェーズラウンドID。toRoundId
:マッチを読み込むフェーズラウンドID。maxResults
: ページごとに返される最大結果。page
: リクエストされたページ番号。onlyInProgress
: 進行中のマッチのみを読み込みます。groupId
: マッチを読み込む特定のフェーズグループ。
リターン
トーナメントマッチの1ページ。
LoadTournamentMatchesAll(long, int, int)
特定のフェーズのすべてのトーナメントのマッチを読み込みます。
フェーズに多数のマッチが含まれている場合、操作は複数の呼び出しに分割され、終了までに同じ時間がかかる場合があります。特定のマッチのみを読み込む/更新する場合は、LoadTournamentMatches()メソッドを使用します(例えば、最初のラウンドからのマッチのみを読み込むため)。
C#
public Gimmebreak.Backbone.Core.AsyncOperation<System.Collections.Generic.List<Gimmebreak.Backbone.Tournaments.TournamentMatch>> LoadTournamentMatchesAll(long tournamentId, int phaseId, int groupId = 0)
パラメータ
tournamentId
: トーナメント id.phaseId
:マッチを読み込む特定のトーナメントフェーズ。groupId
: マッチを読み込む特定のフェーズグループ。
リターン
すべてのフェーズマッチのリスト、それ以外の場合はnull。
LoadTournamentMatchGameSessions(TournamentMatch)
トーナメントマッチの終了したゲームセッションを読み込みます。
進行中または終了したトーナメントのマッチのみが処理されます。
C#
public Gimmebreak.Backbone.Core.AsyncOperation<bool> LoadTournamentMatchGameSessions(Gimmebreak.Backbone.Tournaments.TournamentMatch tournamentMatch)
パラメータ
tournamentMatch
: 実行中または終了したトーナメントマッチ。
リターン試合をロードする特定のトーナメントフェーズ。
操作が正常に行われた場合はTrue。
LoadTournaments(DateTime, DateTime, int, int)
特定の日付の間のトーナメントを読み込みます。
読み込まれたトーナメントには、すべてのメタデータが含まれていません。
プロパティHasAllDataLoadedを確認できます。
すべてのデータを読み込むには、後でLoadTournament()を呼び出す必要があります。
C#
public Gimmebreak.Backbone.Core.AsyncOperation<Gimmebreak.Backbone.Tournaments.TournamentsPaginatedResult> LoadTournaments(System.DateTime sinceDate, System.DateTime untilDate, int maxResults = 25, int page = 1)
Parameters
sinceDate
: UTC日付時刻(sinceDate`よりも小さい値)。untilDate
: UTC日付時刻(untilDateよりも大きい値)。maxResults
: ページごとに返される最大結果。page
: リクエストされたページ番号。
リターン
トーナメントの1ページ。
LoadTournamentsAll(DateTime, DateTime)
特定の日付の間のすべてのトーナメントを読み込む。
読み込まれたトーナメントには、すべてのメタデータが含まれていません。
HasAllDataLoadedプロパティを確認できます。
すべてのデータを読み込むには、後でLoadTournament()を呼び出す必要があります。
時間枠に多数のトーナメントが含まれている場合、操作は複数の呼び出しに分割され、同じ時間で終了することがあります。
特定のトーナメントのみを読み込む/更新する場合は、LoadTournaments()メソッドを使用します。
C#
public Gimmebreak.Backbone.Core.AsyncOperation<System.Collections.Generic.List<Gimmebreak.Backbone.Tournaments.Tournament>> LoadTournamentsAll(System.DateTime sinceDate, System.DateTime untilDate)
パラメータ
sinceDate
: UTC日付時刻(sinceDate`よりも小さい値)。untilDate
: UTC日付時刻(untilDateよりも大きい値)。
リターン
日付間のすべてのトーナメントのリスト。それ以外の場合はnull。
LoadTournamentScores(long, int, int, int, int)
特定のフェーズにトーナメントスコアを読み込みます。
このメソッドでトーナメント内の全てのパーティスコアを表示できます。
C#
public Gimmebreak.Backbone.Core.AsyncOperation<Gimmebreak.Backbone.Tournaments.ScoresPaginatedResult> LoadTournamentScores(long tournamentId, int phaseId, int maxResults, int page, int groupId = 0)
パラメータ
tournamentId
: トーナメントID。phaseId
: スコアを読み込むための特定のトーナメントフェーズ。maxResults
: ページごとにリターンされる最大結果数。page
: リクエストされたページ番号。groupId
: スコアを読み込むための特定のフェーズグループ。
リターン
トーナメントスコアの1ページ。
LoadTournamentScoresAll(long, int, int)
特定のフェーズに全てのトーナメントスコアを読み込みます。フェーズ内のパーティ数が多い場合は、呼び出しの数が複数になり、完了までに時間を要します。特定のスコアのみ読み込み・更新をする場合は、LoadTournamentScores()メソッドを使用してください。(例:トップ10のスコアのみを読み込む場合など)
C#
public Gimmebreak.Backbone.Core.AsyncOperation<System.Collections.Generic.List<Gimmebreak.Backbone.Tournaments.TournamentScore>> LoadTournamentScoresAll(long tournamentId, int phaseId, int groupId = 0)
パラメータ
tournamentId
: トーナメントID。phaseId
: スコアを読み込むための特定のトーナメントフェーズ。groupId
: スコアを読み込むための特定のフェーズグループ。
リターン
日付間のすべてのトーナメントのリスト。それ以外の場合はnull。
LoadUserSeasonProfile(long, int)
特定のシーズンのユーザープロフィールを読み込みます。
最後にプレイしたゲームセッションやプレイしたゲーム、トーナメントなどのステータスが含まれます。
C#
public Gimmebreak.Backbone.Core.AsyncOperation<Gimmebreak.Backbone.Season.UserSeasonProfile> LoadUserSeasonProfile(long userId, int season)
パラメータ
userId
: ユーザーIDseason
: 1で始まるシーズン番号。
リターン
操作が正常に行われた場合は、ユーザーシーズンプロフィール。
LoadUserSeasonProfile(LoginProvider.Platform, string, int)
特定のシーズンのユーザープロファイルを読み込みます。
これには、最後にプレイしたゲームセッションだけでなく、プレイしたゲーム、トーナメントなどの統計が含まれます。
C#
public Gimmebreak.Backbone.Core.AsyncOperation<Gimmebreak.Backbone.Season.UserSeasonProfile> LoadUserSeasonProfile(Gimmebreak.Backbone.User.LoginProvider.Platform userPlatformType, string userPlatformId, int season)
パラメータ
userPlatformType
: 特定のプラットフォームタイプuserPlatformId
: 特定のプラットフォームIDseason
: 1から始まるシーズン番号。
リターン
操作が成功した場合、ユーザーセッションプロファイル。
Login(LoginProvider)
特定のログインプロバイダからのログインユーザー。ユーザーが存在しない場合は失敗するか、プロバイダの設定によって、新しいものを作成します。
C#
public Gimmebreak.Backbone.Core.AsyncOperation<Gimmebreak.Backbone.User.LoginResult> Login(Gimmebreak.Backbone.User.LoginProvider loginProvider)
Parameters
loginProvider
: Login provider used for authentication.
パラメータ
loginProvider
: 認証に使用されたログインプロバイダ
リターン
トークンペアにアクセスし、更新します。
C#
public Gimmebreak.Backbone.Core.AsyncOperation<bool> Logout()
リターン
ユーザーがログアウトしたらTrue。
RemovePartyUser(long, long)
トーナメントパーティからユーザーを削除します。
パーティ内の他のユーザーはパーティーのリーダーのみが削除できます。
.パーティを去るには自分のIDをパスします。
C#
public Gimmebreak.Backbone.Core.AsyncOperation<Gimmebreak.Backbone.Tournaments.TournamentRemoveUserStatus> RemovePartyUser(long tournamentId, long userId)
パラメータ
tournamentId
: ユーザーを削除するパーティのトーナメントID。userId
: 削除するユーザーのID。
リターン
ユーザーステータスを削除します。
備考
パーティのリーダーがパーティから退出する(自身を削除する形で)場合、新しいパーティリーダーが残りのパーティユーザーから自動的に設定されます。
ReportUser(long, ReportReason, long, long, long)
チートの疑いやその他の理由でユーザーを報告します。
このアクションはユーザーにより、またはアンチチートにより自動で初期化できます。
報告を初期化した人(ユーザーまたはシステム)を示しながら、正しい報告理由を使用してください。
C#
public Gimmebreak.Backbone.Core.AsyncOperation<bool> ReportUser(long userId, Gimmebreak.Backbone.User.ReportReason reportReason, long gameSessionId = 0, long tournamentMatchId = 0, long tournamentId = 0)
パラメータ
userId
: 報告されるユーザーのID。reportReason
: 報告理由。gameSessionId
: 任意のゲームセッションID(ゲームセッションリプレイをトラックダウンするのに便利です)。tournamentMatchId
: 任意のトーナメントマッチID。tournamentId
: 任意のトーナメントID。
リターン
操作が正常に行われた場合はTrue。
備考
報告は、即座にトーナメントダッシュボードでみることができるようになります。
実行中のトーナメントの場合、管理者は多く報告されたユーザーを追い出したり、入室禁止にしたりできます。
SaveSession()
クライアントステートをスナップショットにとり、ディスクにデータを保存します。クライアントが初期化を行うとき、最新のスナップショットを読み込みます。
これで、ゲームはオフラインモードでユーザーデータにアクセスが可能になります。
C#
public Gimmebreak.Backbone.Core.AsyncOperation<bool> SaveSession()
リターン
スナップショットが保存されたら、True。
SignoutFromTournament(long)
登録がオープンの場合はトーナメントからサインアウトします。
C#
public Gimmebreak.Backbone.Core.AsyncOperation<Gimmebreak.Backbone.Tournaments.InviteResult> SignoutFromTournament(long tournamentId)
パラメータ
tournamentId
: サインアウトするトーナメントのID。
リターン
サインアウトプロセスの結果。トーナメントIDが無効の場合はNull。
SignupForTournament(long)
登録がオープンの場合、トーナメントにユーザーをサインアップします。
C#
public Gimmebreak.Backbone.Core.AsyncOperation<Gimmebreak.Backbone.Tournaments.InviteResult> SignupForTournament(long tournamentId)
パラメータ
tournamentId
: サインアップするトーナメントのID。
リターン
サインアッププロセスの結果。トーナメントIDが無効の場合はNull。
備考
トーナメントに、ローカルで認証されるカスタム要件が設定されている場合は、ユーザーサインアップを続ける前に確認してください。失敗する可能性があります。
サニティチェックとして、ユーザーエクスペリエンスフローにダイレクトするよりも、サーバー要件認証を使用します。
トーナメントのすべてのエントリフィーに対して同じ用に摘適用します。
ユーザーサインアップを続ける前に、ユーザーにすべてのエントリフィー(通貨、アイテム、ポイントなど)があるか確認してください。失敗する可能性があります。
SignupForTournament(string)
登録がオープンの場合、ユーザーをトーナメントにサインアップしてください。
C#
public Gimmebreak.Backbone.Core.AsyncOperation<Gimmebreak.Backbone.Tournaments.InviteResult> SignupForTournament(string privateCode)
パラメータ
privateCode
: サインアップ用のトーナメントのプライベートコード。
リターン
サインアッププロセスの結果。
備考
ローカルに検証されるトーナメントにカスタム要件が設定されている場合、ユーザーサインアップのプロセスに進む前に確認してください。失敗してしまいます。
ユーザー体験フローを導くものではなく、健全性チェックとしてのサーバー要件検証を使用してください。
トーナメントのエントリーフィーにも同様のことが言えます。
ユーザーサインアップに進む前にユーザーに十分なエントリーフィー(例:通貨、アイテム、ポイント)があることを確認しまてください。失敗してしまいます。
SubmitGameSession(GameSession, byte[])
サーバーにゲームセッション結果を送信します。
ポイントを割り当てるため、すべてのユーザーは最終的な位置を設定する必要があります。
ダッシュボードにゲームステータス設定を提供できます(何発発射したか、何体倒したか、取得した能力など)。
全てのマッチ参加者は結果を送信する必要があり、同じでなければなりません。
If someone reports different outcome such match will be marked and users will receive warning report to further investigate potential cheating.
C#
public Gimmebreak.Backbone.Core.AsyncOperation<bool> SubmitGameSession(Gimmebreak.Backbone.GameSessions.GameSession gameSession, byte[] replayData = null)
パラメータ
gameSession
: 最終結果とステータスを伴うゲームセッション。replayData
: ゲームセッションの任意のリプレイデータ。
リターン
正常にサブミッションが行われた場合はTrue。
SubmitGameSessionReplay(long, byte[])
サーバーにユーザーゲームセッションリプレイを送信します。
C#
public Gimmebreak.Backbone.Core.AsyncOperation<bool> SubmitGameSessionReplay(long gameSessionId, byte[] replayData = null)
パラメータ
gameSessionId
: 有効なゲームセッションID。replayData
: 圧縮されていないローリプレイデータ。(データは送信前に圧縮されます)
リターン
操作が正常に行われた場合はTrue。
備考
すべてのユーザーはゲームセッションリプレイを送信する必要があります。そうしないと、リプレイが可能であることを示すことができません。
SynchUser(bool)
最新のユーザーデータをサーバーから取得します。
C#
public Gimmebreak.Backbone.Core.AsyncOperation<bool> SynchUser(bool fullSynch = False)
パラメータ
fullSynch
: 場所によっては徐々にに更新されます。完全同期を行う必要があれば、trueに設定します。
リターン
操作が正常に行われた場合はTrue。
Back to top