Class sap.collaboration.components.fiori.sharing.ComponentModule: sap/collaboration/components/fiori/sharing/Component

Share Component

A Share Component is a ui5 component that applications can use to share information to SAP Jam

Deprecated API:Since version 1.26.0. Please use sap.collaboration.components.fiori.sharing.dialog.Component instead.


Since: version 1.16.
Constructor Summary
new sap.collaboration.components.fiori.sharing.Component(oDataServiceUrl?, attachments?)Constructor for the share component

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

Method Summary
sap.collaboration.components.fiori.sharing.Component.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.collaboration.components.fiori.sharing.Component with name sClassName and enriches it with the information contained in oClassInfo.
sap.collaboration.components.fiori.sharing.Component.getMetadata()Returns a metadata object for class sap.collaboration.components.fiori.sharing.Component.
sap.collaboration.components.fiori.sharing.Component.setSettings(oSettings)Setter for the Component settings.
sap.collaboration.components.fiori.sharing.Component.shareToJam()Shares the data to Jam group
getAttachments()Gets current value of property attachments.
getCollaborationHostODataServiceUrl()Gets current value of property collaborationHostODataServiceUrl.
getExternalObject()Gets current value of property externalObject.
getHeight()Gets current value of property height.
getObject()Gets current value of property object.
getODataServiceUrl()Gets current value of property oDataServiceUrl.
getTunnelServiceUrl()Gets current value of property tunnelServiceUrl.
getWidth()Gets current value of property width.
setAttachments(oAttachments)Sets a new value for property attachments.
setCollaborationHostODataServiceUrl(sCollaborationHostODataServiceUrl)Sets a new value for property collaborationHostODataServiceUrl.
setExternalObject(oExternalObject)Sets a new value for property externalObject.
setHeight(sHeight)Sets a new value for property height.
setObject(oObject)Sets a new value for property object.
setODataServiceUrl(sODataServiceUrl)Sets a new value for property oDataServiceUrl.
setTunnelServiceUrl(sTunnelServiceUrl)Sets a new value for property tunnelServiceUrl.
setWidth(sWidth)Sets a new value for property width.
Constructor Detail
new sap.collaboration.components.fiori.sharing.Component(oDataServiceUrl?, attachments?)
Constructor for the share 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:

Parameters:
{sap.ui.core.URI}oDataServiceUrl? The OData service URL needed for the share component, the default value is "/sap/opu/odata/sap/SM_INTEGRATION_SRV"
{object}attachments? When you want to provide the user with the option to share file attachments, then the following properties need to be specified:
Deprecated:
Since version 1.26.0. Please use sap.collaboration.components.fiori.sharing.dialog.Component instead.
Method Detail
sap.collaboration.components.fiori.sharing.Component.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.collaboration.components.fiori.sharing.Component with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of information as described in Object.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.Component.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.collaboration.components.fiori.sharing.Component.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
sap.collaboration.components.fiori.sharing.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.
sap.collaboration.components.fiori.sharing.Component.shareToJam()
Shares the data to Jam group
getAttachments(): object
Gets current value of property attachments.
Returns:
{object} Value of property attachments
getCollaborationHostODataServiceUrl(): sap.ui.core.URI
Gets current value of property collaborationHostODataServiceUrl.

Default value is /sap/bc/ui2/smi/rest_tunnel/Jam/api/v1/OData.

Returns:
{sap.ui.core.URI} Value of property collaborationHostODataServiceUrl
getExternalObject(): object
Gets current value of property externalObject.
Returns:
{object} Value of property externalObject
getHeight(): sap.ui.core.CSSSize
Gets current value of property height.

Default value is 100%.

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

Default value is /sap/opu/odata/sap/SM_INTEGRATION_V2_SRV.

Returns:
{sap.ui.core.URI} Value of property oDataServiceUrl
getTunnelServiceUrl(): sap.ui.core.URI
Gets current value of property tunnelServiceUrl.

Default value is /sap/bc/z_sail_httproxy/Jam/api/v1/OData.

Returns:
{sap.ui.core.URI} Value of property tunnelServiceUrl
getWidth(): sap.ui.core.CSSSize
Gets current value of property width.

Default value is 100%.

Returns:
{sap.ui.core.CSSSize} Value of property width
setAttachments(oAttachments): sap.collaboration.components.fiori.sharing.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.Component} Reference to this in order to allow method chaining
setCollaborationHostODataServiceUrl(sCollaborationHostODataServiceUrl): sap.collaboration.components.fiori.sharing.Component
Sets a new value for property collaborationHostODataServiceUrl.

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

Default value is /sap/bc/ui2/smi/rest_tunnel/Jam/api/v1/OData.

Parameters:
{sap.ui.core.URI}sCollaborationHostODataServiceUrl New value for property collaborationHostODataServiceUrl
Returns:
{sap.collaboration.components.fiori.sharing.Component} Reference to this in order to allow method chaining
setExternalObject(oExternalObject): sap.collaboration.components.fiori.sharing.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.Component} Reference to this in order to allow method chaining
setHeight(sHeight): sap.collaboration.components.fiori.sharing.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 100%.

Parameters:
{sap.ui.core.CSSSize}sHeight New value for property height
Returns:
{sap.collaboration.components.fiori.sharing.Component} Reference to this in order to allow method chaining
setObject(oObject): sap.collaboration.components.fiori.sharing.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.Component} Reference to this in order to allow method chaining
setODataServiceUrl(sODataServiceUrl): sap.collaboration.components.fiori.sharing.Component
Sets a new value for property oDataServiceUrl.

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

Default value is /sap/opu/odata/sap/SM_INTEGRATION_V2_SRV.

Parameters:
{sap.ui.core.URI}sODataServiceUrl New value for property oDataServiceUrl
Returns:
{sap.collaboration.components.fiori.sharing.Component} Reference to this in order to allow method chaining
setTunnelServiceUrl(sTunnelServiceUrl): sap.collaboration.components.fiori.sharing.Component
Sets a new value for property tunnelServiceUrl.

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

Default value is /sap/bc/z_sail_httproxy/Jam/api/v1/OData.

Parameters:
{sap.ui.core.URI}sTunnelServiceUrl New value for property tunnelServiceUrl
Returns:
{sap.collaboration.components.fiori.sharing.Component} Reference to this in order to allow method chaining
setWidth(sWidth): sap.collaboration.components.fiori.sharing.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 100%.

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