MVC架构一个Flex应用程序

架构一个Flex应用程序

使用Flex的web开发者可能最初会对用户界面模型感到困惑。虽然传统的、类似servlet的、请求-响应（request-response）模型将会在Flex中应用，但是却存在一种更好的方法。由于Actionscript语言中的“[Binding]”标签，你可以把你的视图绑定到模型数据，这样一来模型的更改就会自动影响到视图。Cairngorm 微型架构使这种方法得到形式化，而且它也是那些想要领会如何“让它们在一起工作”的开发者的一个非常好的起点。在这篇文章中我将描述变量绑定，特性驱动开发和Carigorm在NoteTag中是如何一起工作的

这里是一个典型的Flex应用程序可能的架构：


域（Domain）
·组成域模型的所有类。在NoteTag中，它包含了Notes（记录），Tasks（事务）以及Subscriptions（订阅）（Subscriptions是相关Notes或Tasks的一个群集（collection））。

模型（Model）
·一个保存域模型的可绑定实例的一个单体（singleton）。在NoteTag中，ModeLocator单体保存了用户的订阅清单，用户的连接，当前的订阅，当前的记录以及其他。

视图（View）
·UI组件（通常来说就是MXML文件，虽然并不总是）。依赖状态（state-dependent）的UI组件被绑定到ModeLocator的实例变量。如果ModeLocator中数据被标记为“[Bindable]”，那么它的任何改变都会导致UI自动更新。NoteTag中的一个例子就是NoteListView，它显示了当前订阅中的记录列表。如果当前的订阅或者它的任何一个记录改变了，那么NoteListView将会自动更新来反应这些改变。

控制器（Controller）
·同事件驱动的Commands一样执行特性所需的下部构造。NoteTag中的例子包括GetSubscriptionCommand, GetNoteCommand 以及其他。

业务（Business）
·完成域中对象操作的业务逻辑类，经常呼叫远程服务并且异步返回结果。对大部分NoteTag的业务逻辑来说SubscriptionManager类是entry point。

服务（Service）
·服务层，保存了用来呼叫远程服务（HTTPService,RemoteService和WebService）的所有类。NoteTag 使用了一个服务工厂（factory）类集合，减轻了对特殊的HTTP服务的部署，这些HTTP服务来自进行HTTP 服务呼叫的组件。

多数应用程序特性都有上面的一些或者全部结构。下面是一个典型特性的工作流程：
1.视图（view）广播一个事件。
2.单体控制器（controller）收到这个事件，把它映射到相应的Command，并且执行这个Command。
3.Command委托适当的业务（Business）对象执行业务逻辑。
4.业务（Business）对象执行业务逻辑，可能对不同的Service进行一个或者多个异步呼叫，并且通过分派（dispatch）一个新的事件给Command来返回结果。
5.Command将结果赋给单体模型。
6.绑定到单体模型中的数据的所有视图都自动更新。

它是如何在一个特定的特性中工作的呢？当用户从Notes列表（看下面，在屏幕的顶端）中选中了一个Note时，这个Note就会从适当的存储（Blogger或TypePad）中加载并显示在编辑器中（看下面，在屏幕的底端）：


1.广播事件

当用户在第一个Note上点击时，NoteListView分派一个事件，如下：


CODE:[Copy to clipboard]// NoteListView.mxml
private function getSelectedEntry(event:ListEvent) : void
{
var selectedEntry:TagBasedEntry =
TagBasedEntry(currentFeed.entries[event.rowIndex-1]);
Application.application.dispatchEvent(
new GetNoteEvent(selectedEntry.metadata,true));
}
2. 对事件相应

因为NoteTag的Front Controller已经把它自身注册来监听所有的Command Event，当GetNoteEvent 被分派的时候它将会被通知。


CODE:[Copy to clipboard]// NoteTagController.as
public class NoteTagController extends FrontController
{
public function NoteTagController()
{
addCommand(LoginEvent.EVENT_LOGIN, LoginCommand);
addCommand(GetNoteEvent.EVENT_GET_NOTE, GetNoteCommand);
addCommand(GetTaskEvent.EVENT_GET_TASK, GetTaskCommand);
addCommand(PostNoteEvent.EVENT_POST_NOTE, PostNoteCommand);
// more commands...
}
}
Cairngorm的 Front Controller通过执行适当的command提供了监听事件和响应事件的基础构造。

3. 执行 Command

为了获得这个Note，NoteTag需要呼叫存储了用户note的blog服务器。实现了Cairngorm的Command接口的GetNoteCommand就像这样：


CODE:[Copy to clipboard]// GetNoteCommand.as
internal class GetNoteCommand extends ChainedCommand
{
public override function execute(event:CairngormEvent):void
{
var initialEvent:GetNoteEvent = GetNoteEvent(event);

var subscriptionManager:SubscriptionManager =
ModelLocator.getInstance().subscriptionManager;

setNextEventHandler(subscriptionManager,
handleLoadNote,
LoadNoteEvent.EVENT_LOAD_NOTE,
onSubscriptionFault,
SubscriptionFaultEvent.EVENT_SUBscriptION_FAULT);
subscriptionManager.loadNote(initialEvent.metadata);
}

private function handleLoadNote(event:LoadNoteEvent):void
{
// handle result here...
}

// ...
}
（你可能已经发现了GetNoteCommand 继承了 ChainedCommand——这个类使用setNextEventHandler 方法共同进行一系列异步呼叫。在以后的文章里，我将更深入地讨论ChainedCommand，并大体说一下异步回应器（responder）。）

4. 执行业务逻辑

SubscriptionManager通过执行对tag服务器和blog服务器一系列的HTTP service呼叫来触发Note的加载。当note被加载完毕时，SubscriptionManager 将分派一个LoadNoteEvent，这个事件将会被GetNoteCommand.handleLoadNote（参见下一条）触发。

5. 更新模型

GetNoteCommand 通过把加载的Note赋给ModelLocator中适当的数据成员来响应事件。


CODE:[Copy to clipboard]// GetNoteCommand.as
internal class GetNoteCommand extends ChainedCommand
{
// ...

private function handleLoadNote(event:LoadNoteEvent):void
{
ModelLocator.getInstance().currentNote = event.note;
}

// ...
}
6. 更新视图

任何绑定到ModelLocator的currentNote成员的视图都将会自动更新来反映新的数据。NoteView，负责在编辑器中显示Note的组件，是这样的一个视图：


CODE:[Copy to clipboard]// NoteView.mxml
<mx:VBox xmlns:mx="http://www.adobe.com/2006/mxml"
xmlns:view="com.adobe.kiwi.notetag.view.*"
xmlns="*">
<mx:script>
<![CDATA[
import com.adobe.kiwi.notetag.model.*;
[Bindable] private var model:ModelLocator = ModelLocator.getInstance();
]]>
</mx:script>

<view:NoteEdit id="noteEditor" width="100%" height="100%"
note="{model.currentNote}" />

</mx:VBox>
所有的其它特性——发布一个Note，获得一个Subscription，更新一个Task——会通过同样的Event-to-Command-to-Model-to-View途径来实现。Command-specific事件可以从多种内容中被分派，，而不需要知道哪一个视图会被影响。视图可以绑定到模型的变化而并不需要知道引发的事件是从什么地方被分派的。由于松耦合，出现了更清洁，更容易维护的代码。

......

[阅读全文]

1:flex是否可以嵌入html?

1:flex是否可以嵌入html?
可以，需要用到iframe,该iframe并非它定义好，而需要自己定义.

2:flex可否访问系统里的资源，比如C盘D盘文件？
不可以，AIR可以.

3:flex可否对文件进行操作？
不可以，它没IO的操作，需要调用java或其他语言对文件进行读写等.

4:为什么读取数据是Object object?
读取的数据类型为Object，建议转换成string.如果不行就debug查看object里是否还有很多层次，如果有再依次取出.

5:如何访问父级对象？
parentApplication.

6:如何去掉滚动条？
横条：horiz
竖条: verticalScrollPolicy="off"

7:module数据通信？

附件: ModuleCommunicationSample.rar (2008-6-20 12:50:14, 1078.32 K)
该附件被下载次数 197

8:flex默认编码是什么格式？
utf-8

9:为什么我后台jsp传回flex端为乱码？
request.getParameter("name").getBytes("ISO8859-1"), "utf-8"); 或 request.charaterset("UTF-8").

10:dataGrid如何多选？

附件: dataGrid.rar (2008-6-20 12:50:14, 1065.23 K)
该附件被下载次数 149

11:如何改变每根柱子的颜色？
<mx:series>
<mx:ColumnSeries ...
<mx:fill>
<mx:RadialGradient>
<mx:entries>
<mx:GradientEntry 

color="#EF7651" />
<mx:GradientEntry 

color="#994C34" ratio="1"/>
</mx:entries>
</mx:RadialGradient>
</mx:fill>
<!-一个fill为1根->

12:如何改变图片缩放大小？
可以使用Resize.
例:<mx:Resize id="particular2" widthBy="2" widthFrom="323" widthTo="-691" target="{canvas2}"/>

13:日期使用.
Date.getUTCMonth()//返回月
Date.getFullYear()//按照本地时间返回 4 位数字的年份数
Date.getDate()//按照本地时间返回某天是当月的第几天
Date.getDay() 按照本地时间返回某天是周几
关于显示格式可以使用format方法.

14:swf与swf之间可否交互？
可以,使用LocalConnection.

15:PopUpManager居中问题.
PopUpManager.centerPopUp(PopUpManager.createPopUp(DisplayObject(Application.application),TitleWindow,true);).

16:flex访问，解决安全限制,破沙河.
crossdomain.xml:
<?xml version="1.0" encoding="utf-8"?>
<cross-domain-policy>
<allow-access-from domain="*"/> 
</cross-domain-policy>
存放在服务器和项目一起根目录下.*代表全部可以访问.
命名为crossdomain，flex默认读取.

17:flex可否接收键盘？
可以.首先XX.setFocus()，设置焦点在某容器/控件之上，
mc.addEventListener(KeyboardEvent.KEY_DOWN,keyIsDown);//添加响应事件
private function keyIsDown(evt:KeyboardEvent):void
{
//evt.keyCode键盘对应码
}

18:tree如何默认展开？
myTree.setIsOpen(myTree.getNodeDisplayedAt(0), true);//展开某个 
var index = 0; 
var node = TreFolder.getNodeDisplayedAt(index); 
while(node != undefined){ 
TreFolder.setIsOpen(node,true); 
index ++; 
node = TreFolder.getNodeDisplayedAt(index); 
}//true为全部展开false为全部手起

19:如何修改Alert样式？ 
字体为例: 
<mx:Style>
Alert
{
fontSize:12;
}
</mx:Style>

20:如何改变鼠标的指针？
[Embed(source="hand.jpg")]
private var handCursorSymbol:Class;//定义图片

CursorManager.setCursor(handCursorSymbol);//进行设置

21.如何使用全屏模式?
stage.displayState = StageDisplayState.NORMAL;//还原
stage.displayState = StageDisplayState.FULL_SCREEN; //全屏

22.如何制作自定义反键?
var myContextMenu:ContextMenu = new ContextMenu();
myContextMenu.hideBuiltInItems();
var item1:ContextMenuItem = new ContextMenuItem("item");
myContextMenu.customItems.push(item1);//加入右键
item1.addEventListener(ContextMenuEvent.MENU_ITEM_SELECT, menuItemSelectHandler1);//为item1添加点击响应

23:如何制作和使用swc?
new->Flex Library project.
在属性里选择Flex Library Build Path勾选你要编译的类//编译后bin里即是swc.
使用：找到要使用该swc的工程，属性，Flex Build Path，点击add swc即可.
http://www.riachina.com/showtopic-11341.aspx

24:如何使用ShareObject？
ShareObject就像cookies一样...
会生成一个文件来保存你所需要交互的数据...
提供方法:clear() //删除本地共享对象
flush() //立即把共享对象数据写入本地文件
getLocal()// 创建或连接本地共享对象； 

25.Flex常用的数据交互.httpservice和webservice.(remote可查看Flex + LCDS + Java 入门教程)
1.使用httpservice
<mx:HTTPService id="myhttp" url="you httpservice url" result="doResult(event)" >
<mx:request xmlns="">
<username>
{xxx} //此处为你要传递给后台的参数,也可以不用request.(可选),还有其他写法,此为其1.
</username>
</mx:request>
</HTTPService>
private function doResult(evt:ResultEvent):void
{
//此处为myhttp send后,由后台传回的数据
}

2:使用webservice
ws一般都以wsdl存在....net里可以直接执行asmx查看和测试方法 java也提供了一个xml 工具达到同样效果.确定ws成功那么就可以开始编写flex来通讯了.
<mx:WebService id="FlexSite" wsdl="http://localhost/FlexSite/Server2Flex.asmx?wsdl" showBusyCursor="true" useProxy="false">
<mx:operation name="HelloWorld" result="onWs(event)"> <!--这里对应WEBSERVICE的方法名,在我的WS里有HelloWorld暴露方法-->
<mx:request> <!--接收方法参数-->
<mx:UserName>//参数名
{name}//参数值
</mx:UserName>
</mx:request>
</mx:operation>
</mx:WebService>
private function onWs(event:ResultEvent):void
{
//得到ws的返回....
}
FlexSite.HelloWorld.send();//调用HelloWorld方法,利用onWs接收返回值

26. 经常有些人问哪种速度块些，简单做了测试列举如下
httpservice,webservice,json,remote(.net)数据服务时间比较。

名称 1 2 3 4 5 平均(s)
JSON 1672 828 765 797 807 0.9738
httpservice 2610 2547 2485 2375 2500 2.5034
webservice 2657 2328 2797 2511 2375 2.5336
remote 437 360 344 454 411 0.4012

10000条数据测试结果 



27：实现类似HTML里的<A>标签的超链接功能.
<?xml version="1.0" encoding="utf-8"?>
<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml" layout="absolute" xmlns:view="view.*" creati>
<mx:String id="test"> 
<![CDATA[<a href="event:"><u>click</u></a> label]]> 
</mx:String> 
<mx:Script>
<![CDATA[
import mx.controls.Label;
import mx.controls.Alert;
private function initApp():void
{
var lbl:Label = new Label();
lbl.htmlText = test; 
lbl.selectable = true; 
lbl.addEventListener(TextEvent.LINK, label_link); 
this.addChild(lbl);


} 
private function label_link(evt:TextEvent):void { 
Alert.show("click ."); 
//这里处理你要进行的跳转
} 

]]>
</mx:Script>
</mx:Application>

......

[阅读全文]

12个Flex常用功能代码

1。 复制内容到系统剪贴板

1. System.setClipboard(strContent);

复制代码

2。 复制一个ArrayCollection

1.    //dummy solution( well, it works )
   
2.    var bar:ArrayCollection = new ArrayCollection();
   
3.    for each ( var i:Object in ac ){
   
4.        bar.addItem( i );
   
5.    }
   
6.    // fantastic ! //
   
7.    var bar:ListCollectionView = new ListCollectionView( ListCollectionView( ac ).list );
   
8.    

复制代码

3。 打开一个新浏览器窗口

1. navigateToURL(new URLRequest('http://ntt.cc'), '_blank');

复制代码

4。 刷新浏览器

1. navigateToURL(new URLRequest("javascript:location.reload();"),"_self")

复制代码

5。 关闭浏览器

1. navigateToURL(new URLRequest("javascript:window.close()"),"_self");

复制代码

6。 设置Alert 窗口的背景为透明

1. Alert
   
2.     {
   
3.     modalTransparency:0.0;  
   
4.     modalTransparencyBlur:0;
   
5.     }

复制代码

7。 取随机颜色

1. lbl.setStyle('color', 0xffffff*Math.random());

复制代码

8。 清除子串左侧空格

1. public function LTrim(s : String):String
   
2.     {
   
3.       var i : Number = 0;
   
4.       while(s.charCodeAt(i) == 32 || s.charCodeAt(i) == 13 || s.charCodeAt(i) == 10 || s.charCodeAt(i) == 9)
   
5.       {
   
6.         i++;
   
7.       }
   
8.       return s.substring(i,s.length);
   
9.     }

复制代码

9。 清除字串右侧空格

1. public function RTrim(s : String):String
   
2.     {
   
3.       var i : Number = s.length - 1;
   
4.       while(s.charCodeAt(i) == 32 || s.charCodeAt(i) == 13 || s.charCodeAt(i) == 10 ||s.charCodeAt(i) == 9)
   
5.       {
   
6.         i--;
   
7.       }
   
8.       return s.substring(0,i+1);
   
9.     }

复制代码

10。 清除字串左右的空格

1. public function Trim(s : String):String
   
2.     {
   
3.       return LTrim(RTrim(s));
   
4.     }

复制代码

11。 获取数据类型

1. getQualifiedClassName(data)

复制代码

12。 生成随机字符串。

1. private function GenerateCheckCode():String
   
2.    {
   
3.        //init
   
4.        var ran:Number;
   
5.        var number:Number;
   
6.        var  code:String;
   
7.        var checkCode:String ="";
   
8.        //get 4 radom
   
9.       for(var i:int=0; i<4; i++)
   
10.       {
    
11.           ran=Math.random();
    
12.           number =Math.round(ran*10000);            //get result like 0.1234
    
13.           if(number % 2 == 0)
    
14.             code = String.fromCharCode(48+(number % 10));        //0's ASCII code is 48
    
15.           else
    
16.             code = String.fromCharCode(65+(number % 26)) ;        // A's ASCII code is 65
    
17.           checkCode += code;
    
18.       }
    
19.       return checkCode;
    
20.   }

复制代码

......

[阅读全文]

小工具 API 参考

本文档描述了 gadgets.* 名称空间中的类和方法，其中一些类和方法是功能特有的。如需详细信息（包括功能方面的信息），请参阅小工具规范。

注意：尽管 iGoogle Sandbox 中有 API，但 iGoogle 的生产实例尚不支持它。如果您想为 iGoogle 编写小工具，请参阅小工具 API 参考。

目录

• 类型规范
• 核心 API
  • Prefs
  • io
    • AuthorizationType
    • ContentType
    • MethodType
    • ProxyUrlRequestParameters
    • RequestParameters
  • json
  • util
• 功能所特有的 API
  • MiniMessage
  • Tab
  • TabSet
  • flash
  • pubsub
  • rpc
  • skins
    • Property
  • views
    • View
    • ViewType
  • window

返回页首

类型规范

本文档使用以下类型的规范：

Array<T> 或 Array。<T>

数组只能填入 T 类型的对象。该规范类似于 Java 类。

Map<K, V> 或 Map。<K, V>

K 类型键映射到 V 类型值的 JavaScript 对象。该规范也类似于 Java 类。它通常用于 opt_params 变量。

静态

标有静态类的类型没有公共或私有构造函数。换句话说，该类型是个名称空间，而不是可进行实例化以创建对象的类。此类型中的字段和函数也都标有静态。

布尔

布尔值（不是 Boolean 对象）。

字符串

字符串值（不是 String 对象）。

返回页首

gadgets.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)

关闭指定的消息。

 

构造函数详述

gadgets.MiniMessage

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 元素

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 已创建的消息的 HTML 元素

dismissMessage

dismissMessage(message)

关闭指定的消息。

参数：
HTMLElement message - 要删除的消息的 HTML 元素

返回页首

gadgets.Prefs 类

 概述     详述

用于获取用户首选项、模块维度和消息。客户端调用 gadgets.Prefs 的构造函数，并传入其模块 ID 作为参数，获得 gadgets.Prefs 实例。然后通过这个实例来获取其用户首选项。示例：

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

 

构造函数概述

gadgets.Prefs(opt_moduleId)

创建新首选项对象。

 

方法概述

 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

gadgets.Prefs(opt_moduleId)

创建新首选项对象。

参数：
String, Number opt_moduleId - 可选参数，用于指定要为其创建首选项的模块 ID；如果未提供该参数，则使用默认的模块 ID

方法详述

getArray

Array.<String> getArray(key)

返回数组类型用户首选项的值未以列表形式声明的 UserPref 值将作为单元素数组进行处理。

参数：
String key - 要获取的首选项

返回：
Array.<String>  首选项；如果未设置，则为空数组

getBool

Boolean getBool(key)

返回布尔类型用户首选项的值。

参数：
String key - 要获取的首选项

返回：
Boolean  首选项；如果未设置，则为 False

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)

存储首选项。要使用该调用，小工具必须使用特定功能 setprefs。

注意：如果小工具需要存储数组，则它应使用 setArray，而不是本调用。

参数：
String key - 要存储的首选项
Object val - 要存储的值

setArray

setArray(key, val)

存储数组首选项。要使用该调用，小工具必须使用特定功能 setprefs。

参数：
String key - 要存储的首选项
Array val - 要存储的值

返回页首

类 gadgets.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 元素

返回页首

类 gadgets.TabSet

概述     详述

帮助小工具创建标签的类。

构造函数概述

gadgets.TabSet(opt_moduleId, opt_defaultTab, opt_container)

创建新标签集对象

 

方法概述

 String addTab(tabName, opt_params)

根据 opt_params 中指定的名值对添加新标签。

alignTabs(align, opt_offset)

设置标签对齐方式。

displayTabs(display)

显示或隐藏标签以及所有相关内容。

 HTMLElement getHeaderContainer()

返回标签标题容器元素。

 gadgets.Tab getSelectedTab()

返回当前选定的标签对象。

 Array.<gadgets.Tab> getTabs()

返回所有现有标签对象的数组。

removeTab(tabIndex)

删除标签索引中某个标签及其所有相关内容。

setSelectedTab(tabIndex)

选中索引值为 tabIndex 的标签，如果标签存在回调函数，则触发该函数。

swapTabs(tabIndex1, tabIndex2)

将索引值为 tabIndex1 和 tabIndex2 的标签交换位置。

 

构造函数详述

gadgets.TabSet

gadgets.TabSet(opt_moduleId, opt_defaultTab, opt_container)

创建新标签集对象

参数：
String opt_moduleId - 可选的标签容器 ID 后缀
String opt_defaultTab - 可选的标签名称，用于指定在初始化之后选择的标签的名称；如果省略该参数，则默认选择第一个标签
HTMLElement opt_container - 用于包含标签的 HTML 元素；如果省略该参数，则会创建新的 div 元素并将其插入到最顶部

方法详述

addTab

String addTab(tabName, opt_params)

根据 opt_params 中指定的名值对添加新标签。opt_params 中支持以下属性：

contentContainer

要用作标签内容容器的现有 HTML 元素。如果省略该参数，则标签库会创建一个参数。

callback

选择标签时要执行的回调函数。

tooltip

当用户将鼠标光标移动到标签上时弹出的工具提示说明。

index

要插入标签的索引。如果删除该参数，则新标签会附加到末尾。

参数：
String tabName - 要创建的标签的标号
Object opt_params - 可选参数对象

返回：
String  标签容器的 DOM ID

alignTabs

alignTabs(align, opt_offset)

设置标签对齐方式。默认情况下，标签居中对齐。

参数：
String align - 'left'、 'center' 或 'right'
Number opt_offset - 可选参数，用于设置标签偏离左边界或右边界的像素数；默认值为 3 像素

displayTabs

displayTabs(display)

显示或隐藏标签以及所有相关内容。

参数：
Boolean display - 为 True 则显示标签；为 False 则隐藏标签

getHeaderContainer

HTMLElement getHeaderContainer()

返回标签标题容器元素。

返回：
HTMLElement  标签标题容器元素

getSelectedTab

gadgets.Tab getSelectedTab()

返回当前选定的标签对象。

返回：
gadgets.Tab  当前选定的标签对象

getTabs

Array.<gadgets.Tab> getTabs()

返回所有现有标签对象的数组。

返回：
Array.<gadgets.Tab>  所有现有标签对象的数组

removeTab

removeTab(tabIndex)

删除标签索引中的某个标签及其所有相关内容。

参数：
Number tabIndex - 要删除的标签的索引

setSelectedTab

setSelectedTab(tabIndex)

选中索引值为 tabIndex 的标签，如果标签存在回调函数，则触发该函数。如果已选择了该标签，则不触发回调。

参数：
Number tabIndex - 要选择的标签的索引

swapTabs

swapTabs(tabIndex1, tabIndex2)

将索引值为 tabIndex1 和 tabIndex2 的标签交换位置。选定的标签不会变化，也不会调用回调函数。

参数：
Number tabIndex1 - 要交换的第一个标签的索引
Number tabIndex2 - 要交换的第二个标签的索引

返回页首

静态类 gadgets.flash

概述     详述

在小工具中嵌入 Flash 内容。

方法概述

<static>  Boolean embedCachedFlash()

在 DOM 树中嵌入缓存的 Flash 文件。

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

在 DOM 树内嵌入 Flash 文件。

<static>  Number getMajorVersion()

检测 Flash Player 及其主版本号。

 

方法详述

embedCachedFlash

<static> Boolean embedCachedFlash()

在 DOM 树中嵌入缓存的 Flash 文件。接受 gadgets.flash.embedFlash 所接受的参数。

返回：
Boolean  函数调用是否顺利完成

embedFlash

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

在 DOM 树内嵌入 Flash 文件。

参数：
String swfUrl - SWF 网址
String, Object swfContainer - 现有 HTML 容器元素的 ID 或引用
Number swfVersion - 所需的 Flash Player 最低版本
Object opt_params - 可选对象，可包含任何有效的 HTML 参数；创建时所有属性都将传递给 Flash 影片

返回：
Boolean  函数调用是否顺利完成

getMajorVersion

<static> Number getMajorVersion()

检测 Flash Player 及其主版本号。

返回：
Number  如果不支持 Flash，则返回 Flash Player 的主要版本或 0

返回页首

静态类 gadgets.io

概述     详述

提供远程内容检索功能。

方法概述

<static>  String encodeValues(fields)

将输入对象转换为网址编码的数据字符串。

<static>  String getProxyUrl(url, opt_params)

获取传送网址的代理程序版本。

<static> makeRequest(url, callback, opt_params)

从提供的网址中获取内容并且将该内容馈送到回调函数中。

 

方法详述

encodeValues

<static> String encodeValues(fields)

将输入对象转换为网址编码的数据字符串。(key=value&...)

参数：
Object fields - 希望编码的 post 字段

返回：
String 经处理的 post 数据；该数据在末尾包含一个 & 符号

getProxyUrl

<static> String getProxyUrl(url, opt_params)

获取传送网址的代理程序版本。

参数：
String url - 用于获取代理程序网址的网址
Map<String, String> opt_params - 要传递给请求的其他可选参数

返回：
String  网址的代理程序版本

makeRequest

<static> makeRequest(url, callback, opt_params)

从提供的网址中获取内容并且将该内容馈送到回调函数中。示例：

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，则容器需要向目标服务器保证用户的身份。容器可以通过以下操作实现此目的：

1. 删除所有名称以 oauth、xoauth 或 opensocial（不区分大小写）开头的请求参数。

2. 向请求查询字符串添加以下参数：

   opensocial_viewer_id

   可选。
   当前查看者的 ID，它与查看者个人对象的 getId() 值匹配。

   opensocial_owner_id

   必需。
   当前所有者的 ID，它与所有者个人对象的 getId() 值匹配。

   opensocial_app_url

   必需。
   提出请求的应用程序的网址。当应用程序更改了网址时，容器可能对多个应用程序网址使用一个规范的应用程序网址别名。

   opensocial_instance_id

   可选。
   不透明的标识符，用于区分一个容器内同一个应用程序的多个实例。如果容器不允许同一个应用程序存在多个实例，该参数可以省略。opensocial_app_url 和 opensocial_instance_id 的组合可以唯一标识容器内一个应用程序的一个实例。

   opensocial_app_id

   可选。
   应用程序的不透明标识符（对特定容器来说是唯一的）。想要向后兼容 opensocial 0.7 规范的容器可能会包含本参数。

   xoauth_public_key

   可选。
   公共密钥的不透明标识符，用于在请求上签名。如果容器不使用公共密钥在请求上签名，或者容器根据请求的目标安排使用其他分发密钥的方法，则可以省略该参数。

3. 根据 OAuth 规范第 9 节在所得请求上签名。

gadgets.io.AuthorizationType.SIGNED 的密钥管理

如果容器使用公共密钥在请求上签名，则可以选择使用自签名证书，或使用由知名的证书签发机构签名的证书。如果容器不通过 HTTPS 分发其 OAuth 签名密钥，则应使用由知名的证书签发机构签名的证书。

证书的 commonName 属性应与容器服务器的主机名相匹配，还应与请求中指定的 oauth_consumer_key 参数的值相匹配。

容器应将其公共密钥放置在一个众所周知的位置以供下载。建议放置在 https://container-hostname/opensocial/certificates/xoauth_public_keyvalue 位置。

签名请求的接收者必须验证请求上的签名是否正确以及请求上的时间戳是否在合理的时间段内。建议时间段为当前时间的前后 5 分钟。

签名请求的接收者可以使用 oauth_consumer_key 和 xoauth_public_key 参数来自动检测容器部署新证书的时间。如果容器在一个众所周知的位置部署证书，则接收者可以自动下载新证书。自动下载新证书的接收者应该缓存所得的证书。

如果容器的证书不是从 https://container-hostname 下载的，则接收者应该在验证该证书是由知名的证书签发机构签名之后才能信任该证书。

OAuth 验证

如果 opt_params[gadgets.io.RequestParameters.AUTHORIZATION] 设置为 gadgets.io.AuthorizationType.OAUTH，则容器需要使用 OAuth 来获取访问请求中指定的资源的权限。这可能需要小工具通过指引用户从服务提供商处获取访问权限来获取用户的内容。

附加参数

以下附加参数可以通过 opt_params 指定：

gadgets.io.RequestParameters.OAUTH_SERVICE_NAME

小工具用来指代其 XML 规范中的 OAuth <服务> 元素的昵称。如果未指定，则默认为 ""。

gadgets.io.RequestParameters.OAUTH_TOKEN_NAME

小工具用来指代可授予对特殊资源的访问权限的 OAuth 令牌的昵称。如果未指定，则默认为 ""。如果小工具有权访问来自同一个服务提供商的多个资源，则可以使用多个令牌名称。例如，有权访问联系人列表和日历的小工具可以使用“联系人”令牌名称来使用联系人列表令牌，并可以使用“日历”令牌名称来使用日历令牌。

gadgets.io.RequestParameters.OAUTH_REQUEST_TOKEN

服务提供商或许能够自动为已预先获得对资源的访问权限的小工具提供请求令牌。此小工具可以将该令牌与 OAUTH_REQUEST_TOKEN 参数配合使用。该参数是可选的。

gadgets.io.RequestParameters.OAUTH_REQUEST_TOKEN_SECRET

与预先批准的请求令牌相对应的密钥。该参数是可选的。

如果使用 OAuth，则容器应代表小工具执行 OAuth 协议。如果小工具尚未注册用于该服务提供商的消费者密钥，则容器可以选择使用默认的 RSA 签名密钥（相当于知名的证书）在请求上签名。如果容器使用默认的消费者密钥，则还应加入 OAuth 参数 xoauth_app_url 来识别提出请求的小工具。

回调参数

除了由 makeRequest() 返回的正常值外，makeRequest() 回调参数还传递具有若干 OAuth 特有的域的 javascript 对象。

"oauthApprovalUrl"

如果指定了该值，则用户需要访问外部页面才能批准小工具访问数据的请求。建议使用弹出窗口引导用户转至外部页面。一旦用户批准访问，小工具便可重复进行 makeRequest 调用来检索数据。

"oauthError"

如果指定了该值，则表示发生了与 OAuth 相关的错误。该值将会是一组字符串常量中的一个，这些常量可用于以编程方式检测错误。这些常量没有针对 opensocial 0.8 定义，但是执行者应该试图商定一组有用的常量值来作为 opensocial 0.9 中的标准。

"oauthErrorText"

如果指定了该值，则表示发生了与 OAuth 相关的错误。该值为无格式文本，可用于为小工具开发人员提供调试信息。

参数：
String url - 存放内容的网址
Function callback - 提取网址后，与来自该网址的数据一起调用的函数
Map.<gadgets.io.RequestParameters, Object> opt_params - 附加的请求参数或代理请求参数

返回页首

静态类 gadgets.io.AuthorizationType

概述     详述

由 RequestParameters 使用。

Field 概述

<static> object NONE

无验证。

<static> object OAUTH

容器将使用 OAuth 进行验证。

<static> object SIGNED

请求将由容器签名。

 

Field 详述

NONE

<static> object NONE

无验证。

OAUTH

<static> object OAUTH

容器将使用 OAuth 进行验证。

SIGNED

<static> object SIGNED

请求将由容器签名。

返回页首

静态类 gadgets.io.ContentType

概述     详述

由 RequestParameters 使用。

Field 概述

<static> object DOM

返回 DOM 对象；用于获取 XML。

<static> object FEED

返回 RSS 或 Atom 供稿的 JSON 表示。

<static> object JSON

返回 JSON 对象。

<static> object TEXT

返回文本；用于获取 HTML。

 

Field 详述

DOM

<static> object DOM

返回 DOM 对象；用于获取 XML。

FEED

<static> object FEED

返回 RSS 或 Atom 供稿的 JSON 表示。

JSON

<static> object JSON

返回 JSON 对象。

TEXT

<static> object TEXT

返回文本；用于获取 HTML。

返回页首

静态类 gadgets.io.MethodType

概述     详述

定义 RequestParameters.METHOD 的值。

Field 概述

<static> object DELETE

容器对该方法类型的支持是可选的。

<static> object GET

默认类型。

<static> object HEAD

容器对该方法类型的支持是可选的。

<static> object POST

容器对该方法类型的支持是可选的。

<static> object PUT

容器对该方法类型的支持是可选的。

 

Field 详述

DELETE

<static> object DELETE

容器对该方法类型的支持是可选的。

GET

<static> object GET

默认类型。

HEAD

<static> object HEAD

容器对该方法类型的支持是可选的。

POST

<static> object POST

容器对该方法类型的支持是可选的。

PUT

<static> object PUT

容器对该方法类型的支持是可选的。

返回页首

静态类 gadgets.io.ProxyUrlRequestParameters

概述     详述

由 gadgets.io.getProxyUrl() 方法使用。

Field 概述

<static> object REFRESH_INTERVAL

尝试使用内容缓存。

 

Field 详述

REFRESH_INTERVAL

<static> object REFRESH_INTERVAL

尝试使用内容缓存。刷新间隔是我们希望缓存指定响应的秒数。默认情况下会考虑 HTTP 标头。如果没有任何 HTTP 标头，该值则默认为 3600（一个小时）。请注意，签名的请求和显示 POST_DATA 的对象通常不进行缓存。

返回页首

静态类 gadgets.io.RequestParameters

概述     详述

由 gadgets.io.makeRequest() 方法使用。

Field 概述

<static> object AUTHORIZATION

获取内容时使用的验证的类型；默认为 AuthorizationType.NONE。

<static> object CONTENT_TYPE

网址上现有内容的类型；默认为 ContentType.TEXT。

<static> object GET_SUMMARIES

内容为供稿时，是否获取该供稿的概述；默认为 False。

<static> object HEADERS

要发送到网址的 HTTP 标题；默认为 Null。

<static> object METHOD

从网址中获取内容时使用的方法；默认为 MethodType.GET。

<static> object NUM_ENTRIES

内容为供稿时要获取的条目数；默认为 3。

<static> object POST_DATA

要使用 POST 方法发送到网址的数据；默认为 Null。

 

Field 详述

AUTHORIZATION

<static> object AUTHORIZATION

获取内容时使用的验证的类型；默认为 AuthorizationType.NONE。指定为 AuthorizationType。

CONTENT_TYPE

<static> object CONTENT_TYPE

网址上现有内容的类型；默认为 ContentType.TEXT。指定为 ContentType。

GET_SUMMARIES

<static> object GET_SUMMARIES

内容为供稿时，是否获取该供稿的概述；默认为 False。指定为 Boolean。

HEADERS

<static> object HEADERS

要发送到网址的 HTTP 标题；默认为 Null。指定为 Map.<String,String>。

METHOD

<static> object METHOD

从网址获取内容时使用的方法；默认为 MethodType.GET。由 MethodType 指定的值是有效值。

NUM_ENTRIES

<static> object NUM_ENTRIES

内容为供稿时要获取的条目数；默认为 3。指定为 Number。

POST_DATA

<static> object POST_DATA

要使用 POST 方法发送到网址的数据；默认为 Null。指定为 String。

返回页首

静态类 gadgets.json

概述     详述

提供在对象和 JSON 之间相互转换的操作。

方法概述

<static>  Object parse(text)

解析 JSON 字符串，生成 JavaScript 值。

<static>  String stringify(v)

将 JavaScript 值转换为 JSON 字符串。

 

方法详述

parse

<static> Object parse(text)

解析 JSON 字符串，生成 JavaScript 值。

参数：
String text - 要转换为对象的字符串，通常为上一次字符串化调用的结果

返回：
Object  从传递的文本中解析的对象；如果出错，则为 False

stringify

<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 - 要发布的消息

subscribe

<static> subscribe(channelName, callback)

为小工具订阅消息频道。

参数：
String channelName - 频道的名称
Function callback - 通过频道消息调用的函数

unsubscribe

<static> unsubscribe(channelName)

为小工具取消订阅消息频道。

参数：
String channelName - 频道的名称

返回页首

静态类 gadgets.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 - 服务处理程序

registerDefault

<static> registerDefault(handler)

注册一个默认的服务处理程序以处理所有未知的远程程序调用，这些调用在默认情况下对失败不做任何反应。

参数：
Function handler - 服务处理程序

unregister

<static> unregister(serviceName)

取消注册 RPC 服务。

参数：
String serviceName - 要取消注册的服务名称

unregisterDefault

<static> unregisterDefault()

取消注册默认的服务处理程序。以后的未知远程程序调用对失败将不做任何反应。

返回页首

静态类 gadgets.skins

概述     详述

提供获取有关当前所显示外观的显示信息的操作。

方法概述

<static>  String getProperty(propertyKey)

获取映射至指定关键字的显示属性。

 

方法详述

getProperty

<static> String getProperty(propertyKey)

获取映射至指定关键字的显示属性。

参数：
String propertyKey - 要获取数据的关键字；关键字在 中定义 gadgets.skins.Property

返回：
String  数据

返回页首

静态类 gadgets.skins.Property

概述     详述

可以在小工具 UI 中获取和使用的所有显示值。这些显示值是 gadgets.skins.getProperty() 方法支持的关键字。

Field 概述

<static> object ANCHOR_COLOR

锚点标签应使用的颜色。

<static> object BG_COLOR

小工具的背景颜色。

<static> object BG_IMAGE

要在小工具的背景中使用的图像。

<static> object FONT_COLOR

应用来呈现主要字体的颜色。

 

Field 详述

ANCHOR_COLOR

<static> object ANCHOR_COLOR

锚点标签应使用的颜色。

BG_COLOR

<static> object BG_COLOR

小工具的背景颜色。

BG_IMAGE

<static> object BG_IMAGE

要在小工具的背景中使用的图像。

FONT_COLOR

<static> object FONT_COLOR

应用来呈现主要字体的颜色。

返回页首

静态类 gadgets.util

概述     详述

提供通用的实用工具功能。

方法概述

<static>  String escapeString(str)

使用 HTML 实体转义输入以使其更安全。

<static>  Object getFeatureParameters(feature)

返回该功能的参数的值。

<static>  Boolean hasFeature(feature)

返回指定的功能是否受支持。

<static> registerOnLoadHandler(callback)

注册装载处理程序 - 小工具加载时执行的函数。

<static>  String unescapeString(str)

反转义 escapeString

 

方法详述

escapeString

<static> String escapeString(str)

使用 HTML 实体转义输入以使其更安全。以下字符受影响：
• 新行（\n，Unicode 码点 10）
• 回车（\r，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)

注册装载处理程序 - 小工具加载时执行的函数。

参数：
Function callback - 要运行的处理程序

unescapeString

<static> String unescapeString(str)

反转义 escapeString

参数：
String str - 要反转义的字符串。

返回：
String  反转义的字符串

返回页首

静态类 gadgets.views

概述     详述

提供用于处理视图的操作。

另请参阅：gadgets.views.View

 

方法概述

<static>  String bind(urlTemplate, environment)

将网址模板与传递环境中的变量绑定在一起以生成网址字符串。

<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)

将网址模板与传递环境中的变量绑定在一起以生成网址字符串。

另请参阅：View.getUrlTemplate()

参数：
urlTemplate - 容器视图的网址模板
environment - 类型字符串的一组已命名的变量（例如，[OWNER | PATH | PARAMS | NAME]）。

返回：
String  网址字符串

getCurrentView

<static> gadgets.views.View getCurrentView()

返回当前视图。

返回：
gadgets.views.View  当前视图

getParams

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

返回已传递到此视图的该小工具中的参数。不要加入有网址参数，只加入传递至 gadgets.views.requestNavigateTo 的网址参数。

返回：
Map.<String, String>  参数映射

getSupportedViews

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

返回所有受支持的视图的映射。按照每个 gadgets.view.View 的名称添加关键字。

返回：
Map<gadgets.views.ViewType, String, gadgets.views.View>  所有受支持的视图，按照其名称属性添加关键字。

requestNavigateTo

<static> requestNavigateTo(view, opt_params, opt_ownerId)

尝试在其他视图中浏览至该小工具。如果容器支持，则参数会将可选参数传递给新视图中的小工具。

参数：
gadgets.views.View view - 要浏览的目标视图
Map.<String, String> opt_params - 在界面上浏览至小工具后，要传递到该小工具的参数
String opt_ownerId - 要浏览的目标页面所有者的 ID；默认为当前所有者

返回页首

类 gadgets.views.View

概述     详述

所有视图对象的基本界面。

方法概述

 String bind(environment)

将视图的网址模板与传递环境中的变量绑定在一起以生成网址字符串。

 gadgets.views.ViewType, String getName()

返回该视图的名称。

 String getUrlTemplate()

使用要替换的变量来返回符合 IETF 规范草稿的字符串网址模板。

 boolean isOnlyVisibleGadget()

如果该小工具是本视图中唯一可见的小工具，则返回 True。

 

方法详述

bind

String bind(environment)

将视图的网址模板与传递环境中的变量绑定在一起以生成网址字符串。

另请参阅：getUrlTemplate()

参数：
environment - 类型字符串的一组已命名的变量（例如，[OWNER | PATH | PARAMS | NAME]）。

返回：
String  网址字符串

getName

gadgets.views.ViewType, String getName()

返回该视图的名称。

返回：
gadgets.views.ViewType, String  视图名称，通常指定为 gadgets.views.ViewType

getUrlTemplate

String getUrlTemplate()

使用要替换的变量来返回符合 IETF 规范草稿的字符串网址模板。

支持以下四个变量：

name

应用程序的名称或 ID

owner

页面所有者的 ID

path

路径步骤的数组

params

关联的数组或 array[param1,value1,param2,value2,...]

示例

以下是两个有效的网址模板字符串：

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'}
}

通过这些参数，两个实例网址模板字符串可以解析出以下网址：

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  可用于构建浏览至该视图的网址的模板

isOnlyVisibleGadget

boolean isOnlyVisibleGadget()

如果该小工具是本视图中唯一可见的小工具，则返回 True。在画布页面上或最大化模式下，通常为 True；在个人资料页面上或面板模式下，通常为 False。

返回：
boolean  如果该小工具是唯一可见的小工具，则返回 True；否则，返回 False

返回页首

静态类 gadgets.views.ViewType

概述     详述

由 Views 使用。

Field 概述

<static> object CANVAS

以巨大模式显示小工具的视图。

<static> object HOME

在小区域中显示小工具的视图，其所在页面通常还包含其他小工具。

<static> object PREVIEW

小工具的演示视图。

<static> object PROFILE

在小区域中显示小工具的视图，其所在页面通常还包含其他小工具。

 

Field 详述

CANVAS

<static> object CANVAS

以巨大模式显示小工具的视图。通常是页面上的主要内容。查看者与所有者并不总是相同。

HOME

<static> object HOME

在小区域中显示小工具的视图，其所在页面通常还包含其他小工具。通常查看者与所有者相同。

PREVIEW

<static> object PREVIEW

小工具的演示视图。在该视图中，所有者和查看者均未知。

PROFILE

<static> object PROFILE

在小区域中显示小工具的视图，其所在页面通常还包含其他小工具。查看者与所有者并不总是相同。

返回页首

静态类 gadgets.window

概述     详述

提供获取有关信息以及修改放置小工具的窗口的操作。

方法概述

<static> adjustHeight(opt_height)

调整小工具高度.

<static>  Object getViewportDimensions()

检测框架的内部尺寸。

<static> setTitle(title)

设置小工具标题。

 

方法详述

adjustHeight

<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 - 首选标题

......

[阅读全文]

OpenSocial API 参考

(OpenSocial API v0.8.1)

OpenSocial JavaScript API 包括两个名称空间：opensocial.* 和 gadgets.*。本页面包含 opensocial.* 名称空间。gadgets.* 名称空间包含在小工具 API 参考中。

目录

• 类型规范

• opensocial
  • Activity
    • Field
  • Address
    • Field
  • BodyType
    • Field
  • Collection
  • CreateActivityPriority
  • DataRequest
    • DataRequestFields
    • FilterType
    • PeopleRequestFields
    • SortOrder
  • DataResponse
  • Email
    • Field
  • Enum
    • Drinker
    • Gender
    • LookingFor
    • Presence
    • Smoker
  • Environment
    • ObjectType
  • EscapeType
  • IdSpec
    • Field
    • PersonId
  • MediaItem
    • Field
    • Type
  • Message
    • Field
    • Type
  • Name
    • Field
  • NavigationParameters
    • DestinationType
    • Field
  • Organization
    • Field
  • Permission
  • Person
    • Field
  • Phone
    • Field
  • ResponseItem
    • Error
  • Url
    • Field

返回页首

类型规范

本文档使用以下类型的规范：

Array<T> 或 Array。<T>

数组只能填入 T 类型的对象。该规范类似于 Java 类。

Map<K, V> 或 Map。<K, V>

K 类型键映射到 V 类型值的 JavaScript 对象。该规范也类似于 Java 类。它通常用于 opt_params 变量。

静态

标有静态类的类型没有公共或私有构造函数。换句话说，该类型是个名称空间，而不是可进行实例化以创建对象的类。此类型中的字段和函数也都标有静态。

布尔

布尔值（不是 Boolean 对象）。

字符串

字符串值（不是 String 对象）。

返回页首

静态类 opensocial

 概述     详述

顶级用户功能的名称空间。

方法概述

<static>  opensocial.Environment getEnvironment()

获取该小工具的当前环境。

<static>  Boolean hasPermission(permission)

如果当前小工具具有指定的访问权限，则返回 True。

<static>  opensocial.Activity newActivity(params)

创建活动对象，该对象表示服务器上的活动。

<static>  opensocial.DataRequest newDataRequest()

创建用于向服务器发送和从服务器获取数据的数据请求对象。

<static>  opensocial.IdSpec newIdSpec(parameters)

创建 IdSpec 对象。

<static>  opensocial.MediaItem newMediaItem(mimeType, url, opt_params)

创建媒体项目。

<static>  opensocial.Message newMessage(body, opt_params)

创建与活动相关联的媒体项目。

<static>  opensocial.NavigationParameters newNavigationParameters(parameters)

创建 NavigationParameters 对象。

<static> requestCreateActivity(activity, priority, opt_callback)

接受一个活动作为参数并尝试创建它，而无需等待操作结束。

<static> requestPermission(permissions, reason, opt_callback)

请求用户授予指定的访问权限。

<static> requestSendMessage(recipients, message, opt_callback, opt_params)

请求容器向指定用户发送特定消息。

<static> requestShareApp(recipients, reason, opt_callback, opt_params)

请求容器与指定用户共享该小工具。

 

方法详述

getEnvironment

<static> opensocial.Environment getEnvironment()

获取该小工具的当前环境。您可以使用该环境进行以下查询：该容器支持哪些个人资料域和界面、会将哪些参数传递给当前小工具等等。

返回：
opensocial.Environment  当前环境

hasPermission

<static> Boolean hasPermission(permission)

如果当前小工具具有指定的访问权限，则返回 True。如果该小工具调用 opensocial.requestPermission 并被授予了权限，则该函数必须在所有后续调用中返回 True。

参数：
opensocial.Permission permission - 权限

返回：
Boolean  如果该小工具具有访问权限，则返回 True；否则返回 False

newActivity

<static> opensocial.Activity newActivity(params)

创建活动对象，该对象可表示服务器上的活动。

另请参阅：requestCreateActivity()。

仅需要设置 TITLE_ID 或 TITLE 中的一个。另外，如果您在标题或标题模板中使用任何变量，则必须设置 TEMPLATE_PARAMS。

其他可能要设置的域包括：URL、MEDIA_ITEMS、BODY_ID、BODY、EXTERNAL_ID、PRIORITY、STREAM_TITLE、STREAM_URL、STREAM_SOURCE_URL 和 STREAM_FAVICON_URL。

只有在使用 TITLE_ID 或 TITLE 时才需要容器，并且容器可选择忽略其他参数。

有关详细信息，请参阅域。

参数：
Map.<opensocial.Activity.Field, Object> params - 定义活动的参数

返回：
opensocial.Activity  新的活动对象

newDataRequest

<static> opensocial.DataRequest newDataRequest()

创建用于向服务器发送和从服务器获取数据的数据请求对象。

返回：
opensocial.DataRequest  请求对象

newIdSpec

<static> opensocial.IdSpec newIdSpec(parameters)

创建 IdSpec 对象。

参数：
Map.<opensocial.IdSpec.Field, Object> parameters - 定义 ID 规范的参数

返回：
opensocial.IdSpec  新的 IdSpec 对象

newMediaItem

<static> opensocial.MediaItem newMediaItem(mimeType, url, opt_params)

创建媒体项目。表示图像、电影和音频。在服务器上创建活动时使用。

参数：
String mimeType - 媒体的 MIME 类型
String url - 媒体文件的网址
Map.<opensocial.MediaItem.Field, Object> opt_params - 应在媒体项目对象上设置的其他所有域；支持所有定义的域

返回：
opensocial.MediaItem  新的媒体项目对象

newMessage

<static> opensocial.Message newMessage(body, opt_params)

创建与活动相关联的媒体项目。表示图像、电影和音频。在服务器上创建活动时使用。

参数：
String body - 消息的正文
Map.<opensocial.Message.Field, Object> opt_params - 应在消息对象上设置的其他所有域；支持所有定义的域

返回：
opensocial.Message  新的消息对象

newNavigationParameters

<static> opensocial.NavigationParameters newNavigationParameters(parameters)

创建 NavigationParameters 对象。

另请参阅：requestShareApp()

参数：
Map.<opensocial.NavigationParameters.Field, Object> parameters - 定义导航的参数

返回：
opensocial.NavigationParameters  新的 NavigationParameters 对象

requestCreateActivity

<static> requestCreateActivity(activity, priority, opt_callback)

接受一个活动作为参数并尝试创建它，而无需等待操作结束。或者，也可等操作结束后调用一个函数。

另请参阅：newActivity()

注意：如果这是为用户创建的第一个活动，并且该请求的优先级标记为“高”，则该调用可打开一个用户流并浏览到小工具以外的内容。

调用该回调，或者从头开始重新加载小工具。为该函数传递一个参数 opensocial.ResponseItem。设置错误代码以反映请求是否有问题。如果没有错，则创建活动。如果有错，则可以使用响应项目的 getErrorCode 方法来确定如何继续。响应项目的数据将不会设置。

如果容器不支持此方法，则使用 opensocial.ResponseItem 调用回调。响应项目会将其错误代码设置为 NOT_IMPLEMENTED。

参数：
opensocial.Activity activity - 要创建的活动
opensocial.CreateActivityPriority priority - 该请求的优先级
Function opt_callback - 处理请求后要调用的函数。

requestPermission

<static> requestPermission(permissions, reason, opt_callback)

请求用户授予指定的访问权限。如果容器不支持此方法，则使用 opensocial.ResponseItem 调用回调。响应项目会将其错误代码设置为 NOT_IMPLEMENTED。

参数：
Array.<opensocial.Permission> permissions - 要向查看者请求的权限
String reason - 已向用户显示的需要这些权限的原因
Function opt_callback - 处理请求后要调用的函数；调用该回调，或者从头开始重新加载小工具。为该函数传递一个参数 opensocial.ResponseItem。设置错误代码以反映请求是否有问题。如果没有错，则授予所有权限。如果有错，则可以使用 opensocial.hasPermission 以查看仍拒绝的权限。响应项目上的数据会进行设置。这将是授予的 opensocial.Permissions 的数组。

requestSendMessage

<static> requestSendMessage(recipients, message, opt_callback, opt_params)

请求容器向指定用户发送特定消息。

为该回调函数传递一个参数 opensocial.ResponseItem。设置错误代码以反映请求是否有问题。如果没有错，则发送消息。如果有错，则可以使用响应项目的 getErrorCode 方法来确定如何继续。响应项目的数据将不会设置。

如果容器不支持此方法，则使用具有错误代码 NOT_IMPLEMENTED 的 opensocial.ResponseItem 调用该回调。

参数：
Array.<String>, String recipients - ID、ID 的数组或组参考；支持的关键字包括 VIEWER、OWNER、VIEWER_FRIENDS、OWNER_FRIENDS 或这些组中某个组内的单个 ID
opensocial.Message message - 要发送给指定用户的消息
Function opt_callback - 处理请求后要调用的函数；调用该回调，或者从头开始重新加载小工具
opensocial.NavigationParameters opt_params - 可选参数，指明用户在提出请求时要向何处发送请求或何时接受请求；这些选项的类型均是 NavigationParameters.DestinationType

requestShareApp

<static> requestShareApp(recipients, reason, opt_callback, opt_params)

请求容器与指定用户共享该小工具。

为该回调函数传递一个参数 opensocial.ResponseItem。设置错误代码以反映请求是否有问题。如果没有错，则发送共享请求。如果有错，则可以使用响应项目的 getErrorCode 方法来确定如何继续。响应项目的数据将不会设置。

如果容器不支持此方法，则使用 opensocial.ResponseItem 调用回调。响应项目会将其错误代码设置为 NOT_IMPLEMENTED。

参数：
Array.<String>, String recipients - ID、ID 的数组或组参考；支持的关键字包括 VIEWER、OWNER、VIEWER_FRIENDS、OWNER_FRIENDS 或这些组中某个组内的单个 ID
opensocial.Message reason - 用户想让小工具本身共享的原因。当系统提示用户使用共享应用程序的权限时，容器可以使用该原因。也可以忽略该原因。
Function opt_callback - 处理请求后要调用的函数；调用该回调，或者从头开始重新加载小工具
opensocial.NavigationParameters opt_params - 可选参数，指明用户在提出请求时要向何处发送请求或何时接受请求；这些选项的类型均是 NavigationParameters.DestinationType

返回页首

类 opensocial.Activity

 概述     详述

活动的表示。

活动通过一个标题和一个可选活动实体呈现。

调用 opensocial.newActivity 时，可以直接将此标题和实体设置为字符串。但是，使用标题和实体的消息模板来创建活动通常有很多好处。

用户的活动流中具有许多活动，但是容器不会显示用户可以看到的每个活动。为帮助显示大量活动，容器将会总结一个活动列表，包括从指定来源到单个条目的活动。

您可以提供活动总结，以自定义在总结多个活动时显示的文本。如果未提供自定义文本，容器可能会忽略您的所有活动或提供默认文本（例如“鲍勃更改了他的状态消息 + 20 个其他与此类似的事件”）。

• 活动总结始终围绕键/值对中的特定键进行总结。因此，总结可以显示一些具体的信息（这在下面的实例中可以更清楚地看到）。
• 其他变量将会有合成的“Count”变量，这些变量是通过已总结的总项目数创建的。
• 总结的消息 ID 为主模板的消息 ID + “:”+ 数据键

总结实例：

<messagebundle>
  <msg name="LISTEN_TO_THIS_SONG:Artist">
    ${Subject.Count} of your friends have suggested listening to songs
    by ${Artist}!
  </msg>
  <msg name="LISTEN_TO_THIS_SONG:Song">
    ${Subject.Count} of your friends have suggested listening to ${Song}
  !</msg>
  <msg name="LISTEN_TO_THIS_SONG:Subject">
   ${Subject.DisplayName} has recommended ${Song.Count} songs to you.
  </msg>
</messagebundle>

 

另请参阅：opensocial.Message、opensocial.newActivity()、opensocial.requestCreateActivity()

方法概述

 String getField(key, opt_params)

获取与指定键关联的活动数据。

 String getId()

获取可以与此活动永久关联的 ID。

setField(key, data)

为这个与指定键关联的活动设置数据。

 

方法详述

getField

String getField(key, opt_params)

获取与指定键关联的活动数据。

参数：
String key - 要为其获取数据的键；请参阅 Field 类以了解可能的值
Map.<opensocial.DataRequest.DataRequestFields, Object> opt_params - 要传递给请求的其他参数。

返回：
String  数据

getId

String getId()

获取可以与此活动永久关联的 ID。

返回：
String  ID

setField

setField(key, data)

为这个与指定键关联的活动设置数据。

参数：
String key - 要为其设置数据的键
String data - 要设置的数据

返回页首

静态类 opensocial.Activity.Field

 概述     详述

活动可具有的所有域。

仅需要设置 TITLE_ID 或 TITLE 中的一个。另外，如果您在标题或标题模板中使用任何变量，则必须设置 TEMPLATE_PARAMS。

其他可能要设置的域包括：URL、MEDIA_ITEMS、BODY_ID、BODY、EXTERNAL_ID、PRIORITY、STREAM_TITLE、STREAM_URL、STREAM_SOURCE_URL 和 STREAM_FAVICON_URL。

只有在使用 TITLE_ID 或 TITLE 时才需要容器，它们可能会忽略其他参数。

另请参阅：opensocial.Activity.getField()

 

Field 概述

<static> object APP_ID

指定与该活动相关的应用程序的字符串。

<static> object BODY

指定活动的可选扩展版字符串。

<static> object BODY_ID

指定小工具规范中正文模板消息 ID 的字符串。

<static> object EXTERNAL_ID

发布应用程序生成的可选字符串 ID。

<static> object ID

与该活动永远相关的字符串 ID。

<static> object MEDIA_ITEMS

应与该活动相关的所有照片、视频或图像。

<static> object POSTED_TIME

指定戳记后该活动发生的时间（以毫秒为单位）的字符串。

<static> object PRIORITY

0 和 1 之间的数字，表示该活动相对于同一源中的其他活动的相对优先级

<static> object STREAM_FAVICON_URL

为流的图标指定网址的字符串。

<static> object STREAM_SOURCE_URL

指定流的源网址的字符串。

<static> object STREAM_TITLE

指定流的标题的字符串。

<static> object STREAM_URL

指定流的网址的字符串。

<static> object TEMPLATE_PARAMS

与该活动相关联的自定义键/值对的映射。

<static> object TITLE

指定活动的主要文本的字符串。

<static> object TITLE_ID

指定小工具规范中标题模板消息 ID 的字符串。

<static> object URL

指定代表该活动的网址的字符串。

<static> object USER_ID

该活动所针对的用户的字符串 ID。

 

Field 详述

APP_ID

<static> object APP_ID

指定与该活动相关的应用程序的字符串。无法设置该值。

BODY

<static> object BODY

指定活动的可选扩展版字符串。

正文仅可能包含以下 HTML 标签：<b>、<i>、<a> 和 <span>。呈现该活动时，容器可能会忽略此格式。

BODY_ID

<static> object BODY_ID

指定小工具规范中正文模板消息 ID 的字符串。

正文是活动的可选扩展版。

正文仅可能包含以下 HTML 标签：<b>、<i>、<a> 和 <span>。呈现该活动时，容器可能会忽略此格式。

EXTERNAL_ID

<static> object EXTERNAL_ID

发布应用程序生成的可选字符串 ID。

ID

<static> object ID

与该活动永远相关的字符串 ID。无法设置该值。

MEDIA_ITEMS

<static> object MEDIA_ITEMS

应与该活动相关的所有照片、视频或图像。具有较高优先级的参数在列表中处于靠前的位置。数据的类型为 Array< MediaItem>。

POSTED_TIME

<static> object POSTED_TIME

指定戳记后该活动发生的时间（以毫秒为单位）的字符串。无法设置该值。

PRIORITY

<static> object PRIORITY

0 和 1 之间的数字，表示该活动相对于同一源中的其他活动的相对优先级

STREAM_FAVICON_URL

<static> object STREAM_FAVICON_URL

为流的图标指定网址的字符串。

STREAM_SOURCE_URL

<static> object STREAM_SOURCE_URL

指定流的源网址的字符串。

STREAM_TITLE

<static> object STREAM_TITLE

指定流的标题的字符串。

STREAM_URL

<static> object STREAM_URL

指定流的网址的字符串。

TEMPLATE_PARAMS

<static> object TEMPLATE_PARAMS

与该活动相关联的自定义键/值对的映射。这些值将用于在模板中进行评估。

数据的类型为 Map<String, Object>。该对象可以是字符串也可以是 opensocial.Person。

用户传递键 PersonKey 时，可以在模板中使用以下替代变量：

• PersonKey.DisplayName - 显示人物的名称
• PersonKey.ProfileUrl。人物个人资料的网址
• PersonKey.Id - 人物的 ID
• PersonKey - 容器可使用 DisplayName 将其替换掉，也可选择链接至该用户。

TITLE

<static> object TITLE

指定活动的主要文本的字符串。

标题仅可能包含以下 HTML 标签：<b>、<i>、<a> 和 <span>。呈现该活动时，容器可能会忽略此格式。

TITLE_ID

<static> object TITLE_ID

指定小工具规范中标题模板消息 ID 的字符串。

标题是活动的主要文本。

标题仅可能包含以下 HTML 标签：<b>、<i>、<a> 和 <span>。呈现该活动时，容器可能会忽略此格式。

URL

<static> object URL

指定代表该活动的网址的字符串。

USER_ID

<static> object USER_ID

该活动所针对的用户的字符串 ID。无法设置该值。

返回页首

类 opensocial.Address

 概述     详述

所有地址对象的基本接口。

方法概述

 String getField(key, opt_params)

获取这个与指定关键字关联的实体类型的数据。

 

方法详述

getField

String getField(key, opt_params)

获取这个与指定关键字关联的实体类型的数据。

参数：
String key - 要获取数据的关键字；关键字在 Address.Field中定义
Map.<opensocial.DataRequest.DataRequestFields, Object> opt_params - 要传递给请求的其他参数

返回：
String  数据

返回页首

静态类 opensocial.Address.Field

 概述     详述

地址具有的所有域。这些域是 Address.getField() 方法支持的键。

Field 概述

<static> object COUNTRY

国家/地区，指定为字符串。

<static> object EXTENDED_ADDRESS

详细的街道地址，指定为字符串。

<static> object LATITUDE

纬度，指定为数字。

<static> object LOCALITY

地区，指定为字符串，一般可用来记录较小的地区观念，如城市名等。

<static> object LONGITUDE

经度，指定为数字。

<static> object PO_BOX

邮局

<static> object POSTAL_CODE

邮政编码，指定为字符串。

<static> object REGION

区域，指定为字符串，一般可用来记录较大的区域观念，如省名等。

<static> object STREET_ADDRESS

街道地址，指定为字符串。

<static> object TYPE

地址类型或标号，指定为字符串。

<static> object UNSTRUCTURED_ADDRESS

如果容器的数据存储中没有结构化的地址，则此域会包含用户输入的、指定为字符串的未结构化地址。

 

Field 详述

COUNTRY

<static> object COUNTRY

国家/地区，指定为字符串。

EXTENDED_ADDRESS

<static> object EXTENDED_ADDRESS

详细的街道地址，指定为字符串。

LATITUDE

<static> object LATITUDE

纬度，指定为数字。

LOCALITY

<static> object LOCALITY

地区，指定为字符串，一般可用来记录较小的地区观念，如城市名等。

LONGITUDE

<static> object LONGITUDE

经度，指定为数字。

PO_BOX

<static> object PO_BOX

该地址的邮政信箱（如果存在）；指定为字符串。

POSTAL_CODE

<static> object POSTAL_CODE

邮政编码，指定为字符串。

REGION

<static> object REGION

区域，指定为字符串，一般可用来记录较大的区域观念，如省名等。

STREET_ADDRESS

<static> object STREET_ADDRESS

街道地址，指定为字符串。

TYPE

<static> object TYPE

地址类型或标号，指定为字符串。例如：工作、我最喜欢的商店、我的住房等

UNSTRUCTURED_ADDRESS

<static> object UNSTRUCTURED_ADDRESS

如果容器的数据存储中没有结构化的地址，则此域包含用户输入的、指定为字符串的、未结构化地址。使用 opensocial.getEnvironment().supportsField 查看哪些域受支持。

返回页首

类 opensocial.BodyType

 概述     详述

所有实体类型对象的基本接口。

方法概述

 String getField(key, opt_params)

获取这个与指定关键字关联的实体类型的数据。

 

方法详述

getField

String getField(key, opt_params)

获取与指定的关键字关联的此实体类型的数据。

参数：
String key - 要获取数据的关键字；关键字在 BodyType.Field中定义
Map.<opensocial.DataRequest.DataRequestFields, Object> opt_params - 要传递给请求的其他参数。

返回：
String  数据

返回页首

静态类 opensocial.BodyType.Field

 概述     详述

实体类型具有的所有域。这些域是 BodyType.getField() 方法支持的关键字。

Field 概述

<static> object BUILD

人的体形，指定为字符串。

<static> object EYE_COLOR

人的眼睛颜色，指定为字符串。

<static> object HAIR_COLOR

人的头发颜色，指定为字符串。

<static> object HEIGHT

人的身高（以米为单位），指定为数字。

<static> object WEIGHT

人的体重（以千克为单位），指定为数字。

 

Field 详述

BUILD

<static> object BUILD

人的体形，指定为字符串。容器对该域的支持是可选的。

EYE_COLOR

<static> object EYE_COLOR

人的眼睛颜色，指定为字符串。容器对该域的支持是可选的。

HAIR_COLOR

<static> object HAIR_COLOR

人的头发颜色，指定为字符串。容器对该域的支持是可选的。

HEIGHT

<static> object HEIGHT

人的身高（以米为单位），指定为数字。容器对该域的支持是可选的。

WEIGHT

<static> object WEIGHT

人的体重（以千克为单位），指定为数字。容器对该域的支持是可选的。

返回页首

类 opensocial.Collection

 概述     详述

具有实用存取器的多个对象的集合。还可以代表较大集合的子集（例如，第 1 页，共 10 页）并包含有关该较大集合的信息。

方法概述

 Array.<Object> asArray()

返回该集合中所有对象的数组。

each(fn)

对该集合的每个成员都执行一次提供的函数功能（根据函数的参数对每个成员轮流执行）。

 Object? getById(id)

查找具有指定 ID 值的条目，如果找不到任何条目，则返回 Null。

 Number getOffset()

获取该集合在较大结果集中的偏移。

 Number getTotalSize()

获取该集合所属的较大结果集的总大小。

 Number size()

获取该集合的大小，该大小等于或小于结果的总大小。

 

方法详述

asArray

Array.<Object> asArray()

返回该集合中所有对象的数组。

返回：
Array.<Object>  该集合中的值

每个

each(fn)

对该集合的每个成员都执行一次提供的函数功能（根据函数的参数对每个成员轮流执行）。

参数：
Function fn - 要通过每个集合条目调用的函数

getById

Object? getById(id)

查找具有指定 ID 值的条目，如果找不到任何条目，则返回 Null。

参数：
String id - 要查找的 ID

返回：
Object?  数据

getOffset

Number getOffset()

获取该集合在较大结果集中的偏移。

返回：
Number  在总集合中的偏移

getTotalSize

Number getTotalSize()

获取该集合所属的较大结果集的总大小。

返回：
Number  结果的总大小

大小

Number size()

获取该集合的大小，该大小等于或小于结果的总大小。

返回：
Number  该集合的大小

返回页首

静态类 opensocial.CreateActivityPriority

 概述     详述

创建活动请求可能具有的属性。

另请参阅：opensocial.requestCreateActivity()

 

Field 概述

<static> object HIGH

如果活动非常重要，则即使在其需要请求获得用户许可的情况下也会创建该活动。

<static> object LOW

如果活动不是很重要，则在用户尚未授予用于创建活动的当前应用程序许可的情况下，不会创建该活动。

 

Field 详述

HIGH

<static> object HIGH

如果活动非常重要，则即使在其需要请求获得用户许可的情况下也会创建该活动。这可能使容器打开一个用户流，从而可能将您导航至小工具以外的窗口。

LOW

<static> object LOW

如果活动不是很重要，则在用户尚未授予用于创建活动的当前应用程序许可的情况下，不会创建该活动。在此优先级下，requestCreateActivity 调用将不会打开用户流。

返回页首

类 opensocial.DataRequest

 概述     详述

用于从容器请求社交信息。社交信息包括好友的数据、个人资料、应用程序数据和活动。需要访问用户信息的所有应用程序应发送 DataRequest。

以下是一个创建、初始化、发送数据请求并处理相应结果的实例：

function requestMe() {
  var req = opensocial.newDataRequest();
  req.add(req.newFetchPersonRequest(
            opensocial.IdSpec.PersonId.VIEWER),
          "viewer");
  req.send(handleRequestMe);
};

function handleRequestMe(data) {
  var viewer = data.get("viewer");
  if (viewer.hadError()) {
    //Handle error using viewer.getError()...
    return;
  }

  //No error. Do something with viewer.getData()...
}

另请参阅： opensocial.newDataRequest()

 

方法概述

add(request, opt_key)

添加项目以从服务器提取（获取）或更新（设置）数据。

 Object newFetchActivitiesRequest(idSpec, opt_params)

创建项目以向服务器请求活动流。

 Object newFetchPeopleRequest(idSpec, opt_params)

创建项目以向服务器请求好友。

 Object newFetchPersonAppDataRequest(idSpec, keys, opt_params)

创建项目以请求指定用户的应用程序数据。

 Object newFetchPersonRequest(id, opt_params)

创建项目以请求指定用户 ID 的个人资料。

 Object newRemovePersonAppDataRequest(id, keys)

从数据库中为指定用户删除指定的键。

 Object newUpdatePersonAppDataRequest(id, key, value)

创建项目以请求更新指定用户的应用程序域。

send(opt_callback)

向服务器发送数据请求以获取数据响应。

 

方法详述

add

add(request, opt_key)

添加项目以从服务器提取（获取）或更新（设置）数据。单个 DataRequest 对象可以具有多个项目。通常，从添加的第一个项目开始，按照项目的添加顺序执行每个项目。但是，有些不冲突的项目也可以并行执行。

参数：
Object request - 指定要提取或更新的数据
String opt_key - 要将生成的响应数据映射过去的目标键

newFetchActivitiesRequest

Object newFetchActivitiesRequest(idSpec, opt_params)

创建项目以向服务器请求活动流。

处理完以后，返回 Collection<Activity>。

参数：
opensocial.IdSpec idSpec - 用于指定要获取的用户的 IdSpec。另请参阅 IdSpec。
Map.<opensocial.DataRequest.ActivityRequestFields, Object> opt_params - 要传递给请求的其他参数；当前并未使用

返回：
Object  请求对象

newFetchPeopleRequest

Object newFetchPeopleRequest(idSpec, opt_params)

创建项目以向服务器请求好友。处理完以后，返回 Collection<Person> 对象。

参数：
opensocial.IdSpec idSpec - 用于指定要获取的用户的 IdSpec。另请参阅 IdSpec。
Map.<opensocial.DataRequest.PeopleRequestFields, Object> opt_params - 要传递给请求的其他参数

返回：
Object  请求对象

newFetchPersonAppDataRequest

Object newFetchPersonAppDataRequest(idSpec, keys, opt_params)

创建项目以请求指定用户的应用程序数据。处理完以后，返回 Map< PersonId, Map<String, Object>> 对象。所有返回的数据值均是有效的 json。

参数：
opensocial.IdSpec idSpec - 用于指定要获取的用户的 IdSpec。另请参阅 IdSpec。
Array.<String>, String keys - 要为其获取数据的键；它可以是键名称数组、键名称，也可以是表示“所有键”的“*”。
Map.<opensocial.DataRequest.DataRequestFields, Object> opt_params - 要传递给请求的其他参数

返回：
Object  请求对象

newFetchPersonRequest

Object newFetchPersonRequest(id, opt_params)

创建项目以请求指定用户 ID 的个人资料。处理完以后，返回 Person 对象。

参数：
String id - 要获取的用户的 ID；可以是 VIEWER 或 OWNER 的标准用户 ID。
Map.<opensocial.DataRequest.PeopleRequestFields, Object> opt_params - 要传递给请求的其他参数；该请求支持 PROFILE_DETAILS

返回：
Object  请求对象

newRemovePersonAppDataRequest

Object newRemovePersonAppDataRequest(id, keys)

从数据库中为指定用户删除指定的键。处理后，不返回任何数据。

参数：
String id - 要更新的用户的 ID；当前仅允许更新特殊的 VIEWER ID。
Array.<String>, String keys - 您要从数据库中删除的键；它可以是键名称数组、键名称，也可以是表示“所有键”的“*”。

返回：
Object  请求对象

newUpdatePersonAppDataRequest

Object newUpdatePersonAppDataRequest(id, key, value)

创建项目以请求更新指定用户的应用程序域。处理后，不返回任何数据。

参数：
String id - 要更新的用户的 ID；当前仅允许更新特殊的 VIEWER ID。
String key - 键的名称。名称中只能包含字母或数字（A-Z、a-z 或 0-9）字符、下划线 (_)、点 (.) 或破折号 (-)。
Object value - 值，必须是有效的 json

返回：
Object  请求对象

send

send(opt_callback)

向服务器发送数据请求以获取数据响应。尽管服务器可能会优化这些请求，但是它们将始终像序列一样执行。

参数：
Function opt_callback - 要通过服务器生成的数据响应调用的函数

返回页首

静态类 opensocial.DataRequest.DataRequestFields

 概述     详述

Field 概述

<static> object ESCAPE_TYPE

如何转义从服务器返回的用户数据；默认为 HTML_ESCAPE。

 

Field 详述

ESCAPE_TYPE

<static> object ESCAPE_TYPE

如何转义从服务器返回的用户数据；默认为 HTML_ESCAPE。可能值由 EscapeType 定义。

返回页首

静态类 opensocial.DataRequest.FilterType

 概述     详述

可用于限制人员请求的过滤器。

Field 概述

<static> object ALL

检索所有好友。

<static> object HAS_APP

检索所有使用该应用程序的好友。

<static> object TOP_FRIENDS

仅检索容器定义的用户的密友。

 

Field 详述

ALL

<static> object ALL

检索所有好友。

HAS_APP

<static> object HAS_APP

检索所有使用该应用程序的好友。注意：容器可以通过自认为适合自身功能的任何方式来定义“use”，它不会期望各容器中的该域都具有准确相同的语法。

TOP_FRIENDS

<static> object TOP_FRIENDS

仅检索容器定义的用户的密友。容器对该过滤器类型的支持是可选的。

返回页首

静态类 opensocial.DataRequest.PeopleRequestFields

 概述     详述

Field 概述

<static> object FILTER

如何过滤 People 对象；默认为 ALL。

<static> object FILTER_OPTIONS

其他要传递到过滤器中的选项，指定为 Map<String, Object>。

<static> object FIRST

编页码时，要获取的第一个项目的索引；指定为数字。

<static> object MAX

要获取的最大项目数，指定为数字；默认为 20。

<static> object PROFILE_DETAILS

opensocial.Person.Field 数组，它指定要获取每个人物对象的哪些个人资料数据。

<static> object SORT_ORDER

People 对象的排序顺序；默认为 TOP_FRIENDS。

 

Field 详述

FILTER

<static> object FILTER

如何过滤 People 对象；默认为 ALL。可能值由 FilterType 定义。

FILTER_OPTIONS

<static> object FILTER_OPTIONS

其他要传递到过滤器中的选项，指定为 Map<String, Object>。

FIRST

<static> object FIRST

编页码时，要获取的第一个项目的索引；指定为数字。

MAX

<static> object MAX

要获取的最大项目数，指定为数字；默认为 20。如果设置为更大的数字，则容器可能会执行此请求，也可能将此数字限制为容器指定的限值（最少为 20）。

PROFILE_DETAILS

<static> object PROFILE_DETAILS

opensocial.Person.Field中定义 数组，它指定要获取每个人物对象的哪些个人资料数据。服务器将始终包含 ID、NAME 和 THUMBNAIL_URL。

SORT_ORDER

<static> object SORT_ORDER

People 对象的排序顺序；默认为 TOP_FRIENDS。可能值由 SortOrder 定义。

返回页首

静态类 opensocial.DataRequest.SortOrder

 概述     详述

用于对人物对象进行排序的排列顺序。

Field 概述

<static> object NAME

使用该类时，将按姓名域以字母顺序对用户进行排序。

<static> object TOP_FRIENDS

使用该类时，将按顶部好友的容器定义对用户进行排序。

 

Field 详述

NAME

<static> object NAME

使用该类时，将按姓名域以字母顺序对用户进行排序。

TOP_FRIENDS

<static> object TOP_FRIENDS

使用该类时，将按顶部好友的容器定义对用户进行排序。

返回页首

类 opensocial.DataResponse

 概述     详述

该对象包含映射至请求的关键字的请求的服务器数据。

另请参阅：DataRequest

 

方法概述

 opensocial.ResponseItem get(key)

获取请求的字段的 ResponseItem。

 String getErrorMessage()

如果整个请求包含批层次错误，则返回错误消息。

 Boolean hadError()

如果从服务器中获取该数据时出错，将返回 True。

 

方法详述

get

opensocial.ResponseItem get(key)

获取请求的字段的 ResponseItem。

参数：
key

返回：
opensocial.ResponseItem  由服务器计算的请求的响应

getErrorMessage

String getErrorMessage()

如果整个请求包含批层次错误，则返回错误消息。

返回：
String  对已发生错误所做的用户可阅读的描述。

hadError

Boolean hadError()

如果从服务器中获取该数据时出错，将返回 True。

返回：
Boolean  如果出错，则返回 True；否则返回 False

返回页首

类 opensocial.Email

 概述     详述

所有电子邮件对象的基本接口。

方法概述

 String getField(key, opt_params)

获取与指定的关键字关联的此实体类型的数据。

 

方法详述

getField

String getField(key, opt_params)

获取与指定的关键字关联的此实体类型的数据。

参数：
String key - 要获取数据的关键字；关键字在 Email.Field中定义
Map.<opensocial.DataRequest.DataRequestFields, Object> opt_params - 要传递给请求的其他参数。

返回：
String  数据

返回页首

静态类 opensocial.Email.Field

 概述     详述

电子邮件具有的所有域。这些域是 Email.getField() 方法支持的关键字。

Field 概述

<static> object ADDRESS

电子邮件地址，指定为字符串。

<static> object TYPE

电子邮件类型或标号，指定为字符串。

 

Field 详述

ADDRESS

<static> object ADDRESS

电子邮件地址，指定为字符串。

TYPE

<static> object TYPE

电子邮件类型或标号，指定为字符串。例如：工作、我最喜欢的商店、我的住房等

返回页首

类 opensocial.Enum

 概述     详述

所有枚举对象的基本接口。该类允许容器对通常具有一组通用值的域使用常量。有两种主要方式可以使用该类。

如果您的小工具只需要显示某人的吸烟量，则可以简单使用如下：

html = "This person smokes: " + person.getField('smoker').getValue();

此值域将由该容器正确设置。容器甚至可以在该位置本地化小工具的值，以便其始终显示正确的内容。

如果您的小工具需要有关吸烟者域的逻辑，则可以使用：

if (person.getField('smoker').getKey() != "NO") { //gadget logic here }

注意：如果某人的吸烟者域无法被强制为某个标准的枚举类型，则该关键字可能为 Null。而该值从不为空。

 

方法概述

 String getDisplayValue()

此枚举的值。

 String getKey()

将该值用于小工具中的逻辑。

 

方法详述

getDisplayValue

String getDisplayValue()

此枚举的值。该值将是用户可显示的字符串。如果容器支持本地化，则该字符串将被本地化。

返回：
String  枚举的值。

getKey

String getKey()

将该值用于小工具中的逻辑。如果该关键字为空，则该值不适合定义的枚举。

返回：
String  枚举的关键字。该关键字应是以下定义的枚举之一。

返回页首

静态类 opensocial.Enum.Drinker

 概述     详述

饮酒者域所用的枚举键。

另请参阅：opensocial.Person.Field.Drinker

 

Field 概述

<static> object HEAVILY

<static> object NO

<static> object OCCASIONALLY

<static> object QUIT

<static> object QUITTING

<static> object REGULARLY

<static> object SOCIALLY

<static> object YES

 

Field 详述

HEAVILY

<static> object HEAVILY

NO

<static> object NO

OCCASIONALLY

<static> object OCCASIONALLY

QUIT

<static> object QUIT

QUITTING

<static> object QUITTING

REGULARLY

<static> object REGULARLY

SOCIALLY

<static> object SOCIALLY

YES

<static> object YES

返回页首

静态类 opensocial.Enum.Gender

 概述     详述

性别域所用的枚举键。

另请参阅：opensocial.Person.Field.Gender

 

Field 概述

<static> object FEMALE

<static> object MALE

 

Field 详述

女性

<static> object FEMALE

男性

<static> object MALE

返回页首

静态类 opensocial.Enum.LookingFor

 概述     详述

查找域所用的枚举关键字。

另请参阅：opensocial.Person.Field.LookingFor

 

Field 概述

<static> object ACTIVITY_PARTNERS

<static> object DATING

<static> object FRIENDS

<static> object NETWORKING

<static> object RANDOM

<static> object RELATIONSHIP

 

Field 详述

ACTIVITY_PARTNERS

<static> object ACTIVITY_PARTNERS

DATING

<static> object DATING

FRIENDS

<static> object FRIENDS

NETWORKING

<static> object NETWORKING

RANDOM

<static> object RANDOM

RELATIONSHIP

<static> object RELATIONSHIP

返回页首

静态类 opensocial.Enum.Presence

 概述     详述

网络显示状态域所用的枚举关键字。

另请参阅：opensocial.Person.Field.NetworkPresence

 

Field 概述

<static> object AWAY

实体或资源临时离开。

<static> object CHAT

实体或资源非常希望聊天。

<static> object DND

实体或资源很忙（dnd =“请勿打扰”）。

<static> object OFFLINE

实体或资源离线。

<static> object ONLINE

实体或资源在线。

<static> object XA

实体或资源离开一段时间（xa =“长久离开”）。

 

Field 详述

AWAY

<static> object AWAY

实体或资源临时离开。

CHAT

<static> object CHAT

实体或资源非常希望聊天。

DND

<static> object DND

实体或资源很忙（dnd =“请勿打扰”）。

OFFLINE

<static> object OFFLINE

实体或资源离线。

ONLINE

<static> object ONLINE

实体或资源在线。

XA

<static> object XA

实体或资源离开一段时间（xa =“长久离开”）。

返回页首

静态类 opensocial.Enum.Smoker

 概述     详述

吸烟者域所用的枚举键。

另请参阅：opensocial.Person.Field.Smoker

 

Field 概述

<static> object HEAVILY

<static> object NO

<static> object OCCASIONALLY

<static> object QUIT

<static> object QUITTING

<static> object REGULARLY

<static> object SOCIALLY

<static> object YES

 

Field 详述

HEAVILY

<static> object HEAVILY

NO

<static> object NO

OCCASIONALLY

<static> object OCCASIONALLY

QUIT

<static> object QUIT

QUITTING

<static> object QUITTING

REGULARLY

<static> object REGULARLY

SOCIALLY

<static> object SOCIALLY

YES

<static> object YES

返回页首

类 opensocial.Environment

 概述     详述

表示小工具的当前环境。

另请参阅：opensocial.getEnvironment()

方法概述

 String getDomain()

返回当前域，例如“orkut.com”或“myspace.com”。

 Boolean supportsField(objectType, fieldName)

如果此容器中指定对象类型支持指定的域，则返回 True。

 

方法详述

getDomain

String getDomain()

返回当前域，例如“orkut.com”或“myspace.com”。

返回：
String  域

supportsField

Boolean supportsField(objectType, fieldName)

如果此容器中指定对象类型支持指定的域，则返回 True。

参数：
opensocial.Environment.ObjectType objectType - 要针对此域检查的对象类型
String fieldName - 要检查的域的名称

返回：
Boolean  如果指定的对象类型支持此域，则返回 True

返回页首

静态类 opensocial.Environment.ObjectType

 概述     详述

该容器中对象的类型。

另请参阅：Environment.supportsField()

Field 概述

<static> object ACTIVITY

<static> object ADDRESS

<static> object BODY_TYPE

<static> object EMAIL

<static> object FILTER_TYPE

<static> object MEDIA_ITEM

<static> object MESSAGE

<static> object MESSAGE_TYPE

<static> object NAME

<static> object ORGANIZATION

<static> object PERSON

<static> object PHONE

<static> object SORT_ORDER

<static> object URL

 

Field 详述

ACTIVITY

<static> object ACTIVITY

ADDRESS

<static> object ADDRESS

BODY_TYPE

<static> object BODY_TYPE

EMAIL

<static> object EMAIL

FILTER_TYPE

<static> object FILTER_TYPE

MEDIA_ITEM

<static> object MEDIA_ITEM

MESSAGE

<static> object MESSAGE

MESSAGE_TYPE

<static> object MESSAGE_TYPE

NAME

<static> object NAME

ORGANIZATION

<static> object ORGANIZATION

PERSON

<static> object PERSON

PHONE

<static> object PHONE

SORT_ORDER

<static> object SORT_ORDER

URL

<static> object URL

返回页首

静态类 opensocial.EscapeType

 概述     详述

可应用于人物数据或域的转义类型。

Field 概述

<static> object HTML_ESCAPE

如果使用该值，则使用 HTML 转义数据。

<static> object NONE

如果使用该值，则不转义数据。

 

Field 详述

HTML_ESCAPE

<static> object HTML_ESCAPE

如果使用该值，则使用 HTML 转义数据。

NONE

<static> object NONE

如果使用该值，则不转义数据。

返回页首

类 opensocial.IdSpec

 概述     详述

所有 ID 规范对象的基本接口。

方法概述

 String getField(key, opt_params)

获取与指定关键字相关联的 ID 规范的数据。

setField(key, data)

为这个与指定关键字相关联的 ID 规范设置数据。

 

方法详述

getField

String getField(key, opt_params)

获取与指定关键字相关联的 ID 规范的数据。

参数：
String key - 要为其获取数据的键；请参阅 Field 类以了解可能的值
Map.<opensocial.DataRequest.DataRequestFields, Object> opt_params - 要传递给请求的其他参数。

返回：
String  数据

setField

setField(key, data)

为这个与指定关键字相关联的 ID 规范设置数据。

参数：
String key - 要为其设置数据的键
String data - 要设置的数据

返回页首

静态类 opensocial.IdSpec.Field

 概述     详述

ID 规范可以具有的所有域。

另请参阅：opensocial.IdSpec.getField()

 

Field 概述

<static> object GROUP_ID

表示组 ID 的字符串。

<static> object NETWORK_DISTANCE

可选的数字参数，用于指定两个人之间允许存在多少次“跳跃”后仍视为在同一组内。

<static> object USER_ID

表示用户 ID 的字符串或字符串数组。

 

Field 详述

GROUP_ID

<static> object GROUP_ID

表示组 ID 的字符串。

NETWORK_DISTANCE

<static> object NETWORK_DISTANCE

可选的数字参数，用于指定两个人之间允许存在多少次“跳跃”后仍视为在同一组内。该值以 0 为基础，例如：值为 0 表示两个人是同一个人。1 则表示两个人是好友。而 2 表示好友的好友关系。默认为 1（他们是好友或直接位于同一组内）。并非所有容器都支持 networkDistances 大于 1。

USER_ID

<static> object USER_ID

表示用户 ID 的字符串或字符串数组。

返回页首

静态类 opensocial.IdSpec.PersonId

 概述     详述

获取人物信息时可用的常用用户 ID。

Field 概述

<static> object OWNER

<static> object VIEWER

 

Field 详述

OWNER

<static> object OWNER

VIEWER

<static> object VIEWER

返回页首

类 opensocial.MediaItem

 概述     详述

表示图像、电影和音频。使用 opensocial.newMediaItem() 方法创建 MediaItem 对象。

方法概述

 String getField(key, opt_params)

获取与指定键关联的媒体项目数据。

setField(key, data)

为这个与指定键关联的媒体项目设置数据。

 

方法详述

getField

String getField(key, opt_params)

获取与指定键关联的媒体项目数据。

参数：
String key - 要为其获取数据的键；请参阅 Field 类以了解可能的值
Map.<opensocial.DataRequest.DataRequestFields, Object> opt_params - 要传递给请求的其他参数。

返回：
String  数据

setField

setField(key, data)

为这个与指定键关联的媒体项目设置数据。

参数：
String key - 要为其设置数据的键
String data - 要设置的数据

返回页首

静态类 opensocial.MediaItem.Field

 概述     详述

媒体项目具有的所有域。

另请参阅：opensocial.MediaItem.getField()

 

Field 概述

<static> object MIME_TYPE

媒体的 MIME 类型，指定为字符串。

<static> object TYPE

媒体的类型，指定为 MediaItem.Type 对象。

<static> object URL

指定可以找到此媒体的网址的字符串。

 

Field 详述

MIME_TYPE

<static> object MIME_TYPE

媒体的 MIME 类型，指定为字符串。

TYPE

<static> object TYPE

媒体的类型，指定为 MediaItem.Type 对象。

URL

<static> object URL

指定可以找到此媒体的网址的字符串。

返回页首

静态类 opensocial.MediaItem.Type

 概述     详述

媒体项目的可用类型。

另请参阅：opensocial.MediaItem.Field

 

Field 概述

<static> object AUDIO

<static> object IMAGE

<static> object VIDEO

 

Field 详述

AUDIO

<static> object AUDIO

IMAGE

<static> object IMAGE

VIDEO

<static> object VIDEO

返回页首

类 opensocial.Message

 概述     详述

所有消息对象的基本接口。*

另请参阅：opensocial.newMessage()、opensocial.requestSendMessage()

方法概述

 String getField(key, opt_params)

获取与指定键关联的消息数据。

setField(key, data)

为这个与指定键关联的消息设置数据。

 

方法详述

getField

String getField(key, opt_params)

获取与指定键关联的消息数据。

参数：
String key - 要为其获取数据的键；请参阅 Field 类以了解可能的值
Map.<opensocial.DataRequest.DataRequestFields, Object> opt_params - 要传递给请求的其他参数。

返回：
String  数据

setField

setField(key, data)

为这个与指定键关联的消息设置数据。

参数：
String key - 要为其设置数据的键
String data - 要设置的数据

返回页首

静态类 opensocial.Message.Field

 概述     详述

消息可以具有的所有域。

另请参阅：opensocial.Message.getField()

 

Field 概述

<static> object BODY

消息的主要文本。

<static> object BODY_ID

作为消息模板的消息正文。

<static> object TITLE

消息的标题。

<static> object TITLE_ID

作为消息模板的消息标题。

<static> object TYPE

消息的标题，指定为 opensocial.Message.Type。

 

Field 详述

BODY

<static> object BODY

消息的主要文本。HTML 属性由容器来批准和清理。

BODY_ID

<static> object BODY_ID

作为消息模板的消息正文。指定要在小工具 XML 中使用的消息 ID。

TITLE

<static> object TITLE

消息的标题。HTML 属性由容器来批准和清理。

TITLE_ID

<static> object TITLE_ID

作为消息模板的消息标题。指定要在小工具 XML 中使用的消息 ID。

TYPE

<static> object TYPE

消息的标题，指定为 opensocial.Message.Type。

返回页首

静态类 opensocial.Message.Type

 概述     详述

可以发送的消息的类型。

Field 概述

<static> object EMAIL

电子邮件。

<static> object NOTIFICATION

私人短消息。

<static> object PRIVATE_MESSAGE

发送给特定用户且只有该用户可以看到的消息。

<static> object PUBLIC_MESSAGE

发送给某特定用户但可被多个用户看到的消息。

 

Field 详述

EMAIL

<static> object EMAIL

电子邮件。

NOTIFICATION

<static> object NOTIFICATION

私人短消息。

PRIVATE_MESSAGE

<static> object PRIVATE_MESSAGE

发送给特定用户且只有该用户可以看到的消息。

PUBLIC_MESSAGE

<static> object PUBLIC_MESSAGE

发送给某特定用户但可被多个用户看到的消息。

返回页首

类 opensocial.Name

 概述     详述

所有名称对象的基本接口。

方法概述

 String getField(key, opt_params)

获取这个与指定键关联的名称的数据。

 

方法详述

getField

String getField(key, opt_params)

获取这个与指定键关联的名称的数据。

参数：
String key - 要获取数据的关键字；关键字在 Name.Field中定义
Map.<opensocial.DataRequest.DataRequestFields, Object> opt_params - 要传递给请求的其他参数。

返回：
String  数据

返回页首

静态类 opensocial.Name.Field

 概述     详述

名称具有的所有域。这些域是 Name.getField() 方法支持的键。

Field 概述

<static> object ADDITIONAL_NAME

其他名称，指定为字符串。

<static> object FAMILY_NAME

家庭名称。指定为字符串。

<static> object GIVEN_NAME

指定名称，指定为字符串。

<static> object HONORIFIC_PREFIX

敬语前缀，指定为字符串。

<static> object HONORIFIC_SUFFIX

敬语后缀，指定为字符串。

<static> object UNSTRUCTURED

未结构化的名称，指定为字符串。

 

Field 详述

ADDITIONAL_NAME

<static> object ADDITIONAL_NAME

其他名称，指定为字符串。

FAMILY_NAME

<static> object FAMILY_NAME

家庭名称。指定为字符串。

GIVEN_NAME

<static> object GIVEN_NAME

指定名称，指定为字符串。

HONORIFIC_PREFIX

<static> object HONORIFIC_PREFIX

敬语前缀，指定为字符串。

HONORIFIC_SUFFIX

<static> object HONORIFIC_SUFFIX

敬语后缀，指定为字符串。

UNSTRUCTURED

<static> object UNSTRUCTURED

未结构化的名称，指定为字符串。

返回页首

类 opensocial.NavigationParameters

 概述     详述

RequestShareApp 用来指引容器在提出请求后转向何处的参数。例如，可以用来指定查看者在以下情况之一下选择什么路线：1) 用户收到 shareApp 邀请或接收到消息后，小工具开发人员应该能够将该用户发送到相关环境的区域。2) 查看者真正与其他人员共享应用程序后，小工具开发人员应该能够将查看者引导至上下文相关的区域。

方法概述

 String getField(key, opt_params)

获取与指定的关键字相关联的 NavigationParameters 数据。

setField(key, data)

为这个与指定的关键字相关联的 NavigationParameters 设置数据。

 

方法详述

getField

String getField(key, opt_params)

获取与指定的关键字相关联的 NavigationParameters 数据。

参数：
String key - 要为其获取数据的键；请参阅 Field 类以了解可能的值
Map.<opensocial.DataRequest.DataRequestFields, Object> opt_params - 要传递给请求的其他参数。

返回：
String  数据

setField

setField(key, data)

为这个与指定的关键字相关联的 NavigationParameters 设置数据。

参数：
String key - 要为其设置数据的键
Object data - 要设置的数据

返回页首

静态类 opensocial.NavigationParameters.DestinationType

 概述     详述

可以在 requestShareApp 和 requestSendMessage 中浏览的目的地。

Field 概述

<static> object RECIPIENT_DESTINATION

<static> object VIEWER_DESTINATION

 

Field 详述

RECIPIENT_DESTINATION

<static> object RECIPIENT_DESTINATION

VIEWER_DESTINATION

<static> object VIEWER_DESTINATION

返回页首

静态类 opensocial.NavigationParameters.Field

 概述     详述

NavigationParameters 可具有的所有域。

另请参阅：opensocial.NavigationParameters.getField()

 

Field 概述

<static> object OWNER

表示所有者 ID 的字符串。

<static> object PARAMETERS

加载新视图（随着新所有者）以后传递给小工具的可选参数列表。

<static> object VIEW

要浏览的目标视图。

 

Field 详述

OWNER

<static> object OWNER

表示所有者 ID 的字符串。

PARAMETERS

<static> object PARAMETERS

加载新视图（随着新所有者）以后传递给小工具的可选参数列表。

VIEW

<static> object VIEW

要浏览的目标视图。

返回页首

类 opensocial.Organization

 概述     详述

所有组织对象的基本接口。

方法概述

 String getField(key, opt_params)

获取这个与指定关键字关联的实体类型的数据。

 

方法详述

getField

String getField(key, opt_params)

获取这个与指定关键字关联的实体类型的数据。

参数：
String key - 要获取数据的关键字；关键字在 Organization.Field中定义
Map.<opensocial.DataRequest.DataRequestFields, Object> opt_params - 要传递给请求的其他参数

返回：
String  数据

返回页首

静态类 opensocial.Organization.Field

 概述     详述

组织具有的所有域。这些是 Organization.getField() 方法支持的关键字。

Field 概述

<static> object ADDRESS

组织的地址，指定为 opensocial.Address。

<static> object DESCRIPTION

有关人物在组织中的工作的说明或注释，指定为字符串。

<static> object END_DATE

人物在组织中停止工作的日期，指定为日期。

<static> object FIELD

组织所在的域，指定为字符串。

<static> object NAME

组织的名称，指定为字符串。

<static> object SALARY

人物从组织收到的薪水，指定为字符串。

<static> object START_DATE

人物在组织中开始工作的日期，指定为日期。

<static> object SUB_FIELD

组织所在的子域，指定为字符串。

<static> object TITLE

人物在组织中的职务或角色，指定为字符串。

<static> object WEBPAGE

与组织有关的网页，指定为字符串。

 

Field 详述

ADDRESS

<static> object ADDRESS

组织的地址，指定为 opensocial.Address。容器对该域的支持是可选的。

DESCRIPTION

<static> object DESCRIPTION

有关人物在组织中的工作的说明或注释，指定为字符串。这可能是学生的课程，也可能是有关组织角色的详细说明。容器对该域的支持是可选的。

END_DATE

<static> object END_DATE

人物在组织中停止工作的日期，指定为日期。空日期表示该人物仍在为该组织工作。容器对该域的支持是可选的。

FIELD

<static> object FIELD

组织所在的域，指定为字符串。如果该组织是一所学校，这可能是要达到的学位。容器对该域的支持是可选的。

NAME

<static> object NAME

组织的名称，指定为字符串。例如，可为学校名称或工作所在的公司。容器对该域的支持是可选的。

SALARY

<static> object SALARY

人物从组织收到的薪水，指定为字符串。容器对该域的支持是可选的。

START_DATE

<static> object START_DATE

人物在组织中开始工作的日期，指定为日期。容器对该域的支持是可选的。

SUB_FIELD

<static> object SUB_FIELD

组织所在的子域，指定为字符串。容器对该域的支持是可选的。

TITLE

<static> object TITLE

人物在组织中的职务或角色，指定为字符串。可以是毕业生，也可以是软件工程师。容器对该域的支持是可选的。

WEBPAGE

<static> object WEBPAGE

与组织有关的网页，指定为字符串。容器对该域的支持是可选的。

返回页首

静态类 opensocial.Permission

 概述     详述

应用程序可请求的权限。

另请参阅：opensocial.hasPermission()、opensocial.requestPermission()

Field 概述

<static> object VIEWER

查看者人物对象的访问权限

 

Field 详述

VIEWER

<static> object VIEWER

查看者人物对象的访问权限

返回页首

类 opensocial.Person

 概述     详述

所有 Person 对象的基本接口。

方法概述

 String getDisplayName()

获取此人的文本显示名称；确保返回一个有用的字符串。

 String getField(key, opt_params)

获取这个与指定关键字关联的人员的数据。

 String getId()

获取可以与此人永久关联的 ID。

 Boolean isOwner()

如果此 Person 对象表示当前页面的所有者，则返回 True。

 Boolean isViewer()

如果此 Person 对象表示当前登录的用户，则返回 True。

 

方法详述

getDisplayName

String getDisplayName()

获取此人的文本显示名称；确保返回一个有用的字符串。

返回：
String  显示名称

getField

String getField(key, opt_params)

获取这个与指定关键字关联的人员的数据。

参数：
String key - 要获取数据的关键字；关键字在 Person.Field 中定义
Map.<opensocial.DataRequest.DataRequestFields, Object> opt_params - 要传递给请求的其他参数。

返回：
String  数据

getId

String getId()

获取可以与此人永久关联的 ID。

返回：
String  ID

isOwner

Boolean isOwner()

如果此 Person 对象表示当前页面的所有者，则返回 True。

返回：
Boolean  如果此人物对象是页面的所有者，则返回 True；否则返回 False

isViewer

Boolean isViewer()

如果此 Person 对象表示当前登录的用户，则返回 True。

返回：
Boolean  如果此人物对象是当前登录的用户，则返回 True；否则返回 False

返回页首

静态类 opensocial.Person.Field

 概述     详述

人物具有的所有域。这些域是 Person.getField() 方法支持的关键字。

Field 概述

<static> object ABOUT_ME

有关人物的常规说明，指定为字符串。

<static> object ACTIVITIES

人物最喜欢的活动，指定为字符串数组。

<static> object ADDRESSES

与人物相关联的地址，指定为地址数组。

<static> object AGE

人物的年龄，指定为数字。

<static> object BODY_TYPE

人物的体貌特征，指定为 opensocial.BodyType。

<static> object BOOKS

人物最喜欢的书籍，指定为字符串数组。

<static> object CARS

人物最喜欢的汽车，指定为字符串数组。

<static> object CHILDREN

人物子女的介绍，指定为字符串。

<static> object CURRENT_LOCATION

人物的当前位置，指定为地址。

<static> object DATE_OF_BIRTH

人物的出生日期，指定为日期对象。

<static> object DRINKER

人物的饮酒状态，指定为 opensocial.Enum，枚举的键引用为 opensocial.Enum.Drinker。

<static> object EMAILS

与人物相关的电子邮件，指定为电子邮件数组。

<static> object ETHNICITY

人物的种族，指定为字符串。

<static> object FASHION

人物关于时尚的想法，指定为字符串。

<static> object FOOD

人物最喜欢的食品，指定为字符串数组。

<static> object GENDER

人物的性别，指定为 opensocial.Enum，枚举的键引用为 opensocial.Enum.Gender。

<static> object HAPPIEST_WHEN

说明人物什么时候最高兴，指定为字符串。

<static> object HAS_APP

指明人物是否使用了当前应用程序的布尔值。

<static> object HEROES

人物最喜欢的英雄，指定为字符串数组。

<static> object HUMOR

人物关于幽默的想法，指定为字符串。

<static> object ID

可与该人物永久相关的字符串 ID。

<static> object INTERESTS

人物的兴趣、习惯或爱好，指定为字符串数组。

<static> object JOB_INTERESTS

人物最喜欢的工作或工作兴趣和技能，指定为字符串。

<static> object JOBS

人物从事的工作，指定为组织数组。

<static> object LANGUAGES_SPOKEN

人物使用的语言列表（ISO 639-1 代码形式），指定为字符串数组。

<static> object LIVING_ARRANGEMENT

人物生活安排的介绍，指定为字符串。

<static> object LOOKING_FOR

人物关于他们所寻找的人员或物品，或者他们愿意为人们提供的内容的说明。

<static> object MOVIES

人物最喜欢的电影，指定为字符串数组。

<static> object MUSIC

人物最喜欢的音乐，指定为字符串数组。

<static> object NAME

包含人物姓名的 opensocial.Name 对象。

<static> object NETWORK_PRESENCE

人物的当前工作状态。

<static> object NICKNAME

代表人物昵称的字符串。

<static> object PETS

人物宠物的介绍，指定为字符串。

<static> object PHONE_NUMBERS

与人物相关联的电话号码，指定为电话数组。

<static> object POLITICAL_VIEWS

人物的政治观，指定为字符串。

<static> object PROFILE_SONG

人物的个人资料歌曲，指定为 opensocial.Url。

<static> object PROFILE_URL

人物的个人资料网址，指定为字符串。

<static> object PROFILE_VIDEO

人物的个人资料视频，指定为 opensocial.Url。

<static> object QUOTES

人物最喜欢的名言，指定为字符串数组。

<static> object RELATIONSHIP_STATUS

人物的关系状态，指定为字符串。

<static> object RELIGION

人物的宗教或宗教观，指定为字符串。

<static> object ROMANCE

人物关于浪漫的评价，指定为字符串。

<static> object SCARED_OF

人物害怕的事物，指定为字符串。

<static> object SCHOOLS

人物呆过的学校，指定为组织数组。

<static> object SEXUAL_ORIENTATION

人物的性取向，指定为字符串。

<static> object SMOKER

人物的吸烟状态，指定为 opensocial.Enum，枚举的键引用为 opensocial.Enum.Smoker。

<static> object SPORTS

人物最喜欢的运动，指定为字符串数组。

<static> object STATUS

人物的状态、标题或号召，指定为字符串。

<static> object TAGS

有关人物的任意标签，指定为字符串数组。

<static> object THUMBNAIL_URL

人物的照片缩略图网址，指定为字符串。

<static> object TIME_ZONE

人物所在的时区，指定为格林威治标准时间 (GMT) 和人物当地时间之间的时差（以分钟为单位）。

<static> object TURN_OFFS

人物讨厌的事情，指定为字符串数组。

<static> object TURN_ONS

人物喜欢的事情，指定为字符串数组。

<static> object TV_SHOWS

人物最喜欢的电视节目，指定为字符串数组。

<static> object URLS

与人物相关的网址，其网页或供稿。

 

Field 详述

ABOUT_ME

<static> object ABOUT_ME

有关人物的常规说明，指定为字符串。容器对该域的支持是可选的。

ACTIVITIES

<static> object ACTIVITIES

人物最喜欢的活动，指定为字符串数组。容器对该域的支持是可选的。

ADDRESSES

<static> object ADDRESSES

与人物相关联的地址，指定为地址数组。容器对该域的支持是可选的。

AGE

<static> object AGE

人物的年龄，指定为数字。容器对该域的支持是可选的。

BODY_TYPE

<static> object BODY_TYPE

人物的体貌特征，指定为 opensocial.BodyType。容器对该域的支持是可选的。

BOOKS

<static> object BOOKS

人物最喜欢的书籍，指定为字符串数组。容器对该域的支持是可选的。

CARS

<static> object CARS

人物最喜欢的汽车，指定为字符串数组。容器对该域的支持是可选的。

CHILDREN

<static> object CHILDREN

人物子女的介绍，指定为字符串。容器对该域的支持是可选的。

CURRENT_LOCATION

<static> object CURRENT_LOCATION

人物的当前位置，指定为地址。容器对该域的支持是可选的。

DATE_OF_BIRTH

<static> object DATE_OF_BIRTH

人物的出生日期，指定为日期对象。容器对该域的支持是可选的。

DRINKER

<static> object DRINKER

人物的饮酒状态，指定为 opensocial.Enum，枚举的键引用为 opensocial.Enum.Drinker。容器对该域的支持是可选的。

EMAILS

<static> object EMAILS

与人物相关联的电子邮件，指定为电子邮件数组。容器对该域的支持是可选的。

ETHNICITY

<static> object ETHNICITY

人物的种族，指定为字符串。容器对该域的支持是可选的。

FASHION

<static> object FASHION

人物关于时尚的想法，指定为字符串。容器对该域的支持是可选的。

FOOD

<static> object FOOD

人物最喜欢的食品，指定为字符串数组。容器对该域的支持是可选的。

GENDER

<static> object GENDER

人物的性别，指定为 opensocial.Enum，枚举的键引用为 opensocial.Enum.Gender。容器对该域的支持是可选的。

HAPPIEST_WHEN

<static> object HAPPIEST_WHEN

说明人物什么时候最高兴，指定为字符串。容器对该域的支持是可选的。

HAS_APP

<static> object HAS_APP

指明人物是否使用了当前应用程序的布尔值。容器对该域的支持是可选的。

HEROES

<static> object HEROES

人物最喜欢的英雄，指定为字符串数组。容器对该域的支持是可选的。

HUMOR

<static> object HUMOR

人物关于幽默的想法，指定为字符串。容器对该域的支持是可选的。

ID

<static> object ID

可与该人物永久相关的字符串 ID。

INTERESTS

<static> object INTERESTS

人物的兴趣、习惯或爱好，指定为字符串数组。容器对该域的支持是可选的。

JOB_INTERESTS

<static> object JOB_INTERESTS

人物最喜欢的工作或工作兴趣和技能，指定为字符串。容器对该域的支持是可选的。

JOBS

<static> object JOBS

人物从事的工作，指定为组织数组。容器对该域的支持是可选的。

LANGUAGES_SPOKEN

<static> object LANGUAGES_SPOKEN

人物使用的语言列表（ISO 639-1 代码形式），指定为字符串数组。容器对该域的支持是可选的。

LIVING_ARRANGEMENT

<static> object LIVING_ARRANGEMENT

人物生活安排的介绍，指定为字符串。容器对该域的支持是可选的。

LOOKING_FOR

<static> object LOOKING_FOR

人物关于他们所寻找的人员或物品的说明，或者他们愿意为人们提供的内容的说明。指定为 opensocial.Enum 数组且枚举的关键字引用 opensocial.Enum.LookingFor。容器对该域的支持是可选的。

MOVIES

<static> object MOVIES

人物最喜欢的电影，指定为字符串数组。容器对该域的支持是可选的。

MUSIC

<static> object MUSIC

人物最喜欢的音乐，指定为字符串数组。容器对该域的支持是可选的。

NAME

<static> object NAME

包含人物姓名的 opensocial.Name 对象。

NETWORK_PRESENCE

<static> object NETWORK_PRESENCE

人物的当前工作状态。指定为 Enum 且枚举的关键字引用 opensocial.Enum.Presence。容器对该域的支持是可选的。

NICKNAME

<static> object NICKNAME

代表人物昵称的字符串。

PETS

<static> object PETS

人物宠物的介绍，指定为字符串。容器对该域的支持是可选的。

PHONE_NUMBERS

<static> object PHONE_NUMBERS

与人物相关联的电话号码，指定为电话数组。容器对该域的支持是可选的。

POLITICAL_VIEWS

<static> object POLITICAL_VIEWS

人物的政治观，指定为字符串。容器对该域的支持是可选的。

PROFILE_SONG

<static> object PROFILE_SONG

人物的个人资料歌曲，指定为 opensocial.Url。容器对该域的支持是可选的。

PROFILE_URL

<static> object PROFILE_URL

人物的个人资料网址，指定为字符串。该网址必须完全合格。相关网址将无法在小工具中使用。容器对该域的支持是可选的。

PROFILE_VIDEO

<static> object PROFILE_VIDEO

人物的个人资料视频，指定为 opensocial.Url。容器对该域的支持是可选的。

QUOTES

<static> object QUOTES

人物最喜欢的名言，指定为字符串数组。容器对该域的支持是可选的。

RELATIONSHIP_STATUS

<static> object RELATIONSHIP_STATUS

人物的关系状态，指定为字符串。容器对该域的支持是可选的。

RELIGION

<static> object RELIGION

人物的宗教或宗教观，指定为字符串。容器对该域的支持是可选的。

ROMANCE

<static> object ROMANCE

人物关于浪漫的评价，指定为字符串。容器对该域的支持是可选的。

SCARED_OF

<static> object SCARED_OF

人物害怕的事物，指定为字符串。容器对该域的支持是可选的。

SCHOOLS

<static> object SCHOOLS

人物呆过的学校，指定为组织数组。容器对该域的支持是可选的。

SEXUAL_ORIENTATION

<static> object SEXUAL_ORIENTATION

人物的性取向，指定为字符串。容器对该域的支持是可选的。

SMOKER

<static> object SMOKER

人物的吸烟状态，指定为 opensocial.Enum，枚举的键引用为 opensocial.Enum.Smoker。容器对该域的支持是可选的。

SPORTS

<static> object SPORTS

人物最喜欢的运动，指定为字符串数组。容器对该域的支持是可选的。

STATUS

<static> object STATUS

人物的状态、标题或号召，指定为字符串。容器对该域的支持是可选的。

TAGS

<static> object TAGS

有关人物的任意标签，指定为字符串数组。容器对该域的支持是可选的。

THUMBNAIL_URL

<static> object THUMBNAIL_URL

人物的照片缩略图网址，指定为字符串。该网址必须完全合格。相关网址将无法在小工具中使用。

TIME_ZONE

<static> object TIME_ZONE

人物所在的时区，指定为格林威治标准时间 (GMT) 和人物当地时间之间的时差（以分钟为单位）。请参阅 Javascript 中的 Date.getTimezoneOffset() 以获取有关该格式的详细信息。容器对该域的支持是可选的。

TURN_OFFS

<static> object TURN_OFFS

人物讨厌的事情，指定为字符串数组。容器对该域的支持是可选的。

TURN_ONS

<static> object TURN_ONS

人物喜欢的事情，指定为字符串数组。容器对该域的支持是可选的。

TV_SHOWS

<static> object TV_SHOWS

人物最喜欢的电视节目，指定为字符串数组。容器对该域的支持是可选的。

URL

<static> object URLS

与人物相关的网址，其网页或供稿。指定为 opensocial.Url 数组。容器对该域的支持是可选的。

返回页首

类 opensocial.Phone

 概述     详述

所有电话对象的基本接口。

方法概述

 String getField(key, opt_params)

获取这个与指定键关联的电话的数据。

 

方法详述

getField

String getField(key, opt_params)

获取这个与指定键关联的电话的数据。

参数：
String key - 要获取数据的关键字；关键字在 Phone.Field中定义
Map.<opensocial.DataRequest.DataRequestFields, Object> opt_params - 要传递给请求的其他参数。

返回：
String  数据

返回页首

静态类 opensocial.Phone.Field

 概述     详述

联系电话具有的所有域。这些域是 Phone.getField() 方法支持的关键字。

Field 概述

<static> object NUMBER

电话号码，指定为字符串。

<static> object TYPE

电话号码类型或标号，指定为字符串。

 

Field 详述

NUMBER

<static> object NUMBER

电话号码，指定为字符串。

TYPE

<static> object TYPE

电话号码类型或标号，指定为字符串。例如：工作、我最喜欢的商店、我的住房等

返回页首

类 opensocial.ResponseItem

 概述     详述

表示通过处理服务器上的数据请求项目而生成的响应。

方法概述

 Object getData()

获取响应数据。

 String getErrorCode()

如果请求出错，则返回错误代码。

 String getErrorMessage()

如果请求出错，则返回错误消息。

 opensocial.DataRequest getOriginalDataRequest()

返回原始数据请求。

 Boolean hadError()

如果从服务器中获取该数据时出错，将返回 True。

 

方法详述

getData

Object getData()

获取响应数据。

返回：
Object  由服务器计算的请求的值；该值的类型由所提请求的类型定义。

getErrorCode

String getErrorCode()

如果请求出错，则返回错误代码。错误代码可以是容器特定的代码，也可以是由 Error 定义的某个值。

返回：
String  错误代码，如果没有错误，则为 Null

getErrorMessage

String getErrorMessage()

如果请求出错，则返回错误消息。

返回：
String  对已发生错误所做的用户可阅读的描述；可以为 Null（即使发生了错误）

getOriginalDataRequest

opensocial.DataRequest getOriginalDataRequest()

返回原始数据请求。

返回：
opensocial.DataRequest  用于获取此数据响应的数据请求

hadError

Boolean hadError()

如果从服务器中获取该数据时出错，将返回 True。

返回：
Boolean  如果出错，则返回 True；否则返回 False

返回页首

静态类 opensocial.ResponseItem.Error

 概述     详述

响应项目可以返回的错误代码。

Field 概述

<static> object BAD_REQUEST

请求无效。

<static> object FORBIDDEN

小工具绝不能访问请求的数据。

<static> object INTERNAL_ERROR

请求遇到意外情况，阻止了该请求的执行。

<static> object LIMIT_EXCEEDED

小工具超出请求配额。

<static> object NOT_IMPLEMENTED

此容器不支持提出的请求。

<static> object UNAUTHORIZED

小工具无法访问请求的数据。

 

Field 详述

BAD_REQUEST

<static> object BAD_REQUEST

请求无效。实例：“max”为 -1。

FORBIDDEN

<static> object FORBIDDEN

小工具绝不能访问请求的数据。

INTERNAL_ERROR

<static> object INTERNAL_ERROR

请求遇到意外情况，阻止其执行该请求。

LIMIT_EXCEEDED

<static> object LIMIT_EXCEEDED

小工具超出请求配额。实例配额包含每天的调用数上限、每个用户每天的调用数，以及特定时间段内的调用数等。

NOT_IMPLEMENTED

<static> object NOT_IMPLEMENTED

此容器不支持提出的请求。

UNAUTHORIZED

<static> object UNAUTHORIZED

小工具无法访问请求的数据。要获取访问权限，请使用 opensocial.requestPermission()。

返回页首

类 opensocial.Url

 概述     详述

所有网址对象的基本接口。

方法概述

 String getField(key, opt_params)

获取这个与指定键关联的网址的数据。

 

方法详述

getField

String getField(key, opt_params)

获取这个与指定键关联的网址的数据。

参数：
String key - 要获取数据的关键字；关键字在 Url.Field中定义
Map.<opensocial.DataRequest.DataRequestFields, Object> opt_params - 要传递给请求的其他参数。

返回：
String  数据

返回页首

静态类 opensocial.Url.Field

 概述     详述

网址具有的所有域。这些域是 Url.getField() 方法支持的关键字。

Field 概述

<static> object ADDRESS

网址指向的目标地址，指定为字符串。

<static> object LINK_TEXT

链接的文本，指定为字符串。

<static> object TYPE

网址编号类型或标号，指定为字符串。

 

Field 详述

ADDRESS

<static> object ADDRESS

网址指向的目标地址，指定为字符串。

LINK_TEXT

<static> object LINK_TEXT

链接的文本，指定为字符串。

TYPE

<static> object TYPE

网址编号类型或标号，指定为字符串。例如：作品、博客供稿、网站等

......

[阅读全文]