-
Notifications
You must be signed in to change notification settings - Fork 254
/
ApiHubFileTriggerAttribute.xml
105 lines (105 loc) · 6.38 KB
/
ApiHubFileTriggerAttribute.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
103
104
105
<Type Name="ApiHubFileTriggerAttribute" FullName="Microsoft.Azure.WebJobs.ApiHubFileTriggerAttribute">
<TypeSignature Language="C#" Value="public sealed class ApiHubFileTriggerAttribute : Microsoft.Azure.WebJobs.ApiHubFileAttribute" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit ApiHubFileTriggerAttribute extends Microsoft.Azure.WebJobs.ApiHubFileAttribute" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.WebJobs.ApiHubFileTriggerAttribute" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class ApiHubFileTriggerAttribute
Inherits ApiHubFileAttribute" />
<TypeSignature Language="F#" Value="type ApiHubFileTriggerAttribute = class
 inherit ApiHubFileAttribute" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.WebJobs.Extensions.ApiHub</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>Microsoft.Azure.WebJobs.ApiHubFileAttribute</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 that points to the file on SAAS file trigger
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ApiHubFileTriggerAttribute (string connectionStringSetting, string path, Microsoft.Azure.ApiHub.FileWatcherType fileWatcherType = Microsoft.Azure.ApiHub.FileWatcherType.Created, int pollIntervalInSeconds = 0);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string connectionStringSetting, string path, valuetype Microsoft.Azure.ApiHub.FileWatcherType fileWatcherType, int32 pollIntervalInSeconds) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.WebJobs.ApiHubFileTriggerAttribute.#ctor(System.String,System.String,Microsoft.Azure.ApiHub.FileWatcherType,System.Int32)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (connectionStringSetting As String, path As String, Optional fileWatcherType As FileWatcherType = Microsoft.Azure.ApiHub.FileWatcherType.Created, Optional pollIntervalInSeconds As Integer = 0)" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.WebJobs.ApiHubFileTriggerAttribute : string * string * Microsoft.Azure.ApiHub.FileWatcherType * int -> Microsoft.Azure.WebJobs.ApiHubFileTriggerAttribute" Usage="new Microsoft.Azure.WebJobs.ApiHubFileTriggerAttribute (connectionStringSetting, path, fileWatcherType, pollIntervalInSeconds)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.WebJobs.Extensions.ApiHub</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="connectionStringSetting" Type="System.String" />
<Parameter Name="path" Type="System.String" />
<Parameter Name="fileWatcherType" Type="Microsoft.Azure.ApiHub.FileWatcherType" />
<Parameter Name="pollIntervalInSeconds" Type="System.Int32" />
</Parameters>
<Docs>
<param name="connectionStringSetting">App settings key name that have the connections string</param>
<param name="path">Relative path to the file <example>/folder/subfolder/file.txt</example></param>
<param name="fileWatcherType">Type of the file watcher.</param>
<param name="pollIntervalInSeconds">The poll interval in seconds.</param>
<summary>
Attribute used to bind a parameter to a SAAS file
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="FileWatcherType">
<MemberSignature Language="C#" Value="public Microsoft.Azure.ApiHub.FileWatcherType FileWatcherType { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype Microsoft.Azure.ApiHub.FileWatcherType FileWatcherType" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.WebJobs.ApiHubFileTriggerAttribute.FileWatcherType" />
<MemberSignature Language="VB.NET" Value="Public Property FileWatcherType As FileWatcherType" />
<MemberSignature Language="F#" Value="member this.FileWatcherType : Microsoft.Azure.ApiHub.FileWatcherType with get, set" Usage="Microsoft.Azure.WebJobs.ApiHubFileTriggerAttribute.FileWatcherType" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.WebJobs.Extensions.ApiHub</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.ApiHub.FileWatcherType</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the type of the file watcher. Default is 'Created'.
</summary>
<value>
The type of the file watcher.
</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="PollIntervalInSeconds">
<MemberSignature Language="C#" Value="public int PollIntervalInSeconds { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 PollIntervalInSeconds" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.WebJobs.ApiHubFileTriggerAttribute.PollIntervalInSeconds" />
<MemberSignature Language="VB.NET" Value="Public Property PollIntervalInSeconds As Integer" />
<MemberSignature Language="F#" Value="member this.PollIntervalInSeconds : int with get, set" Usage="Microsoft.Azure.WebJobs.ApiHubFileTriggerAttribute.PollIntervalInSeconds" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.WebJobs.Extensions.ApiHub</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the poll interval in seconds.
</summary>
<value>
The poll interval in seconds.
</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>