TAGContainer クラス リファレンス

TAGContainer クラス リファレンス

概要

コンテナの値へのアクセスを提供するクラス。

コンテナ オブジェクトは TAGManager で作成する必要があります。作成したコンテナに対してクエリを実行すると、そのコンテナで設定されたルールに依存する Key-Value を取得できます。コンテナは定期的に(12 時間ごとに)自動的に更新されますが、更新(TAGContainer)を使用して手動で更新することもできます。

パブリック メンバー関数

(BOOL) - booleanForKey:
 指定されたキーの構成値を表す BOOL を返します。
(double)- doubleForKey:
 指定されたキーの構成値を表す double を返します。
(int64_t) - int64ForKey:
 指定されたキーの構成値を表す int64_t を返します。
(NSString *) - stringForKey:
 指定されたキーの構成値を表す NSString を返します。
(void) - 更新
 このコンテナをネットワークから更新するようリクエストします。
(void) - 閉じる
 このコンテナを閉じて、更新されないようにします。
(BOOL) - isDefault
 デフォルトのコンテナか、サーバーから更新されたものかを返します。
(void) - registerFunctionCallMacroHandler:forMacro:
 指定された関数呼び出しマクロを処理するマクロ ハンドラを登録します。
(id< TAGFunctionCallMacroHandler >)- functionCallMacroHandlerForMacro:
 関数呼び出しマクロの名前を指定すると、そのマクロに登録されているハンドラを返します。
(void) - registerFunctionCallTagHandler:forTag:
 特定の関数呼び出しタグを処理する特定のタグハンドラを登録します。
(id< TAGFunctionCallTagHandler >)- functionCallTagHandlerForTag:
 関数呼び出しタグの名前を指定して、そのタグに登録されているハンドラを返します。

プロパティ

NSString * containerId
 このコンテナの ID。
doublelastRefreshTime
 このコンテナがネットワークから最後に更新された時刻(UTC 1970 年 1 月 1 日深夜 0 時からのミリ秒数)。

メンバー関数のドキュメント

- (BOOL) booleanForKey: (NSString *)  key

指定されたキーの構成値を表す BOOL を返します。

コンテナにこのキーの値がない場合は NO が返されます。

パラメータ:
key構成値を検索するキーです。
- (double) doubleForKey: (NSString *)  key

指定されたキーの構成値を表す double を返します。

コンテナにこのキーの値がない場合は 0.0 が返されます。

パラメータ:
key構成値を検索するキーです。
- (int64_t) int64ForKey: (NSString *)  key

指定されたキーの構成値を表す int64_t を返します。

コンテナにこのキーの値がない場合は 0 が返されます。

パラメータ:
key構成値を検索するキーです。
- (NSString *) stringForKey: (NSString *)  key

指定されたキーの構成値を表す NSString を返します。

コンテナがこのキーの値を持たない場合は、空の文字列が返されます。

パラメータ:
key構成値を検索するキーです。
-(void)refresh

このコンテナをネットワークから更新するようリクエストします。

この呼び出しは非同期のため、別のスレッドで更新が行われる可能性があります。

- (void)閉じる

このコンテナを閉じて、更新されないようにします。

終了したら、コンテナに対する他の呼び出しは行わないでください。

-(BOOL)isDefault

デフォルトのコンテナか、サーバーから更新されたものかを返します。

- (void) registerFunctionCallMacroHandler: (id< TAGFunctionCallMacroHandler >) ハンドラ
forMacro: (NSString *)  macroName

指定された関数呼び出しマクロを処理するマクロ ハンドラを登録します。

パラメータ:
handlerマクロのハンドラ。パラメータが nil の場合、メソッドはそのマクロの既存のハンドラの登録をすべて解除します。
macroName登録されるマクロの名前。
- (id<TAGFunctionCallMacroHandler>) functionCallMacroHandlerForMacro: (NSString *)  functionCallMacroName

関数呼び出しマクロの名前を指定すると、そのマクロに登録されているハンドラを返します。

戻り値:
マクロに登録されたハンドラ。
- (void) registerFunctionCallTagHandler: (id< TAGFunctionCallTagHandler >) ハンドラ
forTag: (NSString *)  tagName

特定の関数呼び出しタグを処理する特定のタグハンドラを登録します。

パラメータ:
handlerタグのハンドラ。パラメータが nil の場合、このメソッドはそのタグの既存のハンドラの登録をすべて解除します。
tagName登録されるタグの名前。
- (id<TAGFunctionCallTagHandler>) functionCallTagHandlerForTag: (NSString *)  functionCallTagName

関数呼び出しタグの名前を指定して、そのタグに登録されているハンドラを返します。

戻り値:
タグに登録されたハンドラ。

プロパティのドキュメント

- (NSString*) containerId [read, copy]

このコンテナの ID。

-(double)lastRefreshTime [read, assign]

このコンテナがネットワークから最後に更新された時刻(UTC 1970 年 1 月 1 日深夜 0 時からのミリ秒数)。