OpenSocial JavaScript API 包括两个名称空间:opensocial.*
和 gadgets.*
。本页面包含 opensocial.*
名称空间。gadgets.*
名称空间包含在小工具 API 参考中。
本文档使用以下类型的规范:
Boolean
对象)。
String
对象)。 顶级用户功能的名称空间。
<static> opensocial.Environment getEnvironment()
<static> Boolean hasPermission(permission)
<static> opensocial.Activity newActivity(params)
<static> opensocial.DataRequest newDataRequest()
<static> opensocial.IdSpec newIdSpec(parameters)
<static> opensocial.MediaItem newMediaItem(mimeType, url, opt_params)
<static> opensocial.Message newMessage(body, opt_params)
<static> opensocial.NavigationParameters newNavigationParameters(parameters)
<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)
<static> opensocial.Environment getEnvironment()
opensocial.Environment
当前环境 <static> Boolean hasPermission(permission)
opensocial.Permission permission
- 权限 Boolean
如果该小工具具有访问权限,则返回 True;否则返回 False <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
新的活动对象 <static> opensocial.DataRequest newDataRequest()
opensocial.DataRequest
请求对象 <static> opensocial.IdSpec newIdSpec(parameters)
Map.<opensocial.IdSpec.Field, Object> parameters
- 定义 ID 规范的参数 opensocial.IdSpec
新的 IdSpec 对象 <static> opensocial.MediaItem newMediaItem(mimeType, url, opt_params)
String mimeType
- 媒体的 MIME 类型 String url
- 媒体文件的网址 Map.<opensocial.MediaItem.Field, Object> opt_params
- 应在媒体项目对象上设置的其他所有域;支持所有定义的域 opensocial.MediaItem
新的媒体项目对象 <static> opensocial.Message newMessage(body, opt_params)
String body
- 消息的正文 Map.<opensocial.Message.Field, Object> opt_params
- 应在消息对象上设置的其他所有域;支持所有定义的域 opensocial.Message
新的消息对象 <static> opensocial.NavigationParameters newNavigationParameters(parameters)
另请参阅:requestShareApp()
Map.<opensocial.NavigationParameters.Field, Object> parameters
- 定义导航的参数 opensocial.NavigationParameters
新的 NavigationParameters 对象 <static> requestCreateActivity(activity, priority, opt_callback)
另请参阅:newActivity()
注意:如果这是为用户创建的第一个活动,并且该请求的优先级标记为“高”,则该调用可打开一个用户流并浏览到小工具以外的内容。
调用该回调,或者从头开始重新加载小工具。为该函数传递一个参数 opensocial.ResponseItem。设置错误代码以反映请求是否有问题。如果没有错,则创建活动。如果有错,则可以使用响应项目的 getErrorCode 方法来确定如何继续。响应项目的数据将不会设置。
如果容器不支持此方法,则使用 opensocial.ResponseItem 调用回调。响应项目会将其错误代码设置为 NOT_IMPLEMENTED。
opensocial.Activity activity
- 要创建的活动 opensocial.CreateActivityPriority priority
- 该请求的优先级 Function opt_callback
- 处理请求后要调用的函数。 <static> requestPermission(permissions, reason, opt_callback)
Array.<opensocial.Permission> permissions
- 要向查看者请求的权限 String reason
- 已向用户显示的需要这些权限的原因 Function opt_callback
- 处理请求后要调用的函数;调用该回调,或者从头开始重新加载小工具。为该函数传递一个参数 opensocial.ResponseItem。设置错误代码以反映请求是否有问题。如果没有错,则授予所有权限。如果有错,则可以使用 opensocial.hasPermission 以查看仍拒绝的权限。响应项目上的数据会进行设置。这将是授予的 opensocial.Permissions 的数组。 <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 <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.newActivity 时,可以直接将此标题和实体设置为字符串。但是,使用标题和实体的消息模板来创建活动通常有很多好处。
用户的活动流中具有许多活动,但是容器不会显示用户可以看到的每个活动。为帮助显示大量活动,容器将会总结一个活动列表,包括从指定来源到单个条目的活动。
您可以提供活动总结,以自定义在总结多个活动时显示的文本。如果未提供自定义文本,容器可能会忽略您的所有活动或提供默认文本(例如“鲍勃更改了他的状态消息 + 20 个其他与此类似的事件”)。
总结实例:
<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()
setField(key, data)
String getField(key, opt_params)
String key
- 要为其获取数据的键;请参阅 Field 类以了解可能的值 Map.<opensocial.DataRequest.DataRequestFields, Object> opt_params
- 要传递给请求的其他参数。 String
数据 String getId()
String
ID setField(key, data)
String key
- 要为其设置数据的键 String data
- 要设置的数据 活动可具有的所有域。
仅需要设置 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()
<static> object APP_ID
<static> object BODY
指定活动的可选扩展版字符串。
<static> object BODY_ID
指定小工具规范中正文模板消息 ID 的字符串。
<static> object EXTERNAL_ID
<static> object ID
<static> object MEDIA_ITEMS
<static> object POSTED_TIME
<static> object PRIORITY
<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
<static> object APP_ID
<static> object BODY
指定活动的可选扩展版字符串。
正文仅可能包含以下 HTML 标签:<b>、<i>、<a> 和 <span>。呈现该活动时,容器可能会忽略此格式。
<static> object BODY_ID
指定小工具规范中正文模板消息 ID 的字符串。
正文是活动的可选扩展版。
正文仅可能包含以下 HTML 标签:<b>、<i>、<a> 和 <span>。呈现该活动时,容器可能会忽略此格式。
<static> object EXTERNAL_ID
<static> object ID
<static> object MEDIA_ITEMS
Array< MediaItem>
。 <static> object POSTED_TIME
<static> object PRIORITY
<static> object STREAM_FAVICON_URL
<static> object STREAM_SOURCE_URL
<static> object STREAM_TITLE
<static> object STREAM_URL
<static> object TEMPLATE_PARAMS
与该活动相关联的自定义键/值对的映射。这些值将用于在模板中进行评估。
数据的类型为 Map<String, Object>
。该对象可以是字符串也可以是 opensocial.Person。
用户传递键 PersonKey 时,可以在模板中使用以下替代变量:
<static> object TITLE
指定活动的主要文本的字符串。
标题仅可能包含以下 HTML 标签:<b>、<i>、<a> 和 <span>。呈现该活动时,容器可能会忽略此格式。
<static> object TITLE_ID
指定小工具规范中标题模板消息 ID 的字符串。
标题是活动的主要文本。
标题仅可能包含以下 HTML 标签:<b>、<i>、<a> 和 <span>。呈现该活动时,容器可能会忽略此格式。
<static> object URL
<static> object USER_ID
所有地址对象的基本接口。
String getField(key, opt_params)
String getField(key, opt_params)
String key
- 要获取数据的关键字;关键字在 Address.Field
中定义 Map.<opensocial.DataRequest.DataRequestFields, Object> opt_params
- 要传递给请求的其他参数 String
数据 地址具有的所有域。这些域是 Address.getField() 方法支持的键。
<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
<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
所有实体类型对象的基本接口。
String getField(key, opt_params)
String getField(key, opt_params)
String key
- 要获取数据的关键字;关键字在 BodyType.Field
中定义 Map.<opensocial.DataRequest.DataRequestFields, Object> opt_params
- 要传递给请求的其他参数。 String
数据 实体类型具有的所有域。这些域是 BodyType.getField() 方法支持的关键字。
<static> object BUILD
<static> object EYE_COLOR
<static> object HAIR_COLOR
<static> object HEIGHT
<static> object WEIGHT
<static> object BUILD
<static> object EYE_COLOR
<static> object HAIR_COLOR
<static> object HEIGHT
<static> object WEIGHT
具有实用存取器的多个对象的集合。还可以代表较大集合的子集(例如,第 1 页,共 10 页)并包含有关该较大集合的信息。
Array.<Object> asArray()
each(fn)
Object? getById(id)
Number getOffset()
Number getTotalSize()
Number size()
Array.<Object> asArray()
Array.<Object>
该集合中的值 each(fn)
Function fn
- 要通过每个集合条目调用的函数 Object? getById(id)
String id
- 要查找的 ID Object?
数据 Number getOffset()
Number
在总集合中的偏移 Number getTotalSize()
Number
结果的总大小 Number size()
Number
该集合的大小 创建活动请求可能具有的属性。
另请参阅:opensocial.requestCreateActivity()
<static> object HIGH
<static> object LOW
<static> object HIGH
<static> object LOW
用于从容器请求社交信息。社交信息包括好友的数据、个人资料、应用程序数据和活动。需要访问用户信息的所有应用程序应发送 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)
Object newRemovePersonAppDataRequest(id, keys)
Object newUpdatePersonAppDataRequest(id, key, value)
send(opt_callback)
add(request, opt_key)
Object request
- 指定要提取或更新的数据 String opt_key
- 要将生成的响应数据映射过去的目标键 Object newFetchActivitiesRequest(idSpec, opt_params)
处理完以后,返回 Collection<Activity>。
opensocial.IdSpec idSpec
- 用于指定要获取的用户的 IdSpec。另请参阅 IdSpec。 Map.<opensocial.DataRequest.ActivityRequestFields, Object> opt_params
- 要传递给请求的其他参数;当前并未使用 Object
请求对象 Object newFetchPeopleRequest(idSpec, opt_params)
opensocial.IdSpec idSpec
- 用于指定要获取的用户的 IdSpec。另请参阅 IdSpec。 Map.<opensocial.DataRequest.PeopleRequestFields, Object> opt_params
- 要传递给请求的其他参数 Object
请求对象 Object newFetchPersonAppDataRequest(idSpec, keys, opt_params)
opensocial.IdSpec idSpec
- 用于指定要获取的用户的 IdSpec。另请参阅 IdSpec。 Array.<String>, String keys
- 要为其获取数据的键;它可以是键名称数组、键名称,也可以是表示“所有键”的“*”。 Map.<opensocial.DataRequest.DataRequestFields, Object> opt_params
- 要传递给请求的其他参数 Object
请求对象 Object newFetchPersonRequest(id, opt_params)
Person
对象。 String id
- 要获取的用户的 ID;可以是 VIEWER 或 OWNER 的标准用户 ID。 Map.<opensocial.DataRequest.PeopleRequestFields, Object> opt_params
- 要传递给请求的其他参数;该请求支持 PROFILE_DETAILS Object
请求对象 Object newRemovePersonAppDataRequest(id, keys)
String id
- 要更新的用户的 ID;当前仅允许更新特殊的 VIEWER
ID。 Array.<String>, String keys
- 您要从数据库中删除的键;它可以是键名称数组、键名称,也可以是表示“所有键”的“*”。 Object
请求对象 Object newUpdatePersonAppDataRequest(id, key, value)
String id
- 要更新的用户的 ID;当前仅允许更新特殊的 VIEWER
ID。 String key
- 键的名称。名称中只能包含字母或数字(A-Z、a-z 或 0-9)字符、下划线 (_)、点 (.) 或破折号 (-)。 Object value
- 值,必须是有效的 json Object
请求对象 send(opt_callback)
Function opt_callback
- 要通过服务器生成的数据响应调用的函数 <static> object ESCAPE_TYPE
<static> object ESCAPE_TYPE
可用于限制人员请求的过滤器。
<static> object ALL
<static> object HAS_APP
<static> object TOP_FRIENDS
<static> object ALL
<static> object HAS_APP
<static> object TOP_FRIENDS
<static> object FILTER
<static> object FILTER_OPTIONS
<static> object FIRST
<static> object MAX
<static> object PROFILE_DETAILS
opensocial.Person.Field
数组,它指定要获取每个人物对象的哪些个人资料数据。
<static> object SORT_ORDER
<static> object FILTER
<static> object FILTER_OPTIONS
<static> object FIRST
<static> object MAX
<static> object PROFILE_DETAILS
opensocial.Person.Field
中定义 数组,它指定要获取每个人物对象的哪些个人资料数据。服务器将始终包含 ID、NAME 和 THUMBNAIL_URL。 <static> object SORT_ORDER
用于对人物对象进行排序的排列顺序。
<static> object NAME
<static> object TOP_FRIENDS
<static> object NAME
<static> object TOP_FRIENDS
该对象包含映射至请求的关键字的请求的服务器数据。
另请参阅:DataRequest
opensocial.ResponseItem get(key)
String getErrorMessage()
Boolean hadError()
opensocial.ResponseItem get(key)
key
opensocial.ResponseItem
由服务器计算的请求的响应 String getErrorMessage()
String
对已发生错误所做的用户可阅读的描述。 Boolean hadError()
Boolean
如果出错,则返回 True;否则返回 False 所有电子邮件对象的基本接口。
String getField(key, opt_params)
String getField(key, opt_params)
String key
- 要获取数据的关键字;关键字在 Email.Field
中定义 Map.<opensocial.DataRequest.DataRequestFields, Object> opt_params
- 要传递给请求的其他参数。 String
数据 电子邮件具有的所有域。这些域是 Email.getField() 方法支持的关键字。
<static> object ADDRESS
<static> object TYPE
所有枚举对象的基本接口。该类允许容器对通常具有一组通用值的域使用常量。有两种主要方式可以使用该类。
如果您的小工具只需要显示某人的吸烟量,则可以简单使用如下:
html = "This person smokes: " + person.getField('smoker').getValue();
此值域将由该容器正确设置。容器甚至可以在该位置本地化小工具的值,以便其始终显示正确的内容。
如果您的小工具需要有关吸烟者域的逻辑,则可以使用:
if (person.getField('smoker').getKey() != "NO") { //gadget logic here }
注意:如果某人的吸烟者域无法被强制为某个标准的枚举类型,则该关键字可能为 Null。而该值从不为空。
String getDisplayValue()
String getKey()
String getDisplayValue()
String
枚举的值。 String getKey()
String
枚举的关键字。该关键字应是以下定义的枚举之一。 饮酒者域所用的枚举键。
另请参阅:opensocial.Person.Field.Drinker
<static> object HEAVILY
<static> object NO
<static> object OCCASIONALLY
<static> object QUIT
<static> object QUITTING
<static> object REGULARLY
<static> object SOCIALLY
<static> object YES
<static> object HEAVILY
<static> object NO
<static> object OCCASIONALLY
<static> object QUIT
<static> object QUITTING
<static> object REGULARLY
<static> object SOCIALLY
<static> object YES
性别域所用的枚举键。
另请参阅:opensocial.Person.Field.Gender
<static> object FEMALE
<static> object MALE
查找域所用的枚举关键字。
另请参阅:opensocial.Person.Field.LookingFor
<static> object ACTIVITY_PARTNERS
<static> object DATING
<static> object FRIENDS
<static> object NETWORKING
<static> object RANDOM
<static> object RELATIONSHIP
<static> object ACTIVITY_PARTNERS
<static> object DATING
<static> object FRIENDS
<static> object NETWORKING
<static> object RANDOM
<static> object RELATIONSHIP
网络显示状态域所用的枚举关键字。
另请参阅:opensocial.Person.Field.NetworkPresence
<static> object AWAY
<static> object CHAT
<static> object DND
<static> object OFFLINE
<static> object ONLINE
<static> object XA
<static> object AWAY
<static> object CHAT
<static> object DND
<static> object OFFLINE
<static> object ONLINE
<static> object XA
吸烟者域所用的枚举键。
另请参阅:opensocial.Person.Field.Smoker
<static> object HEAVILY
<static> object NO
<static> object OCCASIONALLY
<static> object QUIT
<static> object QUITTING
<static> object REGULARLY
<static> object SOCIALLY
<static> object YES
<static> object HEAVILY
<static> object NO
<static> object OCCASIONALLY
<static> object QUIT
<static> object QUITTING
<static> object REGULARLY
<static> object SOCIALLY
<static> object YES
表示小工具的当前环境。
另请参阅:opensocial.getEnvironment()
String getDomain()
Boolean supportsField(objectType, fieldName)
String getDomain()
String
域 Boolean supportsField(objectType, fieldName)
opensocial.Environment.ObjectType objectType
- 要针对此域检查的对象类型 String fieldName
- 要检查的域的名称 Boolean
如果指定的对象类型支持此域,则返回 True 该容器中对象的类型。
另请参阅:Environment.supportsField()
<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
<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
可应用于人物数据或域的转义类型。
<static> object HTML_ESCAPE
<static> object NONE
<static> object HTML_ESCAPE
<static> object NONE
所有 ID 规范对象的基本接口。
String getField(key, opt_params)
setField(key, data)
String getField(key, opt_params)
String key
- 要为其获取数据的键;请参阅 Field 类以了解可能的值 Map.<opensocial.DataRequest.DataRequestFields, Object> opt_params
- 要传递给请求的其他参数。 String
数据 setField(key, data)
String key
- 要为其设置数据的键 String data
- 要设置的数据 ID 规范可以具有的所有域。
另请参阅:opensocial.IdSpec.getField()
<static> object GROUP_ID
<static> object NETWORK_DISTANCE
<static> object USER_ID
<static> object GROUP_ID
<static> object NETWORK_DISTANCE
<static> object USER_ID
获取人物信息时可用的常用用户 ID。
<static> object OWNER
<static> object VIEWER
表示图像、电影和音频。使用 opensocial.newMediaItem() 方法创建 MediaItem
对象。
String getField(key, opt_params)
String key
- 要为其获取数据的键;请参阅 Field 类以了解可能的值 Map.<opensocial.DataRequest.DataRequestFields, Object> opt_params
- 要传递给请求的其他参数。 String
数据 setField(key, data)
String key
- 要为其设置数据的键 String data
- 要设置的数据 媒体项目具有的所有域。
另请参阅:opensocial.MediaItem.getField()
<static> object MIME_TYPE
<static> object TYPE
MediaItem.Type
对象。
<static> object URL
<static> object MIME_TYPE
<static> object TYPE
MediaItem.Type
对象。 <static> object URL
媒体项目的可用类型。
另请参阅:opensocial.MediaItem.Field
<static> object AUDIO
<static> object IMAGE
<static> object VIDEO
所有消息对象的基本接口。*
另请参阅:opensocial.newMessage()、opensocial.requestSendMessage()
String getField(key, opt_params)
String key
- 要为其获取数据的键;请参阅 Field 类以了解可能的值 Map.<opensocial.DataRequest.DataRequestFields, Object> opt_params
- 要传递给请求的其他参数。 String
数据 setField(key, data)
String key
- 要为其设置数据的键 String data
- 要设置的数据 消息可以具有的所有域。
另请参阅:opensocial.Message.getField()
<static> object BODY
<static> object BODY_ID
<static> object TITLE
<static> object TITLE_ID
<static> object TYPE
<static> object BODY
<static> object BODY_ID
<static> object TITLE
<static> object TITLE_ID
<static> object TYPE
可以发送的消息的类型。
<static> object EMAIL
<static> object NOTIFICATION
<static> object PRIVATE_MESSAGE
<static> object PUBLIC_MESSAGE
<static> object EMAIL
<static> object NOTIFICATION
<static> object PRIVATE_MESSAGE
<static> object PUBLIC_MESSAGE
所有名称对象的基本接口。
String getField(key, opt_params)
String getField(key, opt_params)
String key
- 要获取数据的关键字;关键字在 Name.Field
中定义 Map.<opensocial.DataRequest.DataRequestFields, Object> opt_params
- 要传递给请求的其他参数。 String
数据 名称具有的所有域。这些域是 Name.getField() 方法支持的键。
<static> object ADDITIONAL_NAME
<static> object FAMILY_NAME
<static> object GIVEN_NAME
<static> object HONORIFIC_PREFIX
<static> object HONORIFIC_SUFFIX
<static> object UNSTRUCTURED
<static> object ADDITIONAL_NAME
<static> object FAMILY_NAME
<static> object GIVEN_NAME
<static> object HONORIFIC_PREFIX
<static> object HONORIFIC_SUFFIX
<static> object UNSTRUCTURED
RequestShareApp 用来指引容器在提出请求后转向何处的参数。例如,可以用来指定查看者在以下情况之一下选择什么路线:1) 用户收到 shareApp 邀请或接收到消息后,小工具开发人员应该能够将该用户发送到相关环境的区域。2) 查看者真正与其他人员共享应用程序后,小工具开发人员应该能够将查看者引导至上下文相关的区域。
String getField(key, opt_params)
setField(key, data)
String getField(key, opt_params)
String key
- 要为其获取数据的键;请参阅 Field 类以了解可能的值 Map.<opensocial.DataRequest.DataRequestFields, Object> opt_params
- 要传递给请求的其他参数。 String
数据 setField(key, data)
String key
- 要为其设置数据的键 Object data
- 要设置的数据 可以在 requestShareApp 和 requestSendMessage 中浏览的目的地。
<static> object RECIPIENT_DESTINATION
<static> object VIEWER_DESTINATION
<static> object RECIPIENT_DESTINATION
<static> object VIEWER_DESTINATION
NavigationParameters 可具有的所有域。
另请参阅:opensocial.NavigationParameters.getField()
<static> object OWNER
<static> object PARAMETERS
<static> object VIEW
<static> object OWNER
<static> object PARAMETERS
<static> object VIEW
所有组织对象的基本接口。
String getField(key, opt_params)
String getField(key, opt_params)
String key
- 要获取数据的关键字;关键字在 Organization.Field
中定义 Map.<opensocial.DataRequest.DataRequestFields, Object> opt_params
- 要传递给请求的其他参数 String
数据 组织具有的所有域。这些是 Organization.getField() 方法支持的关键字。
<static> object 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
<static> object 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
应用程序可请求的权限。
另请参阅:opensocial.hasPermission()
、opensocial.requestPermission()
<static> object VIEWER
<static> object VIEWER
所有 Person 对象的基本接口。
String getDisplayName()
String getField(key, opt_params)
String getId()
Boolean isOwner()
Boolean isViewer()
String getDisplayName()
String
显示名称 String getField(key, opt_params)
String key
- 要获取数据的关键字;关键字在 Person.Field
中定义 Map.<opensocial.DataRequest.DataRequestFields, Object> opt_params
- 要传递给请求的其他参数。 String
数据 String getId()
String
ID Boolean isOwner()
Boolean
如果此人物对象是页面的所有者,则返回 True;否则返回 False Boolean isViewer()
Boolean
如果此人物对象是当前登录的用户,则返回 True;否则返回 False 人物具有的所有域。这些域是 Person.getField() 方法支持的关键字。
<static> object ABOUT_ME
<static> object ACTIVITIES
<static> object ADDRESSES
<static> object AGE
<static> object BODY_TYPE
<static> object BOOKS
<static> object CARS
<static> object CHILDREN
<static> object CURRENT_LOCATION
<static> object DATE_OF_BIRTH
<static> object DRINKER
<static> object EMAILS
<static> object ETHNICITY
<static> object FASHION
<static> object FOOD
<static> object GENDER
<static> object HAPPIEST_WHEN
<static> object HAS_APP
<static> object HEROES
<static> object HUMOR
<static> object ID
<static> object INTERESTS
<static> object JOB_INTERESTS
<static> object JOBS
<static> object LANGUAGES_SPOKEN
<static> object LIVING_ARRANGEMENT
<static> object LOOKING_FOR
<static> object MOVIES
<static> object MUSIC
<static> object NAME
<static> object NETWORK_PRESENCE
<static> object NICKNAME
<static> object PETS
<static> object PHONE_NUMBERS
<static> object POLITICAL_VIEWS
<static> object PROFILE_SONG
<static> object PROFILE_URL
<static> object PROFILE_VIDEO
<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
<static> object SPORTS
<static> object STATUS
<static> object TAGS
<static> object THUMBNAIL_URL
<static> object TIME_ZONE
<static> object TURN_OFFS
<static> object TURN_ONS
<static> object TV_SHOWS
<static> object URLS
<static> object ABOUT_ME
<static> object ACTIVITIES
<static> object ADDRESSES
<static> object AGE
<static> object BODY_TYPE
<static> object BOOKS
<static> object CARS
<static> object CHILDREN
<static> object CURRENT_LOCATION
<static> object DATE_OF_BIRTH
<static> object DRINKER
<static> object EMAILS
<static> object ETHNICITY
<static> object FASHION
<static> object FOOD
<static> object GENDER
<static> object HAPPIEST_WHEN
<static> object HAS_APP
<static> object HEROES
<static> object HUMOR
<static> object ID
<static> object INTERESTS
<static> object JOB_INTERESTS
<static> object JOBS
<static> object LANGUAGES_SPOKEN
<static> object LIVING_ARRANGEMENT
<static> object LOOKING_FOR
<static> object MOVIES
<static> object MUSIC
<static> object NAME
<static> object NETWORK_PRESENCE
<static> object NICKNAME
<static> object PETS
<static> object PHONE_NUMBERS
<static> object POLITICAL_VIEWS
<static> object PROFILE_SONG
<static> object PROFILE_URL
<static> object PROFILE_VIDEO
<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
<static> object SPORTS
<static> object STATUS
<static> object TAGS
<static> object THUMBNAIL_URL
<static> object TIME_ZONE
<static> object TURN_OFFS
<static> object TURN_ONS
<static> object TV_SHOWS
<static> object URLS
所有电话对象的基本接口。
String getField(key, opt_params)
String getField(key, opt_params)
String key
- 要获取数据的关键字;关键字在 Phone.Field
中定义 Map.<opensocial.DataRequest.DataRequestFields, Object> opt_params
- 要传递给请求的其他参数。 String
数据 联系电话具有的所有域。这些域是 Phone.getField() 方法支持的关键字。
<static> object NUMBER
<static> object TYPE
表示通过处理服务器上的数据请求项目而生成的响应。
Object getData()
String getErrorCode()
String getErrorMessage()
opensocial.DataRequest getOriginalDataRequest()
Boolean hadError()
Object getData()
Object
由服务器计算的请求的值;该值的类型由所提请求的类型定义。 String getErrorCode()
Error
定义的某个值。 String
错误代码,如果没有错误,则为 Null String getErrorMessage()
String
对已发生错误所做的用户可阅读的描述;可以为 Null(即使发生了错误) opensocial.DataRequest getOriginalDataRequest()
opensocial.DataRequest
用于获取此数据响应的数据请求 Boolean hadError()
Boolean
如果出错,则返回 True;否则返回 False 响应项目可以返回的错误代码。
<static> object BAD_REQUEST
<static> object FORBIDDEN
<static> object INTERNAL_ERROR
<static> object LIMIT_EXCEEDED
<static> object NOT_IMPLEMENTED
<static> object UNAUTHORIZED
<static> object BAD_REQUEST
<static> object FORBIDDEN
<static> object INTERNAL_ERROR
<static> object LIMIT_EXCEEDED
<static> object NOT_IMPLEMENTED
<static> object UNAUTHORIZED
所有网址对象的基本接口。
String getField(key, opt_params)
String getField(key, opt_params)
String key
- 要获取数据的关键字;关键字在 Url.Field
中定义 Map.<opensocial.DataRequest.DataRequestFields, Object> opt_params
- 要传递给请求的其他参数。 String
数据 网址具有的所有域。这些域是 Url.getField() 方法支持的关键字。
<static> object ADDRESS
<static> object LINK_TEXT
<static> object TYPE
<static> object ADDRESS
<static> object LINK_TEXT
<static> object TYPE