Class Gs2TimerClient
-
GS2\Core\AbstractGs2Client
-
GS2\Timer\Gs2TimerClient
Methods summary
public
|
#
__construct( string $region, GS2\Core\Gs2Credentials $credentials, array $options = [] )
コンストラクタ
Parameters
- $region
- リージョン名
- $credentials
- 認証情報
- $options
- オプション
|
public
array
|
#
describeTimerPool( string $pageToken = NULL, integer $limit = NULL )
タイマープールリストを取得
Parameters
- $pageToken
- ページトークン
- $limit
- 取得件数
Returns
array
- items
- array
- timerPoolId => タイマープールID
- ownerId => オーナーID
- name => タイマープール名
- createAt => 作成日時
- nextPageToken => 次ページトークン
|
public
array
|
#
createTimerPool( array $request )
タイマープールを作成
GS2-Timer を利用するには、まずタイマープールを作成する必要があります。
タイマープールには複数のタイマーを格納することができます。
タイマープールを作成
GS2-Timer を利用するには、まずタイマープールを作成する必要があります。
タイマープールには複数のタイマーを格納することができます。
Parameters
Returns
array
- item
- timerPoolId => タイマープールID
- ownerId => オーナーID
- name => タイマープール名
- createAt => 作成日時
|
public
array
|
#
getTimerPool( array $request )
タイマープールを取得
Parameters
- $request
- timerPoolName => タイマープール名
Returns
array
- item
- timerPoolId => タイマープールID
- ownerId => オーナーID
- name => タイマープール名
- createAt => 作成日時
|
public
|
#
deleteTimerPool( array $request )
タイマープールを削除
Parameters
- $request
- timerPoolName => タイマープール名
|
public
array
|
#
describeTimer( array $request, string $pageToken = NULL, integer $limit = NULL )
タイマーリストを取得
Parameters
- $request
- timerPoolName => タイマープール名
- $pageToken
- ページトークン
- $limit
- 取得件数
Returns
array
- items
- array
- timerId => タイマーID
- timerPoolId => タイマープールID
- ownerId => オーナーID
- callbackMethod => HTTPメソッド
- callbackUrl => コールバックURL
- callbackBody => コールバックボディ
- executeTime => 実行時間
- retryMax => 最大リトライ回数
- createAt => 作成日時
- nextPageToken => 次ページトークン
|
public
array
|
#
createTimer( array $request )
タイマーを作成
タイマーを作成すると、指定した時刻に指定したURLに指定したパラメータを持ったアクセスを発生させます。
基本的には指定した時刻以降に60秒以内に呼び出し処理が開始されます。
混雑時には60秒以上かかることがありますので、タイミングがシビアな処理には向きません。
アカウントBANを指定した時刻付近で解除する。など、タイミングがシビアでない処理で利用することをおすすめします。
タイマーを作成
タイマーを作成すると、指定した時刻に指定したURLに指定したパラメータを持ったアクセスを発生させます。
基本的には指定した時刻以降に60秒以内に呼び出し処理が開始されます。
混雑時には60秒以上かかることがありますので、タイミングがシビアな処理には向きません。
アカウントBANを指定した時刻付近で解除する。など、タイミングがシビアでない処理で利用することをおすすめします。
Parameters
- $request
- callbackMethod => HTTPメソッド
- callbackUrl => コールバックURL
- callbackBody => コールバックボディ
- executeTime => 実行時間
- retryMax => 最大リトライ回数(OPTIONAL)
Returns
array
- item
- timerId => タイマーID
- timerPoolId => タイマープールID
- ownerId => オーナーID
- callbackMethod => HTTPメソッド
- callbackUrl => コールバックURL
- callbackBody => コールバックボディ
- executeTime => 実行時間
- retryMax => 最大リトライ回数
- createAt => 作成日時
|
public
array
|
#
getTimer( array $request )
タイマーを取得
Parameters
- $request
- timerPoolName => タイマープール名
- timerId => タイマーID
Returns
array
- item
- timerId => タイマーID
- timerPoolId => タイマープールID
- ownerId => オーナーID
- callbackMethod => HTTPメソッド
- callbackUrl => コールバックURL
- callbackBody => コールバックボディ
- executeTime => 実行時間
- retryMax => 最大リトライ回数
- createAt => 作成日時
|
public
|
#
deleteTimer( array $request )
タイマーを削除
Parameters
- $request
- timerPoolName => タイマープール名
- timerId => タイマーID
|