Function TriggersApiFp

Returns {
    adminCreateTrigger(groupId, appId, body, options?) => Promise<((axios?, basePath?) => AxiosPromise<any>)>;
    adminDeleteTrigger(groupId, appId, triggerId, options?) => Promise<((axios?, basePath?) => AxiosPromise<any>)>;
    adminGetTrigger(groupId, appId, triggerId, options?) => Promise<((axios?, basePath?) => AxiosPromise<any>)>;
    adminListTriggers(groupId, appId, options?) => Promise<((axios?, basePath?) => AxiosPromise<any>)>;
    adminResumeTrigger(groupId, appId, triggerId, adminResumeTriggerRequest?, options?) => Promise<((axios?, basePath?) => AxiosPromise<void>)>;
    adminUpdateTrigger(groupId, appId, triggerId, body, options?) => Promise<((axios?, basePath?) => AxiosPromise<void>)>;
}

• adminCreateTrigger:function

  • adminCreateTrigger(groupId, appId, body, options?): Promise<((axios?, basePath?) => AxiosPromise<any>)>

  • Create a new trigger in your application.

    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.

    • body: any

      A configuration for a database, scheduled, or authentication trigger.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<any>)>

    Summary

    Create a trigger

    Throws

• adminDeleteTrigger:function

  • adminDeleteTrigger(groupId, appId, triggerId, options?): Promise<((axios?, basePath?) => AxiosPromise<any>)>

  • Remove an existing trigger from your application.

    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.

    • triggerId: any

      The unique `_id` value of a trigger.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<any>)>

    Summary

    Delete a trigger

    Throws

• adminGetTrigger:function

  • adminGetTrigger(groupId, appId, triggerId, options?): Promise<((axios?, basePath?) => AxiosPromise<any>)>

  • Get the configuration for an existing trigger in your application.

    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.

    • triggerId: any

      The unique `_id` value of a trigger.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<any>)>

    Summary

    Get a trigger

    Throws

• adminListTriggers:function

  • adminListTriggers(groupId, appId, options?): Promise<((axios?, basePath?) => AxiosPromise<any>)>

  • Get a list of all triggers in your application.

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

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<any>)>

    Summary

    Get all triggers

    Throws

• adminResumeTrigger:function

  • adminResumeTrigger(groupId, appId, triggerId, adminResumeTriggerRequest?, options?): Promise<((axios?, basePath?) => AxiosPromise<void>)>

  • Resume a suspended database trigger.

    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.

    • triggerId: any

      The unique `_id` value of a trigger.

    • Optional adminResumeTriggerRequest: AdminResumeTriggerRequest

      Configuration options for the resume operation.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<void>)>

    Summary

    Resume a suspended trigger

    Throws

• adminUpdateTrigger:function

  • adminUpdateTrigger(groupId, appId, triggerId, body, options?): Promise<((axios?, basePath?) => AxiosPromise<void>)>

  • Modify an existing trigger in your application.

    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.

    • triggerId: any

      The unique `_id` value of a trigger.

    • body: any

      The updated trigger configuration.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<void>)>

    Summary

    Update a trigger

    Throws