Opensocial.Activity (v0.8)

From OpenSocial

opensocial.Activity

Representation of an activity.

Activities are rendered with a title and an optional activity body.

You may set the title and body directly as strings when calling opensocial.newActivity. However, it is usually beneficial to create activities using Message Templates for the title and body.

Users will have many activities in their activity streams, and containers will not show every activity that is visible to a user. To help display large numbers of activities, containers will summarize a list of activities from a given source to a single entry.

You can provide Activity Summaries to customize the text shown when multiple activities are summarized. If no customization is provided, a container may ignore your activities altogether or provide default text such as "Bob changed his status message + 20 other events like this."

• Activity Summaries will always summarize around a specific key in a key/value pair. This is so that the summary can say something concrete (this is clearer in the example below).
• Other variables will have synthetic "Count" variables created with the total number of items summarized.
• Message ID of the summary is the message ID of the main template + ":" + the data key

See also: opensocial.Message, opensocial.newActivity(), opensocial.requestCreateActivity(), opensocial.Activity.Field,

Methods

opensocial.Activity.getId

String opensocial.Activity.getId

None

Returns

String - The ID

opensocial.Activity.getField

String opensocial.Activity.getField(key, opt_params)

Parameters

String key - The key to get data for; see the <a href="opensocial.Activity.Field.html">Field</a> class for possible values

Map.<opensocial.DataRequest.DataRequestFields, Object> opt_params - Additional <a href="opensocial.DataRequest.DataRequestFields.html">params</a> to pass to the request.

Returns

String - The data

opensocial.Activity.setField

opensocial.Activity.setField

Parameters

String key - The key to set data for

String data - The data to set

Returns

None

Fields

opensocial.Activity.Field.TITLE_ID

A string specifying the title template message ID in the gadget spec.

The title is the primary text of an activity.

Titles may only have the following HTML tags: <b> <i>, <a>, <span>. The container may ignore this formatting when rendering the activity.

This field may be used interchangeably with the string 'titleId'.

opensocial.Activity.Field.TITLE

A string specifying the primary text of an activity.

Titles may only have the following HTML tags: <b> <i>, <a>, <span>. The container may ignore this formatting when rendering the activity.

This field may be used interchangeably with the string 'title'.

opensocial.Activity.Field.TEMPLATE_PARAMS

A map of custom key/value pairs associated with this activity. These will be used for evaluation in templates.

The data has type Map<String, Object>. The object may be either a String or an opensocial.Person.

When passing in a person with key PersonKey, can use the following replacement variables in the template:

• PersonKey.DisplayName - Display name for the person
• PersonKey.ProfileUrl. URL of the person's profile
• PersonKey.Id - The ID of the person
• PersonKey - Container may replace with DisplayName, but may also optionally link to the user.

This field may be used interchangeably with the string 'templateParams'.

opensocial.Activity.Field.URL

A string specifying the URL that represents this activity.

This field may be used interchangeably with the string 'url'.

opensocial.Activity.Field.MEDIA_ITEMS

Any photos, videos, or images that should be associated with the activity. Higher priority ones are higher in the list. The data has type Array< <a href="opensocial.MediaItem.html">MediaItem</a>>.

This field may be used interchangeably with the string 'mediaItems'.

opensocial.Activity.Field.BODY_ID

A string specifying the body template message ID in the gadget spec.

The body is an optional expanded version of an activity.

Bodies may only have the following HTML tags: <b> <i>, <a>, <span>. The container may ignore this formatting when rendering the activity.

This field may be used interchangeably with the string 'bodyId'.

opensocial.Activity.Field.BODY

A string specifying an optional expanded version of an activity.

Bodies may only have the following HTML tags: <b> <i>, <a>, <span>. The container may ignore this formatting when rendering the activity.

This field may be used interchangeably with the string 'body'.

opensocial.Activity.Field.EXTERNAL_ID

An optional string ID generated by the posting application.

This field may be used interchangeably with the string 'externalId'.

opensocial.Activity.Field.STREAM_TITLE

A string specifing the title of the stream.

This field may be used interchangeably with the string 'streamTitle'.

opensocial.Activity.Field.STREAM_URL

A string specifying the stream's URL.

This field may be used interchangeably with the string 'streamUrl'.

opensocial.Activity.Field.STREAM_SOURCE_URL

A string specifying the stream's source URL.

This field may be used interchangeably with the string 'streamSourceUrl'.

opensocial.Activity.Field.STREAM_FAVICON_URL

A string specifying the URL for the stream's favicon.

This field may be used interchangeably with the string 'streamFaviconUrl'.

opensocial.Activity.Field.PRIORITY

A number between 0 and 1 representing the relative priority of this activity in relation to other activities from the same source

This field may be used interchangeably with the string 'priority'.

opensocial.Activity.Field.ID

A string ID that is permanently associated with this activity. This value can not be set.

This field may be used interchangeably with the string 'id'.

opensocial.Activity.Field.USER_ID

The string ID of the user who this activity is for. This value can not be set.

This field may be used interchangeably with the string 'userId'.

opensocial.Activity.Field.APP_ID

A string specifying the application that this activity is associated with. This value can not be set.

This field may be used interchangeably with the string 'appId'.

opensocial.Activity.Field.POSTED_TIME

A string specifying the time at which this activity took place in milliseconds since the epoch. This value can not be set.

This field may be used interchangeably with the string 'postedTime'.

Examples

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

Category: Pages with example code that should be improved