Function FunctionsApiFactory

Returns {
    adminCreateFunction(groupId, appId, newFunction, options?) => AxiosPromise<AdminCreateFunction201Response>;
    adminDeleteFunction(groupId, appId, functionId, options?) => AxiosPromise<void>;
    adminExecuteFunction(userId, runAsSystem, groupId, appId, adminExecuteFunctionRequest, options?) => AxiosPromise<AdminExecuteFunction200Response>;
    adminExecuteFunctionSource(userId, runAsSystem, groupId, appId, adminExecuteFunctionSourceRequest, options?) => AxiosPromise<AdminExecuteFunction200Response>;
    adminGetFunction(groupId, appId, functionId, options?) => AxiosPromise<Function>;
    adminListFunctions(groupId, appId, options?) => AxiosPromise<any>;
    adminUpdateFunction(groupId, appId, functionId, options?) => AxiosPromise<NewFunction>;
}

• adminCreateFunction:function

  • adminCreateFunction(groupId, appId, newFunction, options?): AxiosPromise<AdminCreateFunction201Response>

  • Create a new Function.

    Parameters

    • 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.

    • newFunction: NewFunction

      The function to create

    • Optional options: any

      Override http request option.

    Returns AxiosPromise<AdminCreateFunction201Response>

    Summary

    Create a new Function

    Throws

• adminDeleteFunction:function

  • adminDeleteFunction(groupId, appId, functionId, options?): AxiosPromise<void>

  • Delete a Function.

    Parameters

    • 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.

    • functionId: any

      The unique `_id` value of a function.

    • Optional options: any

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Delete a Function

    Throws

• adminExecuteFunction:function

  • adminExecuteFunction(userId, runAsSystem, groupId, appId, adminExecuteFunctionRequest, options?): AxiosPromise<AdminExecuteFunction200Response>

  • 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: any

      Override http request option.

    Returns AxiosPromise<AdminExecuteFunction200Response>

    Summary

    Execute a function

    Throws

• adminExecuteFunctionSource:function

  • adminExecuteFunctionSource(userId, runAsSystem, groupId, appId, adminExecuteFunctionSourceRequest, options?): AxiosPromise<AdminExecuteFunction200Response>

  • 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: any

      Override http request option.

    Returns AxiosPromise<AdminExecuteFunction200Response>

    Summary

    Execute a function's source code for testing

    Throws

• adminGetFunction:function

  • adminGetFunction(groupId, appId, functionId, options?): AxiosPromise<Function>

  • Retrieve a Function.

    Parameters

    • 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.

    • functionId: any

      The unique `_id` value of a function.

    • Optional options: any

      Override http request option.

    Returns AxiosPromise<Function>

    Summary

    Retrieve a Function

    Throws

• adminListFunctions:function

  • adminListFunctions(groupId, appId, options?): AxiosPromise<any>

  • List Functions.

    Parameters

    • 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.

    • Optional options: any

      Override http request option.

    Returns AxiosPromise<any>

    Summary

    List Functions

    Throws

• adminUpdateFunction:function

  • adminUpdateFunction(groupId, appId, functionId, options?): AxiosPromise<NewFunction>

  • Update a Function.

    Parameters

    • 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.

    • functionId: any

      The unique `_id` value of a function.

    • Optional options: any

      Override http request option.

    Returns AxiosPromise<NewFunction>

    Summary

    Update a Function

    Throws