/
WebHookTriggerAttribute.xml
102 lines (102 loc) · 5.73 KB
/
WebHookTriggerAttribute.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
<Type Name="WebHookTriggerAttribute" FullName="Microsoft.Azure.WebJobs.WebHookTriggerAttribute">
<TypeSignature Language="C#" Value="public sealed class WebHookTriggerAttribute : Attribute" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit WebHookTriggerAttribute extends System.Attribute" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.WebJobs.WebHookTriggerAttribute" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class WebHookTriggerAttribute
Inherits Attribute" />
<TypeSignature Language="F#" Value="type WebHookTriggerAttribute = class
 inherit Attribute" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.WebJobs.Extensions.WebHooks</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Attribute</BaseTypeName>
</Base>
<Interfaces />
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.AttributeUsage(System.AttributeTargets.Parameter)]</AttributeName>
<AttributeName Language="F#">[<System.AttributeUsage(System.AttributeTargets.Parameter)>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>
Attribute used to declare that a job function should be triggered
by incoming HTTP messages.
</summary>
<remarks>
The method parameter type can be one of the following:
<list type="bullet"><item><description><see cref="T:System.Net.Http.HttpRequestMessage" /></description></item><item><description><see cref="T:Microsoft.Azure.WebJobs.WebHookContext" /></description></item><item><description><see cref="T:System.String" /></description></item><item><description><see cref="T:byte[]" /></description></item><item><description><see cref="T:System.IO.Stream" /></description></item><item><description><see cref="T:System.IO.TextReader" /></description></item><item><description><see cref="T:System.IO.StreamReader" /></description></item><item><description>A user-defined type (serialized as JSON)</description></item></list></remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public WebHookTriggerAttribute (string route = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string route) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.WebJobs.WebHookTriggerAttribute.#ctor(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (Optional route As String = Nothing)" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.WebJobs.WebHookTriggerAttribute : string -> Microsoft.Azure.WebJobs.WebHookTriggerAttribute" Usage="new Microsoft.Azure.WebJobs.WebHookTriggerAttribute route" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.WebJobs.Extensions.WebHooks</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="route" Type="System.String" />
</Parameters>
<Docs>
<param name="route">The optional route that the function should be triggered on.
When not explicitly set, the route will be defaulted by convention to
{ClassName}/{MethodName}.</param>
<summary>
Constructs a new instance.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="FromUri">
<MemberSignature Language="C#" Value="public bool FromUri { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool FromUri" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.WebJobs.WebHookTriggerAttribute.FromUri" />
<MemberSignature Language="VB.NET" Value="Public Property FromUri As Boolean" />
<MemberSignature Language="F#" Value="member this.FromUri : bool with get, set" Usage="Microsoft.Azure.WebJobs.WebHookTriggerAttribute.FromUri" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.WebJobs.Extensions.WebHooks</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets a value indicating whether values should come
from Uri parameters or the request body, when binding to a
user Type. By default, values come from the POST body.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Route">
<MemberSignature Language="C#" Value="public string Route { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Route" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.WebJobs.WebHookTriggerAttribute.Route" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Route As String" />
<MemberSignature Language="F#" Value="member this.Route : string" Usage="Microsoft.Azure.WebJobs.WebHookTriggerAttribute.Route" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.WebJobs.Extensions.WebHooks</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the WebHook route the function will be triggered on.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>