EntityTriggerAttribute.xml

<Type Name="EntityTriggerAttribute" FullName="Microsoft.Azure.WebJobs.Extensions.DurableTask.EntityTriggerAttribute">
  <TypeSignature Language="C#" Value="public sealed class EntityTriggerAttribute : Attribute" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit EntityTriggerAttribute extends System.Attribute" />
  <TypeSignature Language="DocId" Value="T:Microsoft.Azure.WebJobs.Extensions.DurableTask.EntityTriggerAttribute" />
  <TypeSignature Language="VB.NET" Value="Public NotInheritable Class EntityTriggerAttribute&#xA;Inherits Attribute" />
  <TypeSignature Language="F#" Value="type EntityTriggerAttribute = class&#xA;    inherit Attribute" />
  <AssemblyInfo>
    <AssemblyName>Microsoft.Azure.WebJobs.Extensions.DurableTask</AssemblyName>
    <AssemblyVersion>2.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Attribute</BaseTypeName>
  </Base>
  <Interfaces />
  <Attributes>
    <Attribute>
      <AttributeName Language="C#">[Microsoft.Azure.WebJobs.Description.Binding(TriggerHandlesReturnValue=true)]</AttributeName>
      <AttributeName Language="F#">[&lt;Microsoft.Azure.WebJobs.Description.Binding(TriggerHandlesReturnValue=true)&gt;]</AttributeName>
    </Attribute>
    <Attribute>
      <AttributeName Language="C#">[System.AttributeUsage(System.AttributeTargets.Parameter)]</AttributeName>
      <AttributeName Language="F#">[&lt;System.AttributeUsage(System.AttributeTargets.Parameter)&gt;]</AttributeName>
    </Attribute>
    <Attribute>
      <AttributeName Language="C#">[System.Diagnostics.DebuggerDisplay("{EntityName} ({Version})")]</AttributeName>
      <AttributeName Language="F#">[&lt;System.Diagnostics.DebuggerDisplay("{EntityName} ({Version})")&gt;]</AttributeName>
    </Attribute>
  </Attributes>
  <Docs>
    <summary>
            Trigger attribute used for durable entity functions.
            </summary>
    <remarks>To be added.</remarks>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public EntityTriggerAttribute ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Azure.WebJobs.Extensions.DurableTask.EntityTriggerAttribute.#ctor" />
      <MemberSignature Language="VB.NET" Value="Public Sub New ()" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.WebJobs.Extensions.DurableTask</AssemblyName>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters />
      <Docs>
        <summary>To be added.</summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="EntityName">
      <MemberSignature Language="C#" Value="public string EntityName { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string EntityName" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Azure.WebJobs.Extensions.DurableTask.EntityTriggerAttribute.EntityName" />
      <MemberSignature Language="VB.NET" Value="Public Property EntityName As String" />
      <MemberSignature Language="F#" Value="member this.EntityName : string with get, set" Usage="Microsoft.Azure.WebJobs.Extensions.DurableTask.EntityTriggerAttribute.EntityName" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.WebJobs.Extensions.DurableTask</AssemblyName>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName Language="C#">[Microsoft.Azure.WebJobs.Description.AutoResolve]</AttributeName>
          <AttributeName Language="F#">[&lt;Microsoft.Azure.WebJobs.Description.AutoResolve&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets or sets the name of the entity.
            </summary>
        <value>
            The name of the entity or <c>null</c> to use the function name.
            </value>
        <remarks>
            If not specified, the function name is used as the name of the entity.
            </remarks>
      </Docs>
    </Member>
  </Members>
</Type>