Class FunctionsApi

Hierarchy

  • FunctionsApi

Constructors

constructor

Properties

api

Methods

archive archiveByFunctionType createOrReplace createOrReplaceByFunctionType getByFunctionType getById getPage

Constructors

constructor

Properties

Private api

api: ObservableFunctionsApi

Methods

archive

  • Delete a function for a custom workflow action. This will remove the function itself as well as removing the association between the function and the custom action. This can't be undone. Delete a custom action function

    Parameters

    • definitionId: string

      The ID of the custom workflow action

    • functionType: "PRE_ACTION_EXECUTION" | "PRE_FETCH_OPTIONS" | "POST_FETCH_OPTIONS"

      The type of function. This determines when the function will be called.

    • functionId: string

      The ID qualifier for the function. This is used to specify which input field a function is associated with for `PRE_FETCH_OPTIONS` and `POST_FETCH_OPTIONS` function types.

    • appId: number
    • Optional _options: Configuration

    Returns Promise<void>

archiveByFunctionType

  • Delete a function for a custom workflow action. This will remove the function itself as well as removing the association between the function and the custom action. This can't be undone. Delete a custom action function

    Parameters

    • definitionId: string

      The ID of the custom workflow action.

    • functionType: "PRE_ACTION_EXECUTION" | "PRE_FETCH_OPTIONS" | "POST_FETCH_OPTIONS"

      The type of function. This determines when the function will be called.

    • appId: number
    • Optional _options: Configuration

    Returns Promise<void>

createOrReplace

  • Creates or replaces a function for a custom workflow action. Create or replace a custom action function

    Parameters

    • definitionId: string

      The ID of the custom workflow action.

    • functionType: "PRE_ACTION_EXECUTION" | "PRE_FETCH_OPTIONS" | "POST_FETCH_OPTIONS"

      The type of function. This determines when the function will be called.

    • functionId: string

      The ID qualifier for the function. This is used to specify which input field a function is associated with for `PRE_FETCH_OPTIONS` and `POST_FETCH_OPTIONS` function types.

    • appId: number
    • body: string

      The function source code. Must be valid JavaScript code.

    • Optional _options: Configuration

    Returns Promise<ActionFunctionIdentifier>

createOrReplaceByFunctionType

  • Creates or replaces a function for a custom workflow action. Create or replace a custom action function

    Parameters

    • definitionId: string

      The ID of the custom workflow action.

    • functionType: "PRE_ACTION_EXECUTION" | "PRE_FETCH_OPTIONS" | "POST_FETCH_OPTIONS"

      The type of function. This determines when the function will be called.

    • appId: number
    • body: string

      The function source code. Must be valid JavaScript code.

    • Optional _options: Configuration

    Returns Promise<ActionFunctionIdentifier>

getByFunctionType

  • Returns the given function for a custom workflow action. Get a custom action function

    Parameters

    • definitionId: string

      The ID of the custom workflow action.

    • functionType: "PRE_ACTION_EXECUTION" | "PRE_FETCH_OPTIONS" | "POST_FETCH_OPTIONS"

      The type of function. This determines when the function will be called.

    • appId: number
    • Optional _options: Configuration

    Returns Promise<ActionFunction>

getById

  • Returns the given function for a custom workflow action. Get a custom action function

    Parameters

    • definitionId: string

      The ID of the custom workflow action.

    • functionType: "PRE_ACTION_EXECUTION" | "PRE_FETCH_OPTIONS" | "POST_FETCH_OPTIONS"

      The type of function. This determines when the function will be called.

    • functionId: string

      The ID qualifier for the function. This is used to specify which input field a function is associated with for `PRE_FETCH_OPTIONS` and `POST_FETCH_OPTIONS` function types.

    • appId: number
    • Optional _options: Configuration

    Returns Promise<ActionFunction>

getPage

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc