メインコンテンツまでスキップ

gadgets.io


メソッド​

gadgets.io.encodeValues​

<static> String encodeValues(fields)

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

パラメータ​
名前型説明
fieldsObjectエンコードしたい POST データ
返り値​
型説明
String処理された POST データ。末尾にアンパサンド (&) が付く。
サンプル​
var postData = {param: "Hello"};
var params = {};
params[gadgets.io.RequestParameters.POST_DATA] = gadgets.io.encodeValues(postData);

gadgets.io.getProxyUrl​

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

gadgets.io.makeRequest​

<static> String makeRequest(url, callback, opt_params)

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

パラメータ​
名前型説明
urlStringコンテンツが置いてあるURL
callbackFunctionコンテンツを取得した後に、結果を引数にして呼び出されるコールバック関数
opt_paramsMap.<gadgets.io.RequestParameters, Object>追加のgadgets.io.RequestParameters または gadgets.io.ProxyUrlRequestParameters
返り値​

なし

サンプル​
var callback = function(res) {
var data = res.data;
//...
};
var url = "`http://example.com";`
var postData = {param: "Hello"};
var params = {};
params[gadgets.io.RequestParameters.REFRESH_INTERVAL] = 0;
params[gadgets.io.RequestParameters.METHOD] = gadgets.io.MethodType.POST;
params[gadgets.io.RequestParameters.POST_DATA] = gadgets.io.encodeValues(postData);
gadgets.io.makeRequest(url, callback, params);

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
    • リリース