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

网址编号类型或标号，指定为字符串。例如：作品、博客供稿、网站等