gadgets.io


メソッド

gadgets.io.encodeValues

入力オブジェクトを URL エンコードしたデータ文字列に変換します (key=value&...)。

パラメータ

名前

説明

fields

Object

エンコードしたい POST データ

返り値

説明

String

処理された POST データ。末尾にアンパサンド (&) が付く。

サンプル

gadgets.io.getProxyUrl

サポートされていません。

gadgets.io.makeRequest

指定の URL からコンテンツを取得します。結果はコールバック関数に返します。
gadgets.io.RequestParameters.CONTENT_TYPEにgadgets.io.ContentType.TEXT以外の値を指定した場合、callback関数で受け取れるオブジェクトのdataフィールドは指定したContentTypeに応じて適切なJSオブジェクトに変換されます。例えばDOMを指定した場合はDOMツリーの構造がネストしたJSオブジェクトに変換され、JSONを指定した場合はJSONの構造そのままのJSオブジェクトになります。変換が行われない元々のレスポンスボディはtextフィールドで取得が可能です。

パラメータ

名前

説明

url

String

コンテンツが置いてあるURL

callback

Function

コンテンツを取得した後に、結果を引数にして呼び出されるコールバック関数

opt_params

Map.<gadgets.io.RequestParameters, Object>

追加のgadgets.io.RequestParameters または gadgets.io.ProxyUrlRequestParameters

返り値

なし

サンプル

gadgets.io.AuthorizationType

gadgets.io.AuthorizationType.NONE

認証なしのリクエストです。

gadgets.io.AuthorizationType.SIGNED

コンテナによって署名がされたリクエストです。

gadgets.io.AuthorizationType.OAUTH

サポートされていません。


gadgets.io.ContentType

gadgets.io.ContentType.TEXT

テキストを返します。HTML の取得に使用します。

gadgets.io.ContentType.DOM

DOM オブジェクトを返します。XML の取得に使用します。

gadgets.io.ContentType.JSON

JSONを返します。

gadgets.io.ContentType.FEED

RSS/Atom フィードの JSON 表現を返します。


gadgets.io.MethodType

gadgets.io.MethodType.GET

コンテンツ取得時に HTTP メソッド GET を指定します。デフォルトです。

gadgets.io.MethodType.POST

コンテンツ取得時に HTTP メソッド POST を指定します。

gadgets.io.MethodType.PUT

コンテンツ取得時に HTTP メソッド PUT を指定します。

gadgets.io.MethodType.DELETE

コンテンツ取得時に HTTP メソッド DELETE を指定します。

gadgets.io.MethodType.HEAD

コンテンツ取得時に HTTP メソッド HEAD を指定します。


gadgets.io.ProxyUrlRequestParameters

gadgets.io.ProxyUrlRequestParameters.REFRESH_INTERVAL

サポートされていません。


gadgets.io.RequestParameters

gadgets.io.RequestParameters.AUTHORIZATION

コンテンツの取得時に使用する認証のタイプです。デフォルトは AuthorizationType.NONE です。

gadgets.io.RequestParameters.CONTENT_TYPE

コンテンツのタイプです。デフォルトは ContentType.TEXT です。

gadgets.io.RequestParameters.NUM_ENTRIES

コンテンツがフィードの場合、取得するエントリの数です。デフォルトは 3 です。

gadgets.io.RequestParameters.GET_SUMMARIES

コンテンツがフィードの場合、フィードの概要を取得するかどうかです。デフォルトは false です。

gadgets.io.RequestParameters.HEADERS

コンテンツの取得時に指定する HTTP ヘッダーです。デフォルトは null です。

gadgets.io.RequestParameters.METHOD

コンテンツ取得時に使用する HTTP メソッドです。デフォルトは MethodType.GET です。

gadgets.io.RequestParameters.POST_DATA

コンテンツ取得時に POST メソッドで送信するデータです。デフォルトは null です。

gadgets.io.RequestParameters.REFRESH_INTERVAL

取得したコンテンツのキャッシュの有効期間(秒)です。デフォルトでは 3600 です。
この値を0にすることによってキャッシュをすることを拒否することができます。

更新履歴

  • 2012/09/11
    • gadgets.io.RequestParameters.REFRESH_INTERVALの追記
  • 2010/10/29
    • リリース

PREVIOUS

gadgets.flash

NEXT

gadgets.json