RequestOptions.PreTriggerInclude Property

Reference

Definition

Namespace:: Microsoft.Azure.Documents.Client

Assemblies:: Microsoft.Azure.DocumentDB.Core.dll, Microsoft.Azure.Documents.Client.dll

Packages:: Microsoft.Azure.DocumentDB v2.18.0, Microsoft.Azure.DocumentDB.Core v2.18.0

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Gets or sets the trigger to be invoked before the operation in the Azure Cosmos DB service.

public System.Collections.Generic.IList<string> PreTriggerInclude { get; set; }

member this.PreTriggerInclude : System.Collections.Generic.IList<string> with get, set

Public Property PreTriggerInclude As IList(Of String)

Property Value

IList<String>

The trigger to be invoked before the operation.

Examples

The following example shows how to use RequestOptions to include a PreTrigger to execute before persisting the document.

client.CreateDocumentAsync(collection.SelfLink,
    new { id = "AndersenFamily", isRegistered = true },
    new RequestOptions { PreTriggerInclude = new List<string> { "validateDocumentContents" } });

Remarks

Only valid when used with Create, Replace and Delete methods for documents. Currently only one PreTrigger is permitted per operation.

Applies to