Trigger class
Operations to read, replace, or delete a Trigger.
Use container.triggers
to create, upsert, query, or read all.
Properties
container | |
id | |
url | Returns a reference URL to the resource. Used for linking in Permissions. |
Methods
delete(Request |
Delete the given Trigger. |
read(Request |
Read the TriggerDefinition for the given Trigger. |
replace(Trigger |
Replace the given Trigger with the specified TriggerDefinition. |
Property Details
container
id
id: string
Property Value
string
url
Returns a reference URL to the resource. Used for linking in Permissions.
string url
Property Value
string
Method Details
delete(RequestOptions)
Delete the given Trigger.
function delete(options?: RequestOptions): Promise<TriggerResponse>
Parameters
- options
- RequestOptions
Returns
Promise<TriggerResponse>
read(RequestOptions)
Read the TriggerDefinition for the given Trigger.
function read(options?: RequestOptions): Promise<TriggerResponse>
Parameters
- options
- RequestOptions
Returns
Promise<TriggerResponse>
replace(TriggerDefinition, RequestOptions)
Replace the given Trigger with the specified TriggerDefinition.
function replace(body: TriggerDefinition, options?: RequestOptions): Promise<TriggerResponse>
Parameters
- body
- TriggerDefinition
The specified TriggerDefinition to replace the existing definition with.
- options
- RequestOptions
Returns
Promise<TriggerResponse>