Interface FunctionsApiInterface

FunctionsApi - interface

Export

FunctionsApi

Hierarchy

  • FunctionsApiInterface

Implemented by

Methods

  • Delete a Function.

    Parameters

    Returns AxiosPromise<void>

    Summary

    Delete a Function

    Throws

    Memberof

    FunctionsApiInterface

  • Execute a function for testing.

    Parameters

    • userId: any

      The user as which to execute the function. Either `user_id` or `run_as_system` is required. You cannot specify both.

    • runAsSystem: any

      Determine whether or not to run as system user. Either `run_as_system` or `user_id` is required. You cannot specify both.

    • groupId: any

      An Atlas Project/Group ID.

    • appId: any

      The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.

    • adminExecuteFunctionRequest: AdminExecuteFunctionRequest

      The function to execute.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<AdminExecuteFunction200Response>

    Summary

    Execute a function

    Throws

    Memberof

    FunctionsApiInterface

  • Execute a function's source code for testing.

    Parameters

    • userId: any

      The user as which to execute the function. Either `user_id` or `run_as_system` is required. You cannot specify both.

    • runAsSystem: any

      Determine whether or not to run as system user. Either `run_as_system` or `user_id` is required. You cannot specify both.

    • groupId: any

      An Atlas Project/Group ID.

    • appId: any

      The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.

    • adminExecuteFunctionSourceRequest: AdminExecuteFunctionSourceRequest

      The source to execute.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<AdminExecuteFunction200Response>

    Summary

    Execute a function's source code for testing

    Throws

    Memberof

    FunctionsApiInterface

Generated using TypeDoc