Component

extends UIComponent

The Share Dialog component is an SAPUI5 component that you can use to create a dialog in your application to enable you to enter or edit information shared to SAP Jam.

Since: version 1.16.

Constructor Summary

new sap.collaboration.components.fiori.sharing.dialog.Component(oDataServiceUrl?, object?, externalObject?, attachments?)Constructor for the share dialog component

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

Events borrowed from class sap.ui.base.ManagedObject

formatError, modelContextChange, parseError, validationError, validationSuccess

Method Summary

sap.collaboration.components.fiori.sharing.dialog.Component.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.collaboration.components.fiori.sharing.dialog.Component with name sClassName and enriches it with the information contained in oClassInfo.

sap.collaboration.components.fiori.sharing.dialog.Component.getMetadata()Returns a metadata object for class sap.collaboration.components.fiori.sharing.dialog.Component.

sap.collaboration.components.fiori.sharing.dialog.Component.open()Opens the share component dialog

sap.collaboration.components.fiori.sharing.dialog.Component.setSettings(oSettings)Setter for the Component settings.

getAttachments()Gets current value of property attachments.

getExternalObject()Gets current value of property externalObject.

getObject()Gets current value of property object.

setAttachments(oAttachments)Sets a new value for property attachments.

setExternalObject(oExternalObject)Sets a new value for property externalObject.

setObject(oObject)Sets a new value for property object.

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.sharing.dialog.Component(oDataServiceUrl?, object?, externalObject?, attachments?)

Constructor for the share 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:

Properties
- attachments : object
- object : object
- externalObject : object

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

Parameters:

{sap.ui.core.URI}	oDataServiceUrl?	DEPRECATED The OData service URL will no longer be taken into account.
{object}	object?	A JSON object passed to the share component. This object contains the following properties: id (optional): is the object Id to be shared in SAP Jam, i.e a URL( or a callback function that returns a URL) that navigates back to the same object in the application display (optional): is a UI5 control to be displayed in the component UI Note: The preferred object to pass in the display parameter is `sap.m.ObjectListItem`. Using other type of objects (for example: `ap.ui.commons.TextView`) may result in problems in the rendering of the content which needs to be corrected by the application owners. share (optional): is a note that will be displayed in the component UI and shared to SAP Jam too
{object}	externalObject?	A Business Object such as an Opportunity, Sales Order, Account, etc. from the back-end that will be shared as a Featured External Object in a Group in Jam. {string} appContext: The application context. Example: "CRM", "SD", etc. {string} odataServicePath: The relative path to the OData Service. Example: "/sap/opu/odata/sap/ODATA_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. These attributes are not enforced by the UI (missing or incorrect values are not validated), but they are required to make the integration work. These attributes also should be mapped in the Back-end System and Jam in order to make the External Object work. Note: the externalObject is dependent on object.id, therefore, the object.id must also be passed to the Share Component. See the parameter "object" for more information.
{object}	attachments?	When you want to provide the user with the option to share file attachments, then the following properties need to be specified: attachmentsArray: An array of sap.collaboration.components.fiori.sharing.attachment.Attachment objects. This array offers users a list of files they can attach.

Method Detail

sap.collaboration.components.fiori.sharing.dialog.Component.extend(sClassName, oClassInfo?, FNMetaImpl?): function

Creates a new subclass of class sap.collaboration.components.fiori.sharing.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.sharing.dialog.Component.getMetadata(): sap.ui.base.Metadata

Returns a metadata object for class sap.collaboration.components.fiori.sharing.dialog.Component.

Returns:

{sap.ui.base.Metadata}

Metadata object describing this class

sap.collaboration.components.fiori.sharing.dialog.Component.open()

Opens the share component dialog

sap.collaboration.components.fiori.sharing.dialog.Component.setSettings(oSettings)

Setter for the Component settings.

Parameters:

{object}

oSettings

A JSON object used to set the component settings, this object should contains the same properties used in the constructor.

getAttachments(): object

Gets current value of property attachments.

Returns:

{object} Value of property attachments

getExternalObject(): object

Gets current value of property externalObject.

Returns:

{object} Value of property externalObject

getObject(): object

Gets current value of property object.

Returns:

{object} Value of property object

setAttachments(oAttachments): sap.collaboration.components.fiori.sharing.dialog.Component

Sets a new value for property attachments.

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

Parameters:

{object} oAttachments New value for property attachments

Returns:

{sap.collaboration.components.fiori.sharing.dialog.Component} Reference to this in order to allow method chaining

setExternalObject(oExternalObject): sap.collaboration.components.fiori.sharing.dialog.Component

Sets a new value for property externalObject.

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

Parameters:

{object} oExternalObject New value for property externalObject

Returns:

{sap.collaboration.components.fiori.sharing.dialog.Component} Reference to this in order to allow method chaining

setObject(oObject): sap.collaboration.components.fiori.sharing.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.sharing.dialog.Component} Reference to this in order to allow method chaining