spiral
[ class tree: spiral ] [ index: spiral ] [ all elements ]

Class: SpiralApiResponse

Source Location: /api/request/SpiralApiResponse.php

Class Overview

PbJavaLikeMap
   |
   --SpiralApiContext
      |
      --SpiralApiResponse

スパイラルAPIレスポンス


Methods


Inherited Methods

Class: SpiralApiContext

SpiralApiContext::__construct()
コンストラクタ (空データでインスタンスを作成します。)
SpiralApiContext::getInt()
指定したキーの値(int)を返します。 キーがnullもしくは空文字の場合は、-1 を返します。
SpiralApiContext::getString()
指定したキーの値(文字列)を返します。 キーがnullもしくは空文字の場合は、null を返します。
SpiralApiContext::initJsonString()
JSON文字列で初期化します。
SpiralApiContext::setString()
キーと値をセットします。
SpiralApiContext::writeJson()
JSON形式のテキストデータをバッファに書き出します。

Class: PbJavaLikeMap

PbJavaLikeMap::__construct()
コンストラクタ
PbJavaLikeMap::clear()
マップからマッピングをすべて削除します
PbJavaLikeMap::containsKey()
指定されたキーのマッピングがマップに含まれている場合に true を返します。
PbJavaLikeMap::containsValue()
マップが、指定された値に 1 つ以上のキーをマッピングしている場合に true を返します。
PbJavaLikeMap::entrySet()
マップに含まれているマッピングのarrayのコピーを返します。
PbJavaLikeMap::equals()
指定されたオブジェクトがこのマップと等しいかどうかを比較します。
PbJavaLikeMap::get()
マップが指定のキーをマップする値を返します。
PbJavaLikeMap::isEmpty()
マップがキーと値のマッピングを保持しない場合に true を返します。
PbJavaLikeMap::keySet()
マップに含まれているキーのセットビューを返します。
PbJavaLikeMap::put()
指定された値と指定されたキーをこのマップに関連付けます。 キーがnullなら何もしません。 値がnullなら何もしません。
PbJavaLikeMap::putAll()
指定されたマップのすべてのマッピングをこのマップにコピーします。
PbJavaLikeMap::remove()
このキーにマッピングがある場合に、そのマッピングをマップから削除します (任意のオペレーション)。
PbJavaLikeMap::size()
マップ内のキーと値のマッピングの数を返します。
PbJavaLikeMap::toString()
中身をダンプして文字列で返します。
PbJavaLikeMap::values()
マップに含まれている値のコレクションビューを返します。

Class Details

[line 9]
スパイラルAPIレスポンス



[ Top ]


Class Methods


method getMessage [line 34]

string getMessage( )

APIのレスポンスの "message" を返します。



Tags:

access:  public


[ Top ]

method getResultCode [line 25]

int getResultCode( )

APIのレスポンスの "code" を返します。



Tags:

return:  "code"の値
access:  public


[ Top ]

method getSessionId [line 43]

string getSessionId( )

APIのレスポンスの "jsessionid" を返します。値がない時はnullを返します。



Tags:

return:  セッションID
access:  public


[ Top ]

method getTip [line 52]

string getTip( )

APIのレスポンスの "tip" を返します。



Tags:

return:  tip
access:  public


[ Top ]

method isSuccess [line 16]

boolean isSuccess( )

APIのレスポンスの "code" が0であればtrueを返します。



Tags:

return:  成功 or 失敗
access:  public


[ Top ]


Documentation generated on Wed, 28 Feb 2024 10:28:28 +0900 by phpDocumentor 1.4.4