JiveEmbedded Class Reference

#import <JiveEmbedded.h>

Inherits JiveObject.

Properties
NSDictionary *	context
NSURL *	gadget
NSDictionary *	preferredExperience
NSString *	previewImage
NSURL *	url

Detailed Description

https://docs.developers.jivesoftware.com/api/v3/cloud/rest/EmbeddedEntity.html

Property Documentation

- (NSDictionary*) context

readnonatomicstrong

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.

- (NSURL*) gadget

readnonatomicstrong

URI of the OpenSocial gadget definition document that describes the gadget to be embedded. Either gadget or url (but not both) MUST be present.

- (NSDictionary*) preferredExperience

readnonatomicstrong

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.

- (NSString*) previewImage

readnonatomicstrong

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.

- (NSURL*) url

readnonatomicstrong

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.