senselogic.sitevision.api.script.app

Interface RestAppInvokerFactory<O>

Type Parameters:

O - script object

@Requireable(value="RestAppInvokerFactory")
public interface RestAppInvokerFactory<O>

Creates RestAppInvoker instances.

Some code examples

Below is an example of how to get a RestAppInvoker instance using the path (of the headless custom module).

   var restAppInvokerFactory = require('RestAppInvokerFactory'),
       restAppInvoker = restAppInvokerFactory.fromPath('/rest-api/my-rest-app');

    if (restAppInvoker) {
       // Use the RESTApp invoker...
    }

Below is an example of how to get a RestAppInvoker instance using a Node. Note that the Node must be of type sv:restApp, sv:headlessCustomModule or sv:marketplaceHeadlessCustomModule.

   var restAppInvokerFactory = require('RestAppInvokerFactory'),
       restAppInvoker = restAppInvokerFactory.fromNode(aNode);

    if (restAppInvoker) {
       // Use the RESTApp invoker...
    }

Below is an example of how to get a RestAppInvoker instance using a Node identifier. Note that the identifier must be for a Node of type sv:restApp, sv:headlessCustomModule or sv:marketplaceHeadlessCustomModule (i.e. an identifier prefixed "361.", "188." or "211.").

   var restAppInvokerFactory = require('RestAppInvokerFactory'),
       restAppInvoker = restAppInvokerFactory.fromIdentifier(aIdentifier);

    if (restAppInvoker) {
       // Use the RESTApp invoker...
    }

See RestAppInvoker for more code examples.

Since:

Sitevision 7

Author:

Magnus Lövgren

See Also:

RestAppInvoker

Method Summary

Modifier and Type	Method and Description
RestAppInvoker<O>	fromIdentifier(String aIdentifier) Creates a RestAppInvoker via the Identifier of a RESTApp or a Headless custom module.
RestAppInvoker<O>	fromNode(Node aNode) Creates a RestAppInvoker via a RESTApp Node or a Headless custom module Node.
RestAppInvoker<O>	fromPath(String aPath) Creates a RestAppInvoker via the Path of a Headless custom module.

Method Detail

fromPath

RestAppInvoker<O> fromPath(String aPath)

Creates a RestAppInvoker via the Path of a Headless custom module.

Parameters:

aPath - the path of the Headless custom module (sv:headlessCustomModule or sv:marketplaceHeadlessCustomModule)

Returns:

the RestAppInvoker for the active RESTApp of the module, or null if no matching RESTApp could be found

fromNode

RestAppInvoker<O> fromNode(Node aNode)

Creates a RestAppInvoker via a RESTApp Node or a Headless custom module Node.

Parameters:

aNode - the RESTApp (sv:restApp) or the Headless custom module (sv:headlessCustomModule or sv:marketplaceHeadlessCustomModule)

Returns:

the RestAppInvoker for the RESTApp, or null if no matching RESTApp could be found

fromIdentifier

RestAppInvoker<O> fromIdentifier(String aIdentifier)

Creates a RestAppInvoker via the Identifier of a RESTApp or a Headless custom module.

Parameters:

aIdentifier - the identifier of the RESTApp (sv:restApp) or the Headless custom module (sv:headlessCustomModule or sv:marketplaceHeadlessCustomModule), i.e. an identifier prefixed with "361.", "188." or "211.".

Returns:

the RestAppInvoker for the resolved RESTApp, or null if no matching RESTApp could be found