Class sap.collaboration.components.socialprofile.ComponentModule: sap/collaboration/components/socialprofile/Component

extends UIComponent

Social Profile Component

Experimental API:The API is not stable and the UI is not finalized. The implementation for this feature is subject to change.


Since: version 1.25.
Constructor Summary
new sap.collaboration.components.socialprofile.Component(sId?, mSettings?)Constructor for the Social Profile Component.
Method Summary
sap.collaboration.components.socialprofile.Component.exit()Cleans up the component instance before destruction.
sap.collaboration.components.socialprofile.Component.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.collaboration.components.socialprofile.Component with name sClassName and enriches it with the information contained in oClassInfo.
sap.collaboration.components.socialprofile.Component.getMetadata()Returns a metadata object for class sap.collaboration.components.socialprofile.Component.
sap.collaboration.components.socialprofile.Component.init()Initializes the Component instance after creation.
sap.collaboration.components.socialprofile.Component.onAfterRendering()Function is called when the rendering of the Component Container is completed.
sap.collaboration.components.socialprofile.Component.onBeforeRendering()Function is called when the rendering of the Component Container is started.
sap.collaboration.components.socialprofile.Component.setSettings(oSettings)Setter for the Component settings
getHeight()Getter for property height.
getMemberId()Getter for property memberId.
getMemberInfo()Getter for property memberInfo.
getOpeningControl()Getter for property openingControl.
getPlacement()Getter for property placement.
getWidth()Getter for property width.
setHeight(sHeight)Setter for property height.
setMemberId(sMemberId)Setter for property memberId.
setMemberInfo(oMemberInfo)Setter for property memberInfo.
setOpeningControl(oOpeningControl)Setter for property openingControl.
setPlacement(sPlacement)Setter for property placement.
setWidth(sWidth)Setter for property width.
Constructor Detail
new sap.collaboration.components.socialprofile.Component(sId?, mSettings?)
Constructor for the Social Profile Component.

!!! EXPERIMENTAL !!!

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

If the name of a setting is ambiguous (e.g. a property has the same name as an event), then the framework assumes property, aggregation, association, event in that order. To override this automatic resolution, one of the prefixes "aggregation:", "association:" or "event:" can be added to the name of the setting (such a prefixed name must be enclosed in single or double quotes).

The supported settings are:

Parameters:
{string}sId? id for the new control, generated automatically if no id is given
{object}mSettings? initial settings for the new control
Method Detail
sap.collaboration.components.socialprofile.Component.exit()
Cleans up the component instance before destruction. [borrowed from sap.ui.core.Component]
sap.collaboration.components.socialprofile.Component.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.collaboration.components.socialprofile.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.socialprofile.Component.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.collaboration.components.socialprofile.Component.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
sap.collaboration.components.socialprofile.Component.init()
Initializes the Component instance after creation. [borrowed from sap.ui.core.UIComponent]
sap.collaboration.components.socialprofile.Component.onAfterRendering()
Function is called when the rendering of the Component Container is completed. [borrowed from sap.ui.core.UIComponent]
sap.collaboration.components.socialprofile.Component.onBeforeRendering()
Function is called when the rendering of the Component Container is started. [borrowed from sap.ui.core.UIComponent]
sap.collaboration.components.socialprofile.Component.open()
Opens the social profile component
sap.collaboration.components.socialprofile.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
getHeight(): sap.ui.core.CSSSize
Getter for property height. Gets the height of the Social Profile

Default value is 380px

Returns:
{sap.ui.core.CSSSize} the value of property height
getMemberId(): string
Getter for property memberId. Gets the SAP Jam member id of the user
Returns:
{string} the value of property memberId
getMemberInfo(): object
Getter for property memberInfo. Gets the SAP Jam member information
Returns:
{object} member information memberInfo
getOpeningControl(): object
Getter for property openingControl. Gets the opening control for the Social Profile
Returns:
{object} the value of property openingControl
getPlacement(): sap.m.PlacementType
Getter for property placement. Gets the placement of the Social Profile

Default value is sap.m.PlacementType.Auto

Returns:
{sap.m.PlacementType} the value of property placement
getWidth(): sap.ui.core.CSSSize
Getter for property width. Gets the width of the Social Profile

Default value is 300px

Returns:
{sap.ui.core.CSSSize} the value of property width
Setter for property height. Sets the height of the Social Profile

Default value is 380px

Parameters:
{string}sHeight new value for property height
Returns:
{sap.collaboration.components.socialprofile.Component}this to allow method chaining
Setter for property memberId. Sets the memberId of the user
Parameters:
{string}sMemberId new value for property memberId
Returns:
{sap.collaboration.components.socialprofile.Component}this to allow method chaining
Setter for property memberInfo. Sets the memberInformation of the user
Parameters:
{object}oMemberInfo new value for property memberInfo
Returns:
{sap.collaboration.components.socialprofile.Component}this to allow method chaining
setOpeningControl(oOpeningControl): sap.collaboration.components.socialprofile.Component
Setter for property openingControl. Sets the opening control for the Social Profile
Parameters:
{object}oOpeningControl new value for property openingControl
Returns:
{sap.collaboration.components.socialprofile.Component}this to allow method chaining
Setter for property placement. Sets the placement of the Social Profile

Default value is sap.m.PlacementType.Auto

Parameters:
{sap.m.PlacementType}sPlacement new value for property placement
Returns:
{sap.collaboration.components.socialprofile.Component}this to allow method chaining
Setter for property width. Sets the width of the Social Profile

Default value is 300px

Parameters:
{string}sWidth new value for property width
Returns:
{sap.collaboration.components.socialprofile.Component}this to allow method chaining