opensocial.DataRequest (v0.7)

 概述     详述

类 opensocial.DataRequest

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

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

function requestMe() {
  var req = opensocial.newDataRequest();
  req.add(req.newFetchPersonRequest(
            opensocial.DataRequest.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)

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

 Object newFetchPersonRequest(id, opt_params)

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

 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)

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

处理后，将返回“activities”属性为 Collection<Activity> 对象的对象。

参数：
Array.<String>, String idSpec - 一个 ID、ID 数组或组引用，用于指定要提取哪个用户的活动；受支持的键为 VIEWER、OWNER、VIEWER_FRIENDS、OWNER_FRIENDS 或某个组中的单个 ID。
Map.<opensocial.DataRequest.ActivityRequestFields, Object> opt_params - 要传递给请求的其他参数；当前并未使用

返回：
Object 请求对象

newFetchPeopleRequest

Object newFetchPeopleRequest(idSpec, opt_params)

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

参数：
Array.<String>, String idSpec - 一个 ID、ID 数组或组引用，用于指定要提取哪个用户；受支持的键为 VIEWER、OWNER、VIEWER_FRIENDS、OWNER_FRIENDS 或某个组中的单个 ID。
Map.<opensocial.DataRequest.PeopleRequestFields, Object> opt_params - 要传递给请求的其他参数

返回：
Object 请求对象

newFetchPersonAppDataRequest

Object newFetchPersonAppDataRequest(idSpec, keys)

创建项目以请求指定用户的应用程序数据。处理后，将返回 Map<PersonId, Map<String, String>> 对象。

参数：
Array.<String>, String idSpec - 一个 ID、ID 数组或组引用；受支持的键为 VIEWER、OWNER、VIEWER_FRIENDS、OWNER_FRIENDS 或某个组中的单个 ID。
Array.<String>, String keys - 您要获取其数据的键；这可以是一个键名称数组、一个键名称或表示“所有键”的“*”

返回：
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 请求对象

newUpdatePersonAppDataRequest

Object newUpdatePersonAppDataRequest(id, key, value)

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

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

返回：
Object 请求对象

send

send(opt_callback)

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

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

---