gadgets.views
メソッド
gadgets.views.bind
<static> String bind(urlTemplate, environment)
URL テンプレートに、渡された環境内の変数をバインドして、URL 文字列を作成します。
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
| urlTemplate | String | コンテナビューの URL テンプレート。 |
| environment | Array | 文字列型の指定された変数のセット。 (例: [OWNER |
返り値
| 型 | 説明 |
|---|---|
| String | URL文字列 |
gadgets.views.getCurrentView
<static> gadgets.views.View getCurrentView()
現在のビューを返します。
パラメータ
なし
返り値
| 型 | 説明 |
|---|---|
| gadgets.views.View | 現在のビュー |
サンプル
var view = gadgets.views.getCurrentView();
gadgets.views.getParams
<static> Map.<String, String> getParams()
このビューでこのガジェットに渡されるパラメータを返します。
パラメータ
なし
返り値
| 型 | 説明 |
|---|---|
| Map.<String, String> | パラメータマップ |
gadgets.views.getSupportedViews
<static> Map<gadgets.views.ViewType, String, gadgets.views.View> getSupportedViews()
サポートされているすべてのビューのマップを返します。各 gadgets.view.View の名前をキーとして利用します。
パラメータ
なし
返り値
| 型 | 説明 |
|---|---|
| Map<gadgets.views.ViewType, String, gadgets.views.View> | name 属性をキーとして利用した、サポートされているすべてのビュー。 |
gadgets.views.requestNavigateTo
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
| view | String | gadgets.views.View |
| opt_params | Object | 遷移後のアプリケーションに渡されるパラメータ。 |
| opt_ownerId | String | 現在はサポートされていません。 |
現在のビューから別のビューにユーザの画面を遷移させるために使われます。現在は、canvasビューへの遷移のみがサポートされています。opt_paramsで渡されたパラメータは、遷移後のアプリケーション内でgadgets.views.getParams()を用いることで取得できます。
サンプル
// 遷移前
gadgets.views.requestNavigateTo("canvas", { friendId: "10000" });
// 遷移後
var params = gadgets.views.getParams();
alert(params.friendId); // "10000"
gadgets.views.View.bind
String bind(environment)
ビューの URL テンプレートに、渡された環境内の変数をバインドして、URL 文字列を作成します。
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
| environment | Array | 文字列型の指定された変数のセット。 (例: [OWNER |
返り値
| 型 | 説明 |
|---|---|
| String | URL文字列 |
gadgets.views.View.getName
gadgets.views.ViewType, String getName()
このビューの名前を返します。
パラメータ
なし
返り値
| 型 | 説明 |
|---|---|
| String | ビュー名。 |
サンプル
var view = gadgets.views.getCurrentView();
var name = view.getName();
gadgets.views.View.getUrlTemplate
サポートされていません。
gadgets.views.View.isOnlyVisibleGadget
boolean isOnlyVisibleGadget()
指定したガジェットが、このビューに表示される唯一のガジェットである場合は true を返します。キャンバス ページや最大化モードでは、ほとんどの場合 true になりますが、プロフィール ページやダッシュボード モードではほとんどの場合 false になります。
パラメータ
なし
返り値
| 型 | 説明 |
|---|---|
| boolean | 指定したガジェットがこのビューに表示される唯一のガジェットである場合は true、それ以外の場合は false。 |
サンプル
var view = gadgets.views.getCurrentView();
if (view.isOnlyVisibleGadget) {
// ...
} else {
// ...
}
gadgets.views.ViewType
gadgets.views.ViewType.HOME
提供予定です。
gadgets.views.ViewType.PROFILE
提供予定です。
gadgets.views.ViewType.CANVAS
Canvas ビューです。
gadgets.views.ViewType.PREVIEW
サポートされていません。
更新履歴
- 2013/03/15
- ドキュメント移行