Component

extends UIComponent

The Feed Component is an SAPUI5 component that allows you to display SAP Jam feeds. It includes the option to add new posts and reply to entries and view other users' social profiles from SAP Jam.

Since: 1.30.

Constructor Summary

new sap.collaboration.components.feed.Component(sId?, mSettings?)Constructor for the Feed Component.

Events borrowed from class sap.ui.base.ManagedObject

formatError, modelContextChange, parseError, validationError, validationSuccess

Method Summary

sap.collaboration.components.feed.Component.createContent()The method to create the Content (UI Control Tree) of the Component.

sap.collaboration.components.feed.Component.exit()Cleans up the component instance before destruction.

sap.collaboration.components.feed.Component.getSelectedGroup()Returns the selected Group.

sap.collaboration.components.feed.Component.init()Initializes the Component instance after creation.

sap.collaboration.components.feed.Component.onAfterRendering()Function is called when the rendering of the Component Container is completed.

sap.collaboration.components.feed.Component.onBeforeRendering()Function is called when the rendering of the Component Container is started.

sap.collaboration.components.feed.Component.setAxisOrientation(axisOrientation)Set the axis orientation for the Timeline.

sap.collaboration.components.feed.Component.setEnableScroll(enableScroll)Sets the enableScroll property for the Timeline.

sap.collaboration.components.feed.Component.setFeedSources(feedSources)Sets the sources for the feed.

sap.collaboration.components.feed.Component.setSettings(settings)Sets all the properties passed in oSettings.

getAxisOrientation()Getter for property axisOrientation.

getEnableScroll()Getter for property enableScroll.

getFeedSources()Getter for property feedSources.

setAxisOrientation(oAxisOrientation)Setter for property axisOrientation.

setEnableScroll(bEnableScroll)Setter for property enableScroll.

setFeedSources(oFeedSources)Setter for property feedSources.

Methods borrowed from class sap.ui.core.UIComponent

byId, createContent, createId, getAutoPrefixId, getEventingParent, getRouter, getTargets, getUIArea, init, onAfterRendering, onBeforeRendering, render, setContainer

Methods borrowed from class sap.ui.core.Component

exit, getComponentData, getEventBus, getInterface, getManifest, getManifestEntry, getManifestObject, getMetadata, getService, onConfigChange, onWindowBeforeUnload, onWindowError, onWindowUnload, runAsOwner

Methods borrowed from class sap.ui.base.ManagedObject

addAggregation, addAssociation, applySettings, attachFormatError, attachModelContextChange, attachParseError, attachValidationError, attachValidationSuccess, bindAggregation, bindContext, bindObject, bindProperty, clone, destroy, destroyAggregation, detachFormatError, detachModelContextChange, detachParseError, detachValidationError, detachValidationSuccess, findAggregatedObjects, fireFormatError, fireModelContextChange, fireParseError, fireValidationError, fireValidationSuccess, getAggregation, getAssociation, getBinding, getBindingContext, getBindingInfo, getBindingPath, getId, getModel, getObjectBinding, getOriginInfo, getParent, getProperty, hasModel, indexOfAggregation, insertAggregation, invalidate, isBound, isInvalidateSuppressed, isTreeBinding, propagateMessages, removeAggregation, removeAllAggregation, removeAllAssociation, removeAssociation, setAggregation, setAssociation, setBindingContext, setModel, setProperty, toString, unbindAggregation, unbindContext, unbindObject, unbindProperty, validateAggregation, validateProperty

Methods borrowed from class sap.ui.base.EventProvider

attachEvent, attachEventOnce, detachEvent, fireEvent, hasListeners

Constructor Detail

new sap.collaboration.components.feed.Component(sId?, mSettings?)

Constructor for the Feed Component.

Accepts an object literal mSettings that defines initial property values, aggregated and associated objects as well as event handlers.

The supported settings are:

Properties
- axisOrientation : sap.suite.ui.commons.TimelineAxisOrientation (default: sap.suite.ui.commons.TimelineAxisOrientation.Vertical)
- feedSources : map|string[]
- enableScroll : boolean (default: true)

Parameters:

{string}	sId?	id for the new component, generated automatically if no id is given
{map}	mSettings?	initial settings for the new component. See the documentation of the component's properties for the structure of the expected data.

Method Detail

sap.collaboration.components.feed.Component.createContent()

The method to create the Content (UI Control Tree) of the Component.

sap.collaboration.components.feed.Component.exit()

Cleans up the component instance before destruction.

sap.collaboration.components.feed.Component.getSelectedGroup(): map

Returns the selected Group.

Returns:

{map}

a map containing information about the selected Group (e.g. Id, Name, etc...)

sap.collaboration.components.feed.Component.init()

Initializes the Component instance after creation.

sap.collaboration.components.feed.Component.onAfterRendering()

Function is called when the rendering of the Component Container is completed.

sap.collaboration.components.feed.Component.onBeforeRendering()

Function is called when the rendering of the Component Container is started.

sap.collaboration.components.feed.Component.setAxisOrientation(axisOrientation)

Set the axis orientation for the Timeline.

Parameters:

{sap.suite.ui.commons.TimelineAxisOrientation}

axisOrientation

sap.collaboration.components.feed.Component.setEnableScroll(enableScroll)

Sets the enableScroll property for the Timeline.

Parameters:

{boolean}

enableScroll

sap.collaboration.components.feed.Component.setFeedSources(feedSources)

Sets the sources for the feed. Array of strings representing the Jam group IDs (e.g. ["groupid1", "groupid2"]).

Parameters:

{object}

feedSources

sap.collaboration.components.feed.Component.setSettings(settings)

Sets all the properties passed in oSettings.

Parameters:

{map}

settings

key/value map for settings

getAxisOrientation(): sap.suite.ui.commons.TimelineAxisOrientation

Getter for property axisOrientation.

Default value is Vertical

Returns:

{sap.suite.ui.commons.TimelineAxisOrientation} the value of property axisOrientation

getEnableScroll(): boolean

Getter for property enableScroll.

Returns:

{boolean} the value of property enableScroll

getFeedSources(): map|string[]

Getter for property feedSources.

Returns:

{map|string[]} the value of property feedSources

setAxisOrientation(oAxisOrientation): sap.collaboration.components.feed.Component

Setter for property axisOrientation.

Default value is Vertical

Parameters:

{sap.suite.ui.commons.TimelineAxisOrientation} oAxisOrientation new value for property axisOrientation

Returns:

{sap.collaboration.components.feed.Component} this to allow method chaining

setEnableScroll(bEnableScroll): sap.collaboration.components.feed.Component

Setter for property enableScroll.

Sets the property enableScroll on the Timeline.

Setting this property to false will remove the scrollbar on the Timeline.

Default value is true

Parameters:

{boolean} bEnableScroll new value for property enableScroll

Returns:

{sap.collaboration.components.feed.Component} this to allow method chaining

setFeedSources(oFeedSources)

Setter for property feedSources.

The feedSources is either an array of strings (SAP Jam Group IDs) or a map in the following structure:
{ mode : sap.collaboration.FeedType, data : any }
Based on the mode, the data is either required or not.

Parameters:

{map|string[]} oFeedSources new value for property feedSources