opensocial (v0.7)

 概述     详述

静态类 opensocial

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

方法概述

<static>  opensocial.Environment getEnvironment()

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

<static>  Boolean hasPermission(permission)

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

<static>  opensocial.Activity newActivity(params)

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

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

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

<static>  opensocial.DataRequest newDataRequest()

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

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

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

<static> requestCreateActivity(activity, priority, opt_callback)

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

<static> requestPermission(permissions, reason, opt_callback)

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

<static> requestSendMessage(recipients, message, opt_callback)

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

<static> requestShareApp(recipients, reason, opt_callback)

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

 

方法详述

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 新增活动对象

newActivityMediaItem

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

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

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

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

newDataRequest

<static> opensocial.DataRequest newDataRequest()

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

返回：
opensocial.DataRequest 请求对象

newMessage

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

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

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

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

requestCreateActivity

<static> requestCreateActivity(activity, priority, opt_callback)

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

另请参阅：newActivity()

注意：如果这是为用户创建的第一个活动，并且该请求的优先级被标记为“高”，则该调用可打开用户流并浏览到小工具以外的内容。 如果容器不支持此方法，则使用 opensocial.ResponseItem 调用回调。响应项目会将其错误代码设置为 NOT_IMPLEMENTED。

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

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)

请求容器向指定用户发送特定消息。如果容器不支持此方法，则使用 opensocial.ResponseItem 调用回调。响应项目会将其错误代码设置为 NOT_IMPLEMENTED。

参数：
Array.<String>, String recipients - 一个 ID、ID 数组或组引用；受支持的键为 VIEWER、OWNER、VIEWER_FRIENDS、OWNER_FRIENDS 或某个组中的单个 ID。
opensocial.Message message - 要发送给指定用户的消息。
Function opt_callback - 请求处理后要调用的函数；调用该回调或者会从头开始重新加载该小工具。 为该函数传递一个参数 opensocial.ResponseItem。设置错误代码以反映请求是否有问题。如果没有错，则发送消息。如果有错，则可以使用响应项目的 getErrorCode 方法来确定如何继续。不设置响应项目的数据。

requestShareApp

<static> requestShareApp(recipients, reason, opt_callback)

请求容器与指定用户共享该小工具。如果容器不支持此方法，则使用 opensocial.ResponseItem 调用回调。响应项目会将其错误代码设置为 NOT_IMPLEMENTED。

参数：
Array.<String>, String recipients - 一个 ID、ID 数组或组引用；受支持的键为 VIEWER、OWNER、VIEWER_FRIENDS、OWNER_FRIENDS 或某个组中的单个 ID。
opensocial.Message reason - 用户希望自己共享小工具的原因。当系统提示用户使用共享应用程序的权限时，容器可以使用该原因。也可以忽略该原因。
Function opt_callback - 请求处理后要调用的函数；调用该回调或者从头开始重新加载该小工具。 为该函数传递一个参数 opensocial.ResponseItem。设置错误代码以反映请求是否有问题。如果没有错，则发送共享请求。如果有错，则可以使用响应项目的 getErrorCode 方法来确定如何继续。不设置响应项目的数据。

---