JavaScript API v3.14

osapi.jive.corev3.Embedded

Entity representing an embedded field representing an embedded experience that can be included in an activity stream entry. It is included in an OpenSocial 2.5 extension to the activitystrea.ms specificatoin.

See the Open Social specification.

Properties

context
gadget
preferredExperience
previewImage
url

Properties

Property	Type	Mode †	Description
`context`	`Object`	read-only	↑ Open ended collection of data that describes, to an OpenSocial gadget, exactly what content to render. For example, a gadget that renders a person's profile information will need to know which profile to display, The set of keys in the `context` field is undefined, but the field MUST NOT include a key with the value `openSocial`, which is reserved for use by a container implementation.
`gadget`	`String`	read-only	↑ URI of the OpenSocial gadget definition document that describes the gadget to be embedded. Either `gadget` or `url` (but not both) MUST be present.
`preferredExperience`	`Object`	read-only	↑ Open ended collection of properties that describe the preferred way that the creator of the embedded experience would like containers to render the content. Think of this as "view" characteristics, while the `context` element represents "model" characteristics.
`previewImage`	`String`	read-only	↑ Either an http/https URI of an image that can be used as a preview for the embedded content, or a data: URI containing the bits of the preview image.
`url`	`String`	read-only	↑ URL to a web page that allows virtually any web-accessible resource to be used as an embedded experience. Either `gadget` or `url` (but not both) MUST be present.