The interface for an object which handles predefined requests.

Hierarchy

  • PredefinedRequestHandler

Implemented by

Properties

invokePredefinedRequest: ((predefinedRequest, timeout?) => Promise<FetchResponse>)

Type declaration

    • (predefinedRequest, timeout?): Promise<FetchResponse>
    • Invokes a named Predefined Request in Egress Gateway that is defined inside connection.

      The predefinedRequest should be formatted as follows: { requestName {string}: the name of the Predefined Request to invoke connection {object} : { connectionName {string}: the name of the connection to use (see context.availableConnections for a list of connections). } params {object} (optional): key/value pairs that correspond will replace placeholders in the Predefined Request }

      Parameters

      • predefinedRequest: {
            connectionName: string;
            requestName: string;
        } & {
            parameters?: {};
        }

        Configures all aspects of the request

      • Optional timeout: number

        Defaults to 10000 (10 seconds). Specifies the number of milliseconds at which to reject the returned promise if no response has been received from the Plugin.

      Returns Promise<FetchResponse>

      • response from the API

Generated using TypeDoc