ガジェット JavaScript リファレンス

このドキュメントでは、gadgets.* 名前空間のクラスとメソッドについて説明します。これらは、その一部が機能固有です。機能の追加については、ガジェットの仕様をご覧ください。

型規則

このドキュメントでは、型に次の規則を使用します。

Array<T> または Array.<T>

T 型のオブジェクトのみで埋められた配列。この規則は Java ジェネリックに似ています。

Map<K, V> または Map.<K, V>

V 型の値にマッピングされる K 型のキーを持つ JavaScript オブジェクト。この場合も、この規則は Java ジェネリックに似ています。これは、多くの場合、opt_params 変数に使用されます。

static

静的クラスとしてマークされた型には、パブリック コンストラクタやプライベート コンストラクタはありません。つまり、型は名前空間であり、オブジェクトを作成するためにインスタンス化できるクラスではありません。このような型のフィールドと関数も静的としてマークされます。

ブール値

ブール値（Boolean オブジェクトではない）。

文字列

文字列値（String オブジェクトではない）。

トップへ戻る

クラス Gadget.MiniMessage

概要 詳細

MiniMessage クラス。ガジェット内でユーザーに表示されるメッセージの作成に使用されます。一般的なユースケース:

• ステータス メッセージ - 読み込み、保存など
• プロモーション メッセージ - 新機能、新しいガジェットなど
• デバッグ/エラー メッセージ - 入力の誤り、サーバーへの接続の失敗など。

コンストラクタの概要

gadgets.MiniMessage(opt_moduleId, opt_container)

MiniMessage を作成します。

 

メソッドの概要

 HTMLElement createDismissibleMessage(message, opt_callback)

ユーザーがメッセージを閉じることが可能な [x] アイコンが付いた閉じることができるメッセージを作成します。

 HTMLElement createStaticMessage(message)

プログラムでのみ閉じることができる静的メッセージを作成します（DismissMessage() を呼び出します）。

 HTMLElement createTimerMessage(message, seconds, opt_callback)

指定した秒数の間表示されるメッセージを作成します。

dismissMessage(message)

指定したメッセージを閉じます。

 

コンストラクタの詳細

GadgetsMiniMessage

gadgets.MiniMessage(opt_moduleId, opt_container)

MiniMessage を作成します。

パラメータ:
String opt_moduleId - オプション モジュール ID
HTMLElement opt_container - ミニ メッセージが表示されるオプションの HTML コンテナ要素

メソッドの詳細

createDismissibleMessage

HTMLElement createDismissibleMessage(message, opt_callback)

ユーザーがメッセージを閉じることが可能な [x] アイコンで閉じることができるメッセージを作成します。メッセージが閉じられると、DOM から削除され、オプションのコールバック関数（定義されている場合）が呼び出されます。

パラメータ:
String, Object message - HTML 文字列または DOM 要素としてのメッセージ
Function opt_callback - メッセージが閉じられたときに呼び出されるオプションのコールバック関数

戻り値:
HTMLElement  作成されたメッセージの HTML 要素

{/1

createStaticMessage

HTMLElement createStaticMessage(message)

プログラムによってのみ閉じることができる静的メッセージを作成します（DismissMessage() を呼び出します）。

パラメータ:
String, Object message - HTML 文字列または DOM 要素としてメッセージ

戻り値:
HTMLElement  作成されたメッセージの HTML 要素

createTimerMessage

HTMLElement createTimerMessage(message, seconds, opt_callback)

指定の秒数を表示するメッセージを作成します。 タイマーが期限切れになると、メッセージは閉じられ、オプションのコールバック関数が実行されます。

パラメータ:
String, Object message - HTML 文字列または DOM 要素としてのメッセージ
number seconds - メッセージを閉じるまでの待機時間（秒）
Function opt_callback - メッセージが閉じられたときに呼び出されるコールバック関数（省略可）

戻り値:
HTMLElement /HTMLElement }

メッセージを閉じる

dismissMessage(message)

指定されたメッセージを閉じます。
パラメータ:
HTMLElement message - 削除するメッセージの HTML 要素

トップへ戻る

クラス Gadget.Prefs

概要 詳細

ユーザー設定、モジュール ディメンション、メッセージへのアクセス権を付与します。 クライアントは、Gadgets.Prefs のインスタンスを作成し、そのモジュール ID を渡すことで、設定にアクセスできます。例:

var prefs = new gadgets.Prefs();
var name = prefs.getString("name");
var lang = prefs.getLang();

コンストラクタの概要

gadgets.Prefs(opt_moduleId)

新しい Prefs オブジェクトを作成します。

 

メソッドの概要

 Array.<String> getArray(key)

プリファレンスを配列として取得します。

 Boolean getBool(key)

設定をブール値として取得します。

 String getCountry()

現在の国を取得します。ISO 3166-1 alpha-2 コードとして返されます。

 Number getFloat(key)

プリファレンスを浮動小数点値として取得します。

 Number getInt(key)

設定を整数として取得します。

 String getLang()

ガジェットがレンダリング時に使用する現在の言語を取得します。ISO 639-1 言語コードとして返されます。

 String, Number getModuleId()

現在のインスタンスのモジュール ID を取得します。

 String getMsg(key)

フォーマットされていないメッセージを取得します。

 String getString(key)

設定を文字列として取得します。

set(key, val)

設定を保存します。

setArray(key, val)

配列の設定を保存します。

 


コンストラクタの詳細

ガジェット、プレフ

gadgets.Prefs(opt_moduleId)

新しい Prefs オブジェクトを作成します。
パラメータ:
String, Number opt_moduleId - 構成ファイルを作成するモジュール ID を指定するオプションのパラメータ。指定しない場合、デフォルトのモジュール ID が使用されます。

メソッドの詳細

getArray

Array.<String> getArray(key)

設定を配列として取得します。 リストとして宣言されていない UserPref 値は、1 要素の配列として扱われます。
パラメータ:
String key - 取得する設定
戻り値:
Array.<String>  設定。設定されていない場合は、空の配列

getBool

Boolean getBool(key)

設定をブール値として取得します。
パラメータ:
String key - 取得する設定
戻り値:
Boolean  設定。設定されていない場合、

getCountry

String getCountry()

現在の国を取得します。ISO 3166-1 alpha-2 コードとして返されます。
戻り値:
String  このモジュール インスタンスの国

getFloat

Number getFloat(key)

環境の設定を浮動小数点値として取得します。
パラメータ:
String key - 取得する設定
戻り値:
Number  設定。設定されていない場合、0

getInt

Number getInt(key)

設定を整数として取得します。
パラメータ:
String key - 取得する設定
戻り値:
Number  設定。設定されていない場合、0

getLang

String getLang()

レンダリング時にガジェットが使用する現在の言語を取得します。ISO 639-1 言語コードとして返されます。
戻り値:
String  このモジュール インスタンスの言語

getModuleId

String, Number getModuleId()

現在のインスタンスのモジュール ID を取得します。
戻り値:
String, Number  このモジュール インスタンスのモジュール ID

getMsg

String getMsg(key)

フォーマットされていないメッセージを取得します。
パラメータ:
String key - 取得するメッセージ
戻り値:
String  メッセージ

getString

String getString(key)

設定を文字列として取得します。
パラメータ:
String key - 取得する設定
戻り値:
String  設定。設定されていない場合は、空の文字列

set

set(key, val)

設定が保存されます。 この呼び出しを使用するには、ガジェットに機能設定が必要です。

注: ガジェットで配列を格納する必要がある場合は、この呼び出しではなく、setArray を使用してください。

パラメータ:
String key - 保存する設定
Object val - 保存する値

setArray

setArray(key, val)

配列の設定を保存します。この呼び出しを使用するには、ガジェットに機能設定が必要です。
パラメータ:
String key - 保存する設定
Array val - 保存する値

トップへ戻る

クラス Gadget.Tab

概要 詳細

ガジェットの Tab クラス。 TabSet addTab() メソッドを使用してタブを作成します。Tab オブジェクトを取得するには、TabSet getSelectedTab() または getTabs() メソッドを使用します。

関連項目: TabSet

メソッドの概要

 Function getCallback()

タブが選択されたときに実行されるコールバック関数を返します。

 HTMLElement getContentContainer()

タブ コンテンツがレンダリングされる HTML 要素を返します。

 Number getIndex()

タブのインデックスを返します。

 String getName()

タブのラベルを文字列として返します（HTML を含む場合があります）。

 HTMLElement getNameContainer()

タブのラベルを含む HTML 要素を返します。

 


メソッドの詳細

getCallback

Function getCallback()

タブが選択されたときに実行されるコールバック関数を返します。
戻り値:
Function  タブのコールバック関数

getContentContainer

HTMLElement getContentContainer()

タブのコンテンツがレンダリングされる HTML 要素を返します。
戻り値:
HTMLElement  コンテンツ コンテナの HTML 要素

getIndex

Number getIndex()

タブのインデックスを返します。
戻り値:
Number  タブ&インデックス

getName

String getName()

タブのラベルを文字列として返します（HTML が含まれる場合もあります）。
戻り値:
String  タブのラベル

getNameContainer

HTMLElement getNameContainer()

タブのラベルを含む HTML 要素を返します。
戻り値:
HTMLElement  タブのラベルの HTML 要素

トップへ戻る

クラス Gadget.TabSet

概要 詳細

ガジェットでタブを作成するために使用できるクラス。

コンストラクタの概要

gadgets.TabSet(opt_moduleId, opt_defaultTab, opt_container)

新しい TabSet オブジェクトを作成します。

メソッドの概要

 String addTab(tabName, opt_params)

opt_params で指定された名前と値のペアに基づいて、新しいタブを追加します。

alignTabs(align, opt_offset)

タブの配置を設定します。

displayTabs(display)

タブとすべての関連コンテンツを表示または非表示にします。

 HTMLElement getHeaderContainer()

タブヘッダーのコンテナ要素を返します。

 gadgets.Tab getSelectedTab()

現在選択されているタブ オブジェクトを返します。

 Array.<gadgets.Tab> getTabs()

既存のすべてのタブ オブジェクトの配列を返します。

removeTab(tabIndex)

tabIndex のタブと、関連するすべてのコンテンツを削除します。

setSelectedTab(tabIndex)

tabIndex のタブを選択し、対象のタブのコールバック関数（存在する場合）を呼び出します。

swapTabs(tabIndex1, tabIndex2)

tabIndex1 と tabIndex2 のタブの位置を入れ替えます。

 


コンストラクタの詳細

ガジェット.タブセット

gadgets.TabSet(opt_moduleId, opt_defaultTab, opt_container)

新しい TabSet オブジェクトを作成します。
パラメータ:
String opt_moduleId - タブコンテナの ID の接尾辞（省略可）
String opt_defaultTab - 初期化後に選択するタブの名前を指定するオプションのタブ名。 このパラメータを省略すると、デフォルトで
から 要素が生成されます。
に要素が含まれます。

メソッドの詳細

Tab

String addTab(tabName, opt_params)

opt_params で指定された名前と値のペアに基づいて、新しいタブが追加されます。 以下のプロパティは、opt_params でサポートされています。

contentContainer

タブのコンテンツ コンテナとして使用される既存の HTML 要素。省略した場合は、タブ ライブラリが作成します。

callback

タブが選択されたときに実行されるコールバック関数。

ツールチップ

ユーザーがタブにカーソルを合わせたときにポップアップするツールチップの説明。

index

タブを挿入するインデックス。省略した場合は、新しいタブが末尾に追加されます。

パラメータ:
String tabName - 作成するタブのラベル
Object opt_params - オプションのパラメータ オブジェクト
戻り値:
String  タブコンテナの DOM ID
{/1

位置合わせタブ

alignTabs(align, opt_offset)

タブの配置を設定します。タブはデフォルトで中央揃えになります。
パラメータ:
String align - ' left', 'center' または 'right'
Number opt_offset - 左端または右端からタブをオフセットするピクセル数を設定するオプション パラメータ。デフォルト値は 3 ピクセルです。

ディスプレイ タブ

displayTabs(display)

タブとすべての関連コンテンツを表示または非表示にします。
パラメータ:
Boolean display - タブを表示する場合は True、タブを非表示にする場合は false

getHeaderContainer

HTMLElement getHeaderContainer()

タブヘッダーのコンテナ要素を返します。
戻り値:
HTMLElement  タブヘッダー コンテナ要素

getSelectedTab

gadgets.Tab getSelectedTab()

現在選択されているタブ オブジェクトを返します。
戻り値:
gadgets.Tab  現在選択されているタブ オブジェクト

getTab

Array.<gadgets.Tab> getTabs()

既存のすべてのタブ オブジェクトの配列を返します。
戻り値:
Array.<gadgets.Tab>  既存のすべてのタブ オブジェクトの配列

Tab

removeTab(tabIndex)

tabIndex のタブと、関連するすべてのコンテンツを削除します。
パラメータ:
Number tabIndex - 削除するタブのインデックス

setSelectedTab

setSelectedTab(tabIndex)

tabIndex でタブを選択し、タブが存在する場合はコールバック関数を呼び出します。タブがすでに選択されている場合、コールバックは呼び出されません。
パラメータ:
Number tabIndex - 選択するタブのインデックス

スワップタブ

swapTabs(tabIndex1, tabIndex2)

tabIndex1 と tabIndex2 のタブの位置を入れ替えます。選択したタブは変更されず、コールバック関数も呼び出されません。
パラメータ:
Number tabIndex1 - 入れ替える最初のタブのインデックス
Number tabIndex2 - 切り替える secnod タブのインデックス

トップへ戻る

Static クラス Gadgets.flash

概要 詳細

Flash コンテンツをガジェットに埋め込みます。

メソッドの概要

<static>  Boolean embedCachedFlash()

キャッシュされた Flash ファイルを DOM ツリーに挿入します。

<static>  Boolean embedFlash(swfUrl, swfContainer, swfVersion, opt_params)

Flash ファイルを DOM ツリーに挿入します。

<static>  Number getMajorVersion()

Flash Player とそのメジャー バージョンを検出します。

 


メソッドの詳細

embedCachedFlash

<static> Boolean embedCachedFlash()

キャッシュに保存された Flash ファイルを DOM ツリーに挿入します。 Gadgets.flash.embedFlash と同じパラメータを受け入れます。
戻り値:
Boolean  関数呼び出しが正常に完了したかどうか

埋め込み Flash

<static> Boolean embedFlash(swfUrl, swfContainer, swfVersion, opt_params)

Flash ファイルを DOM ツリーに挿入します。
パラメータ:
String swfUrl - CVE URL
String, Object swfContainer - 既存の HTML コンテナ要素の ID またはオブジェクト参照
Number swfVersion - 必要な Flash Player の最小バージョン
Object opt_params - 有効な HTML パラメータを含むオプション オブジェクト。
}

getMajorVersion

<static> Number getMajorVersion()

Flash Player とそのメジャー バージョンを検出します。
戻り値:
Number Flash Player のメジャー バージョン Flash がサポートされていない場合は 0

トップへ戻る

Static クラス Gadgets.io

概要 詳細

リモート コンテンツの取得機能を提供します。

メソッドの概要

<static>  String encodeValues(fields)

入力オブジェクトを URL エンコードされたデータ文字列に変換します。

<static>  String getProxyUrl(url, opt_params)

渡された URL のプロキシ バージョンを取得します。

<static> makeRequest(url, callback, opt_params)

指定された URL からコンテンツを取得し、そのコンテンツをコールバック関数にフィードします。

 


メソッドの詳細

encodeValue

<static> String encodeValues(fields)

入力オブジェクトを URL エンコードされたデータ文字列に変換します。 (key=value&...)
パラメータ:
Object fields - エンコードする投稿フィールド
戻り値:
String  処理された投稿データ。末尾のアンパサンド（&）が含まれます

getProxyUrl

<static> String getProxyUrl(url, opt_params)

渡された URL のプロキシ バージョンを取得します。
パラメータ:
String url - プロキシの URL を取得するための URL
Map<String, String> opt_params - リクエストに渡す追加のパラメータ パラメータ
戻り値:
String  URL のプロキシ バージョン

makeRequest

<static> makeRequest(url, callback, opt_params)

指定された URL からコンテンツを取得し、そのコンテンツをコールバック関数にフィードします。例:

var params = {};
params[gadgets.io.RequestParameters.CONTENT_TYPE] = gadgets.io.ContentType.TEXT;
gadgets.io.makeRequest(url, callback, params);

署名付き承認

opt_params[gadgets.io.RequestParameters.AUTHORIZATION] が gadgets.io.AuthorizationType.SIGNED に設定されている場合、コンテナは宛先サーバーに対してユーザー ID を保証する必要があります。コンテナでは、次の処理が行われます。

1. 名前が oauth、xoauth、opensocial（大文字と小文字を区別しない）で始まるリクエスト パラメータをすべて削除する。

2. リクエストのクエリ文字列に次のパラメータを追加します。

   opensocial_viewer_id

   省略可。
   現在のビューアの ID。閲覧者ビューアの getId() 値と一致します。

   opensocial_owner_id

   必須。
   現在のオーナーの ID。オーナーのオブジェクト オブジェクトの getId() の値と一致します。

   opensocial_app_url

   必須。
   リクエストを行うアプリケーションの URL。アプリケーションが URL を変更した場合、コンテナは複数のアプリケーション URL を単一の正規アプリケーション URL にエイリアスできます。

   opensocial_instance_id

   省略可。
   1 つのコンテナ内で同じアプリケーションの複数のインスタンスを区別するために使用される不透明な ID。コンテナで同じアプリの複数のインスタンスが共存できない場合は、このパラメータを省略できます。opensocial_app_url と opensocial_instance_id の組み合わせは、コンテナ内のアプリケーションのインスタンスを一意に識別します。

   opensocial_app_id

   省略可。
   アプリケーションの不透明な ID。特定のコンテナに固有の情報です。opensocial-0.7 仕様との下位互換性を維持するコンテナには、このパラメータを含めることができます。

   xoauth_signature_publickey

   省略可。
   リクエストの署名に使用される公開鍵の不透明な ID。公開鍵を使用してリクエストの署名を行わないコンテナや、リクエストのターゲットに合わせて鍵の配布に他のコンテナを準備する場合は、このパラメータを省略できます。

3. OAuth 仕様のセクション 9 に従って、生成されたリクエストに署名します。

Gadgetsio.AuthorizationType.SIGNED の鍵管理

コンテナが公開鍵を使用してリクエストに署名する場合、コンテナは自己署名証明書または既知の認証局によって署名された証明書のいずれかを使用できます。コンテナが HTTPS を介して OAuth 署名鍵を配信しない場合は、既知の認証局によって署名された証明書を使用する必要があります。

証明書の commonName 属性はコンテナ サーバーのホスト名と一致する必要があります。また、リクエストで指定された oauth_consumer_key パラメータの値と一致する必要があります。

コンテナは、よく知られている場所で公開鍵をダウンロードできるようにする必要があります。ロケーション https://container-hostname/opensocial/certificates/xoauth_signature_publickeyvalue をおすすめします。

署名付きリクエストの受信者は、リクエストの署名が正しいこと、およびリクエストのタイムスタンプが妥当な時間枠内にあることを確認する必要があります。現在の時刻の前後 5 分間の時間枠を推奨します。

署名付きリクエストの受信者は、oauth_consumer_key パラメータと xoauth_signature_publickey パラメータを使用して、コンテナが新しい証明書をデプロイするタイミングを自動的に検出できます。コンテナが既知の場所にデプロイされている場合、受信者が新しい証明書を自動的にダウンロードすることがあります。新しい証明書を自動的にダウンロードする受信者は、生成される証明書をキャッシュに保存する必要があります。

コンテナの証明書が https://container-hostname からダウンロードされていない場合、受信者は、証明書を信頼する前に、著名な認証局によって証明書が署名されていることを確認する必要があります。

OAuth 認証

opt_params[gadgets.io.RequestParameters.AUTHORIZATION] が gadgets.io.AuthorizationType.OAUTH に設定されている場合、コンテナは OAuth を使用して、リクエストで指定されたリソースにアクセスする必要があります。その場合は、ガジェットからユーザーにアクセスしてサービス プロバイダに誘導し、ガジェットがユーザーのコンテンツを取得する必要があります。

追加のパラメータ

次の追加パラメータを opt_params で指定できます。

Gadget.io.RequestParameters.OAUTH_SERVICE_NAME

ガジェットの XML 仕様から OAuth の要素「<Service>」を参照するために使用するニックネーム。指定しない場合、デフォルトは "" です。

Gadget.io.RequestParameters.OAUTH_TOKEN_NAME

ガジェットが OAuth トークンを参照するために使用するニックネームで、特定のリソースへのアクセス権を付与します。指定しない場合、デフォルトは "" です。ガジェットは、同じサービス プロバイダの複数のリソースにアクセスできる場合、複数のトークン名を使用できます。たとえば、連絡先リストとカレンダーにアクセスできるウィジェットは、「連絡先」のトークン名を使用し、カレンダー トークンを使用するには、連絡先リストのトークンを使用して「カレンダー」を使用できます。

Gadget.io.RequestParameters.OAUTH_REQUEST_TOKEN

サービス プロバイダは、リソースへのアクセスが事前に承認されているリクエスト トークンを使用して、ガジェットを自動的にプロビジョニングできる場合があります。ガジェットでは、OAUTH_REQUEST_TOKEN パラメータを使用してそのトークンを使用できます。このパラメータは省略可能です。

Gadget.io.RequestParameters.OAUTH_REQUEST_TOKEN_SECRET

事前に承認されたリクエスト トークンに対応するシークレット。このパラメータは省略可能です。

OAuth が使用されている場合、コンテナはガジェットに代わって OAuth プロトコルを実行する必要があります。ガジェットが、このサービス プロバイダで使用するコンシューマ キーを登録していない場合、コンテナは、既知の証明書に対応するデフォルトの RSA 署名鍵を使用してリクエストに署名できます。コンテナがデフォルトのコンシューマ キーを使用している場合は、リクエストを行うガジェットを識別する追加の OAuth パラメータ xoauth_app_url が含まれます。

コールバック パラメータ

makeRequest() コールバック パラメータには、makeRequest() が返す通常の値に加えて、いくつかの OAuth 固有のフィールドを含む JavaScript オブジェクトが渡されます。

"oauthApprovalUrl"

この値が指定されている場合、ユーザーは外部ページにアクセスして、ガジェットからのデータへのアクセス リクエストを承認する必要があります。ポップアップ ウィンドウを使用して、ユーザーを外部ページに誘導することをおすすめします。ユーザーがアクセスを承認したら、ガジェットは makeRequest 呼び出しを繰り返してデータを取得できます。

"oauthError"

この値を指定すると、OAuth 関連のエラーが発生したことを示します。この値は、プログラムでエラーを検出するために使用できる一連の文字列定数の 1 つになります。 定数は opensocial-0.8 では未定義ですが、実装者は、opensocial-0.9 で標準化するための有用な定数値一式に合意する必要があります。

"oauthErrorText"

この値は、OAuth 関連のエラーが発生したことを示します。この値は、ガジェットのデベロッパーにデバッグ情報を提供するために使用できる自由形式のテキストです。

パラメータ:
String url - コンテンツが存在する URL
Function callback - URL からデータを取得するときに呼び出す関数
Map.<gadgets.io.RequestParameters, Object> opt_params - 追加のリクエスト パラメータまたは プロキシ リクエスト パラメータ
{ 1 }

トップへ戻る

Static クラス Gadget.io.AuthorizationType

概要 詳細

RequestParameters で使用されます。

フィールドの概要

<static> object NONE

承認なし。

<static> object OAUTH

コンテナは認証に OAuth を使用します。

<static> object SIGNED

リクエストはコンテナによって署名されます。

 


フィールドの詳細

なし

<static> object NONE

承認なし。

OAuth

<static> object OAUTH

コンテナは認証に OAuth を使用します。

署名済み

<static> object SIGNED

リクエストはコンテナによって署名されます。

トップへ戻る

Static クラス Gadget.io.ContentType

概要 詳細

RequestParameters で使用されます。

フィールドの概要

<static> object DOM

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

<static> object FEED

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

<static> object JSON

JSON オブジェクトを返します。

<static> object TEXT

テキストを取得します。HTML を取得するために使用します。

 


フィールドの詳細

DOM

<static> object DOM

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

フィード

<static> object FEED

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

JSON

<static> object JSON

JSON オブジェクトを返します。

TEXT

<static> object TEXT

テキストを返します。HTML を取得するために使用されます。

トップへ戻る

静的クラス Gadget.io.MethodType

概要 詳細

RequestParameters.METHOD の値を定義します。

フィールドの概要

<static> object DELETE

このメソッドタイプのコンテナ サポートはオプションです。

<static> object GET

デフォルトのタイプ。

<static> object HEAD

このメソッドタイプのコンテナ サポートはオプションです。

<static> object POST

このメソッドタイプのコンテナ サポートはオプションです。

<static> object PUT

このメソッドタイプのコンテナ サポートはオプションです。

 


フィールドの詳細

削除

<static> object DELETE

このメソッドタイプのコンテナ サポートはオプションです。

GET

<static> object GET

デフォルトのタイプ。

HEAD

<static> object HEAD

このメソッドタイプのコンテナ サポートはオプションです。

POST

<static> object POST

このメソッドタイプのコンテナ サポートはオプションです。

PUT

<static> object PUT

このメソッドタイプのコンテナ サポートはオプションです。

トップへ戻る

静的クラス Gadget.io.ProxyUrlRequestParameters

概要 詳細

gadgets.io.getProxyUrl() メソッドで使用されます。

フィールドの概要

<static> object REFRESH_INTERVAL

コンテンツ キャッシュの使用を試みます。

 


フィールドの詳細

REFRESH_INTERVAL

<static> object REFRESH_INTERVAL

コンテンツ キャッシュの使用を試みます。更新の間隔は、指定されたレスポンスをキャッシュに保存する秒数です。デフォルトでは、HTTP ヘッダーが考慮されます。HTTP ヘッダーがない場合、この値はデフォルトで 3,600（1 時間）に設定されます。署名付きリクエストと POST_DATA が存在するオブジェクトは通常、キャッシュに保存されません。

トップへ戻る

Static クラス Gadget.io.RequestParameters

概要 詳細

gadgets.io.makeRequest() メソッドで使用されます。

フィールドの概要

<static> object AUTHORIZATION

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

<static> object CONTENT_TYPE

URL に存在するコンテンツの種類。デフォルトは ContentType.TEXT です。

<static> object GET_SUMMARIES

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

<static> object HEADERS

URL に送信する HTTP ヘッダー。デフォルトは null です。

<static> object METHOD

URL からコンテンツを取得するときに使用するメソッド。デフォルトは MethodType.GET です。

<static> object NUM_ENTRIES

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

<static> object POST_DATA

POST メソッドを使用して URL に送信するデータ。デフォルトは null です。

 


フィールドの詳細

承認

<static> object AUTHORIZATION

コンテンツの取得時に使用する認証のタイプ。デフォルトは AuthorizationType.NONE です。 AuthorizationType として指定されます。

CONTENT_TYPE

<static> object CONTENT_TYPE

URL に存在するコンテンツの種類。デフォルトは ContentType.TEXT です。 ContentType として指定されます。

GET_SUMMARIES

<static> object GET_SUMMARIES

コンテンツがフィードの場合、そのフィードの概要を取得するかどうかを指定します。デフォルトは false です。 Boolean として指定されます。

ヘッダー

<static> object HEADERS

URL に送信する HTTP ヘッダー。デフォルトは null です。Map.<String,String> として指定されます。

操作手順

<static> object METHOD

URL からコンテンツを取得するときに使用するメソッド。デフォルトは MethodType.GET です。有効な値は、MethodType によって指定されます。

NUM_ENTRIES

<static> object NUM_ENTRIES

コンテンツがフィードの場合、取得するエントリの数。デフォルトは 3 です。 Number として指定されます。

投稿データ

<static> object POST_DATA

POST メソッドを使用して URL に送信するデータ。デフォルトは null です。 String として指定されます。

トップへ戻る

Static クラス Gadgets.json

概要 詳細

JSON との間でオブジェクトを変換するオペレーションを提供します。

メソッドの概要

<static>  Object parse(text)

JSON 文字列を解析し、JavaScript 値を生成します。

<static>  String stringify(v)

JavaScript 値を JSON 文字列に変換します。

 


メソッドの詳細

parse

<static> Object parse(text)

JSON 文字列を解析し、JavaScript 値を生成します。
パラメータ:
String text - オブジェクトに変換する文字列 - 通常は前回の stringify 呼び出しの結果
戻り値:
Object  渡されたテキストから解析されたオブジェクト。エラーが発生した場合: false

文字列化

<static> String stringify(v)

JavaScript 値を JSON 文字列に変換します。
パラメータ:
Object v - 変換するオブジェクト
戻り値:
String  JSON と同等

トップへ戻る

静的クラス Gadgets.pubsub

概要 詳細

メッセージ チャネルを公開および登録するためのオペレーションを提供します。

メソッドの概要

<static> publish(channelName, message)

文字列型のメッセージをチャネルに公開します。

<static> subscribe(channelName, callback)

ガジェットをメッセージ チャンネルに登録します。

<static> unsubscribe(channelName)

メッセージ チャネルからガジェットの登録を解除します。

 


メソッドの詳細

publish

<static> publish(channelName, message)

文字列タイプのメッセージをチャンネルに公開します。
パラメータ:
String channelName - チャンネル名
String message - 公開するメッセージ

定期購入；登録；チャンネル登録；購読；有料会員登録；参加（# など適宜文脈に応じて）

<static> subscribe(channelName, callback)

ガジェットをメッセージ チャンネルに登録します。
パラメータ:
String channelName - チャネルの名前
Function callback - チャネル メッセージとともに呼び出される関数

配信登録を解除

<static> unsubscribe(channelName)

メッセージ チャンネルからガジェットの登録を解除します。
パラメータ:
String channelName - チャンネル名

トップへ戻る

Static クラス Gadget.rpc

概要 詳細

ガジェットからコンテナ、コンテナからガッド、ガジェットからリモートへの通信でリモート プロシージャ コールを行うためのオペレーションを提供します。

メソッドの概要

<static> call(targetId, serviceName, callback, var_args)

RPC サービスを呼び出します。

<static> register(serviceName, handler)

RPC サービスを登録します。

<static> registerDefault(handler)

すべての不明なリモート プロシージャ コールを処理するデフォルトのサービス ハンドラを登録します。デフォルトでは、このハンドラは通知なしに失敗します。

<static> unregister(serviceName)

RPC サービスの登録を解除します。

<static> unregisterDefault()

デフォルトのサービス ハンドラの登録を解除します。

 


メソッドの詳細

call

<static> call(targetId, serviceName, callback, var_args)

RPC サービスを呼び出します。
パラメータ:
String targetId - RPC サービス プロバイダの ID。親コンテナを呼び出す場合は空とする
String serviceName - 呼び出すサービス名
Function, null callback - RPC リクエストの戻り値を処理するコールバック関数（ある場合）
* var_args - RPC リクエストのパラメータ
}

register

<static> register(serviceName, handler)

RPC サービスを登録します。
パラメータ:
String serviceName - 登録するサービス名
Function handler - サービス ハンドラ

登録のデフォルト

<static> registerDefault(handler)

すべての不明なリモート プロシージャ コールを処理するデフォルトのサービス ハンドラを登録します。デフォルトでは、このハンドラは通知なしに失敗します。
パラメータ:
Function handler - サービス ハンドラ

unregister

<static> unregister(serviceName)

RPC サービスの登録を解除します。
パラメータ:
String serviceName - 登録解除するサービス名

unregisterDefault

<static> unregisterDefault()

デフォルトのサービス ハンドラの登録を解除します。今後の不明なリモート プロシージャ コールは通知なく失敗します。

トップへ戻る

Static クラス Gadget.skins

概要 詳細

現在表示されているスキンの表示情報を取得するためのオペレーションを提供します。

メソッドの概要

<static>  String getProperty(propertyKey)

指定されたキーにマッピングされたディスプレイ プロパティを取得します。

 


メソッドの詳細

getProperty

<static> String getProperty(propertyKey)

指定されたキーにマッピングされたディスプレイ プロパティを取得します。
パラメータ:
String propertyKey - データを取得するキー。キーの定義については gadgets.skins.Property
戻り値:
String  データ

トップへ戻る

Static クラス Gadget.skins.Property

概要 詳細

ガジェット UI でフェッチして使用できるすべての表示値。 これらは Gadget.skins.getProperty() メソッドでサポートされるキーです。

フィールドの概要

<static> object ANCHOR_COLOR

アンカータグで使用する色。

<static> object BG_COLOR

ガジェットの背景の色。

<static> object BG_IMAGE

ガジェットの背景で使用する画像。

<static> object FONT_COLOR

メイン フォントをレンダリングする色。

 


フィールドの詳細

サイトリンク表示オプションの色

<static> object ANCHOR_COLOR

アンカータグで使用する色。

背景色

<static> object BG_COLOR

ガジェットの背景の色。

BG_IMAGE

<static> object BG_IMAGE

ガジェットの背景で使用する画像。

フォントの色

<static> object FONT_COLOR

メイン フォントをレンダリングする色。

トップへ戻る

Static クラス Gadgets.util

概要 詳細

汎用ユーティリティ関数を提供します。

メソッドの概要

<static>  String escapeString(str)

HTML エンティティを使用して入力をエスケープし、より安全にします。

<static>  Object getFeatureParameters(feature)

この機能のパラメータ値を返します。

<static>  Boolean hasFeature(feature)

指定した機能がサポートされているかどうかを返します。

<static> registerOnLoadHandler(callback)

onload ハンドラ（ガジェットの読み込み時に実行される関数）を登録します。

<static>  String unescapeString(str)

エスケープ文字列を反転




メソッドの詳細

エスケープ文字列

<static> String escapeString(str)

HTML エンティティを使用して入力をエスケープし、より安全にします。 影響を受ける文字は次のとおりです。
• 改行（\n、Unicode コードポイント 10）
• 改行（\n、Unicode 13）
• 二重引用符（"、Unicode 34）
• アンパサンド（&、Unicode 38）
• 単一引用符（'、Unicode 39）
• 左山かっこ（<、Unicode 60）
• 山かっこ（>、Unicode 62）
• バックスラッシュ（\, Unicode 92）
• 行区切り（Unicode 8232）
• 段落の区切り文字（Unicode 8233）
パラメータ:
String str - エスケープする文字列
戻り値:
String  エスケープされた文字列

getFeatureParameters

<static> Object getFeatureParameters(feature)

この機能のパラメータの値を返します。ガジェットでは、<Requires> 要素や <Optional> 要素の <Param> サブ要素を使用してパラメータを指定します。
パラメータ:
String feature - パラメータのパラメータ
戻り値:
Object 指定された特徴のパラメータ、または null

hasFeature

<static> Boolean hasFeature(feature)

指定した機能がサポートされているかどうかを返します。
パラメータ:
String feature - テストする機能
戻り値:
Boolean  この機能がサポートされている場合は true

registerOnLoadHandler

<static> registerOnLoadHandler(callback)

onload ハンドラ（ガジェットの読み込み時に実行される関数）を登録します。
パラメータ:
Function callback - 実行するハンドラ

unString

<static> String unescapeString(str)

escapedString を反転
パラメータ:
String str - エスケープ解除する文字列。
戻り値:
String エスケープされていない文字列

トップへ戻る

Static クラス Gadget.views

概要 詳細

ビューを処理するためのオペレーションを提供します。

関連項目: gadgets.views.View

メソッドの概要

<static>  String bind(urlTemplate, environment)

URL テンプレートを、渡された環境の変数とバインドして URL 文字列を生成します。

<static>  gadgets.views.View getCurrentView()

現在のビューを返します。

<static>  Map.<String, String> getParams()

このビューのこのガジェットに渡されたパラメータを返します。

<static>  Map<gadgets.views.ViewType, String, gadgets.views.View> getSupportedViews()

サポートされているすべてのビューのマップを返します。

<static> requestNavigateTo(view, opt_params, opt_ownerId)

別のビューでこのガジェットに移動してみます。

 


メソッドの詳細

bind

<static> String bind(urlTemplate, environment)

渡されたテンプレート内の変数に URL テンプレートをバインドして、URL 文字列を生成します。

関連項目: View.getUrlTemplate()

パラメータ:
urlTemplate - コンテナビューの URL テンプレート
environment - 文字列タイプの名前付き変数のセット（例: [OWNER | PATH | PARAMS | NAME]）。
戻り値:
String  URL 文字列

getCurrentView

<static> gadgets.views.View getCurrentView()

現在のビューを返します。
戻り値:
gadgets.views.View  現在のビュー

getParams

<static> Map.<String, String> getParams()

このビューのこのガジェットに渡されたパラメータを返します。すべての URL パラメータが含まれるわけではなく、ガジェット.views.requestNavigationTo に渡されるパラメータのみが含まれます。
戻り値:
Map.<String, String>  パラメータ マップ

getSupportedViews

<static> Map<gadgets.views.ViewType, String, gadgets.views.View> getSupportedViews()

サポートされているすべてのビューのマップを返します。各 Gadget.view.View をその名前でキー化します。
戻り値:
Map<gadgets.views.ViewType, String, gadgets.views.View>  サポートされているすべてのビュー（名前属性でキーを付ける）。

requestNavigationTo

<static> requestNavigateTo(view, opt_params, opt_ownerId)

別のビューでこのガジェットに移動してみます。コンテナがパラメータをサポートしている場合は、オプション パラメータを新しいビュー内のガジェットに渡します。
パラメータ:
gadgets.views.View view - 移動先のビュー
Map.<String, String> opt_params - サーフェスに移動した後のガジェットに渡すパラメータ
String opt_ownerId - 移動先のページの所有者の ID。 現在のオーナーのデフォルト
{ 1}

トップへ戻る

クラス Gadget.views.View

概要 詳細

すべてのビュー オブジェクトの基本インターフェース。

メソッドの概要

 String bind(environment)

ビューの URL テンプレートを、渡された環境の変数とバインドして URL 文字列を生成します。

 gadgets.views.ViewType, String getName()

このビューの名前を返します。

 String getUrlTemplate()

IETF 仕様ドラフトに準拠した、URI 置換用の文字列 URI テンプレートを返します。

 boolean isOnlyVisibleGadget()

このビュー内にガジェットが唯一の表示されている場合は、true を返します。

 


メソッドの詳細

bind

String bind(environment)

渡された URL からビューの URL テンプレートを変数でバインドして、URL 文字列を生成します。

関連項目: getUrlTemplate()

パラメータ:
environment - 文字列型の名前付き変数のセット（[OWNER | PATH | PARAMS | NAME] など）です。
戻り値:
String  URL 文字列

getName

gadgets.views.ViewType, String getName()

このビューの名前を返します。
戻り値:
gadgets.views.ViewType, String  ビューの名前（通常は Gadgetsviews.ViewType と指定）

getUrlTemplate

String getUrlTemplate()

IETF 仕様のドラフトに準拠した、URI 置換用の文字列 URI テンプレートを返します。

次の 4 つの変数がサポートされています。

名前

アプリの名前または ID

owner

ページの所有者の ID

パス

パスステップの配列

params

連想配列または配列 [param1,value1,param2,value2,...]

例

有効な URL テンプレート文字列は次のとおりです。

http://container.com/{-list|/|name,owner,path}?{-join|&|params}
http://container.com/apps/{name}/{owner}{-prefix|/|path}{-opt|?os_|params}{-join|&os_|params} 

パラメータは次のとおりです。

{ 
  name : 'Wilma',
  owner : 'Betty',
  path : ['dino','car'], 
  params = { a : 'Barney', b : 'Fred'}
}

これらのパラメータを使用すると、2 つのサンプル URL テンプレート文字列が次の URL に解決されます。

http://container.com/Wilma/Betty/dino/car?a=Barney&b=Fred
http://container.com/apps/Wilma/Betty/dino/car?os_a=Barney&os_b=Fred

関連項目: bind()

戻り値:
String このビューに移動する URL の作成に使用できるテンプレート

isOnlyVisibleGadget

boolean isOnlyVisibleGadget()

このビューで表示されているのがガジェットのみである場合は、true を返します。 キャンバス ページや最大化モードでは、ほとんどの場合に true となります。プロファイル ページまたはダッシュボード モードでは、ほとんどの場合 false になります。
戻り値:
boolean  ガジェットが唯一の表示可能なガジェットの場合は true、それ以外の場合は false

トップへ戻る

Static クラス Gadget.views.ViewType

概要 詳細

View で使用されます。

フィールドの概要

<static> object CANVAS

非常に大きなモードでガジェットが表示されるビュー。

<static> object HOME

通常は、他のガジェットとともにページに表示される小さな領域にガジェットが表示されます。

<static> object PREVIEW

ガジェットのデモビュー。

<static> object PROFILE

通常は、他のガジェットとともにページに表示される小さな領域にガジェットが表示されます。

 


フィールドの詳細

CANVAS

<static> object CANVAS

ガジェットが非常に大きなモードで表示されるビュー。通常はページの主要コンテンツです。閲覧者は必ずしもオーナーと同じではありません。

ホーム

<static> object HOME

他のガジェットとともにページに表示される、通常は小さな領域にガジェットが表示されます。通常、閲覧者はオーナーと同じです。

PREVIEW

<static> object PREVIEW

ガジェットのデモビュー。このビューでは、オーナーと閲覧者は不明です。

プロファイル

<static> object PROFILE

他のガジェットとともにページに表示される、通常は小さな領域にガジェットが表示されます。閲覧者は必ずしもオーナーと同じではありません。

トップへ戻る

Static クラス Gadgets.window

概要 詳細

ガジェットが配置されているウィンドウに関する情報を取得して変更するオペレーションを提供します。

メソッドの概要

<static> adjustHeight(opt_height)

ガジェットの高さを調整します。

<static>  Object getViewportDimensions()

フレームの内側の寸法を検出します。

<static> setTitle(title)

ガジェットのタイトルを設定します。

 


メソッドの詳細

高さの調整

<static> adjustHeight(opt_height)

ガジェットの高さを調整します。
パラメータ:
Number opt_height - 推奨の高さ（ピクセル単位）。指定されていない場合、ガジェットをコンテンツに合わせる

getViewportDimensions

<static> Object getViewportDimensions()

フレームの内側の寸法を検出します。詳しくは、http://www.quirksmode.org/dom/w3c_cssom.html をご覧ください。
戻り値:
Object 幅と高さのプロパティを持つオブジェクト

setTitle

<static> setTitle(title)

ガジェットのタイトルを設定します。
パラメータ:
String title - 優先タイトル

トップへ戻る