class sap.ui.rta.Client

Control sample: sap.ui.rta.Client
Visiblity: restricted
UX Guidelines:
Implements:
Available since: N/A
Module: sap/ui/rta/Client
Application Component: CA-UI5-FL-RTA

Overview

This client is used to access the sap.ui.RuntimeAuthoring instance that is running in a separate window.

Example:

sap.ui.require(['sap/ui/rta/Client'], function (RTAClient) {
    var oRTAClient = new RTAClient({
        window: ,
        origin: 
    });

    oRTAClient.getService('selection').then(function (oSelectionService) {
        oSelectionService.add('__button0').then(
            function (vResult) {
                // vResult contains response from add() function of sap.ui.rta.service.Selection
            },
            function (vError) {
                // Error that happens during the operation
            }
        );
    });
});


Constructor

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

new sap.ui.rta.Client()

Properties

Name Type Default Value Description
origin string

Receiving window origin; a valid origin has to be specified, see https://html.spec.whatwg.org/multipage/origin.html#origin

Visibility: public
window object

Receiving window object; has to be a different window than the window in which this client is used

Visibility: public

Methods Overview

Method Description
destroy

Destroys the client. After an object has been destroyed, it can no longer be used.

sap.ui.rta.Client.extend

Creates a new subclass of class sap.ui.rta.Client 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.base.ManagedObject.extend.

sap.ui.rta.Client.getMetadata

Returns a metadata object for class sap.ui.rta.Client.

getOrigin

Gets current value of property origin.

Receiving window origin; a valid origin has to be specified, see https://html.spec.whatwg.org/multipage/origin.html#origin

getWindow

Gets current value of property window.

Receiving window object; has to be a different window than the window in which this client is used

setOrigin

Sets a new value for property origin.

Receiving window origin; a valid origin has to be specified, see https://html.spec.whatwg.org/multipage/origin.html#origin

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

setWindow

Sets a new value for property window.

Receiving window object; has to be a different window than the window in which this client is used

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

destroy

Destroys the client. After an object has been destroyed, it can no longer be used.

sap.ui.rta.Client.extend

Creates a new subclass of class sap.ui.rta.Client 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.base.ManagedObject.extend.

Param Type DefaultValue Description
sClassName string

Name of the class being created

oClassInfo object

Object literal with information about the class

FNMetaImpl function

Constructor function for the metadata object; if not given, it defaults to the metadata implementation used by this class

sap.ui.rta.Client.getMetadata

Returns a metadata object for class sap.ui.rta.Client.

getOrigin

Gets current value of property origin.

Receiving window origin; a valid origin has to be specified, see https://html.spec.whatwg.org/multipage/origin.html#origin

getWindow

Gets current value of property window.

Receiving window object; has to be a different window than the window in which this client is used

setOrigin

Sets a new value for property origin.

Receiving window origin; a valid origin has to be specified, see https://html.spec.whatwg.org/multipage/origin.html#origin

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

Param Type DefaultValue Description
sOrigin string

New value for property origin

setWindow

Sets a new value for property window.

Receiving window object; has to be a different window than the window in which this client is used

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

Param Type DefaultValue Description
oWindow object

New value for property window