Class sap.collaboration.components.fiori.feed.dialog.ComponentModule: sap/collaboration/components/fiori/feed/dialog/Component

extends UIComponent

Feed Dialog Component

A Feed Dialog Component is a ui5 component that applications can use to render the feed widget view in a dialog in order to discuss information in SAP JAM by adding and replying to feed posts related to a specific Business Object.

Deprecated API:Since version 1.34.0. For new integrations and existing implementations running on release 1.32 or later, use the Group Feed component (sap.collaboration.components.feed.Component), Business Object mode(sap.collaboration.FeedType.BusinessObjectGroups). Note that the Group Feed component does not display the full public feed for the object in SAP Jam (object wall), but rather is restricted to the feed for the object within a specific group (group object wall).


Since: version 1.16.
Constructor Summary
new sap.collaboration.components.fiori.feed.dialog.Component(businessObject, oDataServiceUrl?, feedType?, groupIds?, object?)Constructor for the Feed Dialog Component.
Events borrowed from class sap.ui.base.ManagedObject
formatError, modelContextChange, parseError, validationError, validationSuccess
Method Summary
sap.collaboration.components.fiori.feed.dialog.Component.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.collaboration.components.fiori.feed.dialog.Component with name sClassName and enriches it with the information contained in oClassInfo.
sap.collaboration.components.fiori.feed.dialog.Component.getMetadata()Returns a metadata object for class sap.collaboration.components.fiori.feed.dialog.Component.
sap.collaboration.components.fiori.feed.dialog.Component.open()Open the Feed Dialog.
sap.collaboration.components.fiori.feed.dialog.Component.setSettings(oSettings)Contract for passing the settings to the Component.
getBusinessObject()Gets current value of property businessObject.
getFeedType()Gets current value of property feedType.
getGroupIds()Gets current value of property groupIds.
getHeight()Gets current value of property height.
getObject()Gets current value of property object.
getWidth()Gets current value of property width.
setBusinessObject(oBusinessObject)Sets a new value for property businessObject.
setFeedType(sFeedType)Sets a new value for property feedType.
setGroupIds(sGroupIds)Sets a new value for property groupIds.
setHeight(sHeight)Sets a new value for property height.
setObject(oObject)Sets a new value for property object.
setWidth(sWidth)Sets a new value for property width.
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.fiori.feed.dialog.Component(businessObject, oDataServiceUrl?, feedType?, groupIds?, object?)
Constructor for the Feed Dialog Component.

Accepts an object literal mSettings that defines initial property values, aggregated and associated objects as well as event handlers. See sap.ui.base.ManagedObject for a general description of the syntax of the settings object.

The supported settings are:

In addition, all settings applicable to the base type sap.ui.core.UIComponent can be used as well.

Parameters:
{object}businessObject A JSON object passed to the Feed Dialog Component. This object represents business related information, such as a sales order, an opportunity, etc. It contains the following properties:
  • {string} appContext: The application context. Example: "CRM", "CB", "SD", etc.
  • {string} odataServicePath: The path to the OData Service and the Service name. Example: "/sap/opu/odata/sap/APPLICATION_SRV".
  • {string} collection: The name of the OData Collection. Example: "Account", "Opportunity", etc.
  • {string} key: The key to identify a particular instance of the Business Object. It can be a simple ID or a compound key. Example: "123", "ObjectID='123'", "ObjectID='123',ObjectType='BUS000123'", etc.
  • {string} name: The short name of the Business Object. Example: "Sales Order 123", "Opportunity 123", "Account 123", etc.
  • {string} ui_url: The URL to navigate to the same business object in the application.
{sap.ui.core.URI}oDataServiceUrl?[DEPRECATED] The OData service URL needed for the Feed Dialog Component, the default value is "/sap/opu/odata/sap/SM_INTEGRATION_SRV".
{sap.collaboration.FeedType}feedType?[DEPRECATED] The type of feed to be displayed.
{string}groupIds?[DEPRECATED] A comma separated list of group IDs.
{object}object?[DEPRECATED] A JSON object passed to the Feed Dialog Component. Use businessObject instead. This object represents business related information, such as a sales order, an opportunity, etc. It contains the following properties:
  • id: The Business Object ID to be posted in the SAP Jam Feed. It needs to be an OData URL containing the relative path to the object in the back-end.
  • type: the type of the business object. It can be any text or it can be the OData meta data URL to the object Entity Type.
  • name (optional): the description of the business object to be displayed in SAP Jam, i.e. "SO 57746", "Opportunity 123", etc.
  • ui_url (optional): the URL to navigate to the same business object in the application.
Note: The object is passed by reference, which means that the attributes will be modified in the original object, for example, when the URLs contained in the id and type attributes are mapped (via OData call).
Deprecated:
Since version 1.34.0. For new integrations and existing implementations running on release 1.32 or later, use the Group Feed component (sap.collaboration.components.feed.Component), Business Object mode(sap.collaboration.FeedType.BusinessObjectGroups). Note that the Group Feed component does not display the full public feed for the object in SAP Jam (object wall), but rather is restricted to the feed for the object within a specific group (group object wall).
Method Detail
sap.collaboration.components.fiori.feed.dialog.Component.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.collaboration.components.fiori.feed.dialog.Component with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of information as described in sap.ui.core.UIComponent.extend.

Parameters:
{string}sClassName Name of the class being created
{object}oClassInfo? Object literal with information about the class
{function}FNMetaImpl? Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
Returns:
{function} Created class / constructor function
sap.collaboration.components.fiori.feed.dialog.Component.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.collaboration.components.fiori.feed.dialog.Component.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
sap.collaboration.components.fiori.feed.dialog.Component.open()
Open the Feed Dialog.
sap.collaboration.components.fiori.feed.dialog.Component.setSettings(oSettings)
Contract for passing the settings to the Component.
Parameters:
{object}oSettings A JSON object containing the following attributes:
  • {object} businessObject: the representation of a business object.
  • {sap.collaboration.FeedType} [DEPRECATED] feedType: the type of feed to be displayed.
  • {string} [DEPRECATED] [groupIds?]: a comma separated list of group IDs.
  • {object} [DEPRECATED] object: the representation of a business object. Use businessObject instead
getBusinessObject(): object
Gets current value of property businessObject.
Returns:
{object} Value of property businessObject
getFeedType(): string
Gets current value of property feedType.

Default value is sap.collaboration.FeedType.object.

Returns:
{string} Value of property feedType
getGroupIds(): string
Gets current value of property groupIds.
Returns:
{string} Value of property groupIds
getHeight(): sap.ui.core.CSSSize
Gets current value of property height.

Default value is 605px.

Returns:
{sap.ui.core.CSSSize} Value of property height
getObject(): object
Gets current value of property object.
Returns:
{object} Value of property object
getWidth(): sap.ui.core.CSSSize
Gets current value of property width.

Default value is 575px.

Returns:
{sap.ui.core.CSSSize} Value of property width
setBusinessObject(oBusinessObject): sap.collaboration.components.fiori.feed.dialog.Component
Sets a new value for property businessObject.

When called with a value of null or undefined, the default value of the property will be restored.

Parameters:
{object}oBusinessObject New value for property businessObject
Returns:
{sap.collaboration.components.fiori.feed.dialog.Component} Reference to this in order to allow method chaining
setFeedType(sFeedType): sap.collaboration.components.fiori.feed.dialog.Component
Sets a new value for property feedType.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is sap.collaboration.FeedType.object.

Parameters:
{string}sFeedType New value for property feedType
Returns:
{sap.collaboration.components.fiori.feed.dialog.Component} Reference to this in order to allow method chaining
setGroupIds(sGroupIds): sap.collaboration.components.fiori.feed.dialog.Component
Sets a new value for property groupIds.

When called with a value of null or undefined, the default value of the property will be restored.

Parameters:
{string}sGroupIds New value for property groupIds
Returns:
{sap.collaboration.components.fiori.feed.dialog.Component} Reference to this in order to allow method chaining
setHeight(sHeight): sap.collaboration.components.fiori.feed.dialog.Component
Sets a new value for property height.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is 605px.

Parameters:
{sap.ui.core.CSSSize}sHeight New value for property height
Returns:
{sap.collaboration.components.fiori.feed.dialog.Component} Reference to this in order to allow method chaining
setObject(oObject): sap.collaboration.components.fiori.feed.dialog.Component
Sets a new value for property object.

When called with a value of null or undefined, the default value of the property will be restored.

Parameters:
{object}oObject New value for property object
Returns:
{sap.collaboration.components.fiori.feed.dialog.Component} Reference to this in order to allow method chaining
setWidth(sWidth): sap.collaboration.components.fiori.feed.dialog.Component
Sets a new value for property width.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is 575px.

Parameters:
{sap.ui.core.CSSSize}sWidth New value for property width
Returns:
{sap.collaboration.components.fiori.feed.dialog.Component} Reference to this in order to allow method chaining