-
Notifications
You must be signed in to change notification settings - Fork 1.5k
/
HostingEnvironmentExtensions.xml
162 lines (162 loc) · 12.1 KB
/
HostingEnvironmentExtensions.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
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
<Type Name="HostingEnvironmentExtensions" FullName="Microsoft.Extensions.Hosting.HostingEnvironmentExtensions">
<TypeSignature Language="C#" Value="public static class HostingEnvironmentExtensions" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract sealed beforefieldinit HostingEnvironmentExtensions extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Extensions.Hosting.HostingEnvironmentExtensions" />
<TypeSignature Language="VB.NET" Value="Public Module HostingEnvironmentExtensions" />
<TypeSignature Language="F#" Value="type HostingEnvironmentExtensions = class" />
<TypeSignature Language="C++ CLI" Value="public ref class HostingEnvironmentExtensions abstract sealed" />
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.Hosting.Abstractions</AssemblyName>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
<AssemblyVersion>2.2.0.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>3.1.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Attributes>
<Attribute FrameworkAlternate="net-8.0;net-9.0">
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(0)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.Nullable(0)>]</AttributeName>
</Attribute>
<Attribute FrameworkAlternate="net-8.0;net-9.0">
<AttributeName Language="C#">[System.Runtime.CompilerServices.NullableContext(1)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.NullableContext(1)>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>Extension methods for <see cref="T:Microsoft.Extensions.Hosting.IHostingEnvironment" />.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="IsDevelopment">
<MemberSignature Language="C#" Value="public static bool IsDevelopment (this Microsoft.Extensions.Hosting.IHostingEnvironment hostingEnvironment);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig bool IsDevelopment(class Microsoft.Extensions.Hosting.IHostingEnvironment hostingEnvironment) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Extensions.Hosting.HostingEnvironmentExtensions.IsDevelopment(Microsoft.Extensions.Hosting.IHostingEnvironment)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function IsDevelopment (hostingEnvironment As IHostingEnvironment) As Boolean" />
<MemberSignature Language="F#" Value="static member IsDevelopment : Microsoft.Extensions.Hosting.IHostingEnvironment -> bool" Usage="Microsoft.Extensions.Hosting.HostingEnvironmentExtensions.IsDevelopment hostingEnvironment" />
<MemberSignature Language="C++ CLI" Value="public:
[System::Runtime::CompilerServices::Extension]
 static bool IsDevelopment(Microsoft::Extensions::Hosting::IHostingEnvironment ^ hostingEnvironment);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.Hosting.Abstractions</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="hostingEnvironment" Type="Microsoft.Extensions.Hosting.IHostingEnvironment" RefType="this" />
</Parameters>
<Docs>
<param name="hostingEnvironment">An instance of <see cref="T:Microsoft.Extensions.Hosting.IHostingEnvironment" />.</param>
<summary>Checks if the current hosting environment name is <see cref="F:Microsoft.Extensions.Hosting.EnvironmentName.Development" />. This API should not be used in libraries, see remarks for details.</summary>
<returns>
<see langword="true" /> if the environment name is <see cref="F:Microsoft.Extensions.Hosting.EnvironmentName.Development" />; otherwise, <see langword="false" />.</returns>
<remarks>
The environment names "Development", "Production" and "Staging" are provided as a utility for application developers. Library
authors should avoid coupling specific behavior to these environment names.
</remarks>
</Docs>
</Member>
<Member MemberName="IsEnvironment">
<MemberSignature Language="C#" Value="public static bool IsEnvironment (this Microsoft.Extensions.Hosting.IHostingEnvironment hostingEnvironment, string environmentName);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig bool IsEnvironment(class Microsoft.Extensions.Hosting.IHostingEnvironment hostingEnvironment, string environmentName) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Extensions.Hosting.HostingEnvironmentExtensions.IsEnvironment(Microsoft.Extensions.Hosting.IHostingEnvironment,System.String)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function IsEnvironment (hostingEnvironment As IHostingEnvironment, environmentName As String) As Boolean" />
<MemberSignature Language="F#" Value="static member IsEnvironment : Microsoft.Extensions.Hosting.IHostingEnvironment * string -> bool" Usage="Microsoft.Extensions.Hosting.HostingEnvironmentExtensions.IsEnvironment (hostingEnvironment, environmentName)" />
<MemberSignature Language="C++ CLI" Value="public:
[System::Runtime::CompilerServices::Extension]
 static bool IsEnvironment(Microsoft::Extensions::Hosting::IHostingEnvironment ^ hostingEnvironment, System::String ^ environmentName);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.Hosting.Abstractions</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="hostingEnvironment" Type="Microsoft.Extensions.Hosting.IHostingEnvironment" RefType="this" />
<Parameter Name="environmentName" Type="System.String" />
</Parameters>
<Docs>
<param name="hostingEnvironment">An instance of <see cref="T:Microsoft.Extensions.Hosting.IHostingEnvironment" />.</param>
<param name="environmentName">Environment name to validate against.</param>
<summary>Compares the current hosting environment name against the specified value. Library authors should avoid using this API, see remarks for details.</summary>
<returns>
<see langword="true" /> if the specified name is the same as the current environment; otherwise, <see langword="false" />.</returns>
<remarks>
Environment names are generally specific to an application. Libraries designed for use in many different applications
should avoid coupling behavior to specific environment names.
</remarks>
</Docs>
</Member>
<Member MemberName="IsProduction">
<MemberSignature Language="C#" Value="public static bool IsProduction (this Microsoft.Extensions.Hosting.IHostingEnvironment hostingEnvironment);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig bool IsProduction(class Microsoft.Extensions.Hosting.IHostingEnvironment hostingEnvironment) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Extensions.Hosting.HostingEnvironmentExtensions.IsProduction(Microsoft.Extensions.Hosting.IHostingEnvironment)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function IsProduction (hostingEnvironment As IHostingEnvironment) As Boolean" />
<MemberSignature Language="F#" Value="static member IsProduction : Microsoft.Extensions.Hosting.IHostingEnvironment -> bool" Usage="Microsoft.Extensions.Hosting.HostingEnvironmentExtensions.IsProduction hostingEnvironment" />
<MemberSignature Language="C++ CLI" Value="public:
[System::Runtime::CompilerServices::Extension]
 static bool IsProduction(Microsoft::Extensions::Hosting::IHostingEnvironment ^ hostingEnvironment);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.Hosting.Abstractions</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="hostingEnvironment" Type="Microsoft.Extensions.Hosting.IHostingEnvironment" RefType="this" />
</Parameters>
<Docs>
<param name="hostingEnvironment">An instance of <see cref="T:Microsoft.Extensions.Hosting.IHostingEnvironment" />.</param>
<summary>Checks if the current hosting environment name is <see cref="F:Microsoft.Extensions.Hosting.EnvironmentName.Production" />. This API should not be used in libraries, see remarks for details.</summary>
<returns>
<see langword="true" /> if the environment name is <see cref="F:Microsoft.Extensions.Hosting.EnvironmentName.Production" />; otherwise, <see langword="false" />.</returns>
<remarks>
The environment names "Development", "Production" and "Staging" are provided as a utility for application developers. Library
authors should avoid coupling specific behavior to these environment names.
</remarks>
</Docs>
</Member>
<Member MemberName="IsStaging">
<MemberSignature Language="C#" Value="public static bool IsStaging (this Microsoft.Extensions.Hosting.IHostingEnvironment hostingEnvironment);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig bool IsStaging(class Microsoft.Extensions.Hosting.IHostingEnvironment hostingEnvironment) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Extensions.Hosting.HostingEnvironmentExtensions.IsStaging(Microsoft.Extensions.Hosting.IHostingEnvironment)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function IsStaging (hostingEnvironment As IHostingEnvironment) As Boolean" />
<MemberSignature Language="F#" Value="static member IsStaging : Microsoft.Extensions.Hosting.IHostingEnvironment -> bool" Usage="Microsoft.Extensions.Hosting.HostingEnvironmentExtensions.IsStaging hostingEnvironment" />
<MemberSignature Language="C++ CLI" Value="public:
[System::Runtime::CompilerServices::Extension]
 static bool IsStaging(Microsoft::Extensions::Hosting::IHostingEnvironment ^ hostingEnvironment);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.Hosting.Abstractions</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="hostingEnvironment" Type="Microsoft.Extensions.Hosting.IHostingEnvironment" RefType="this" />
</Parameters>
<Docs>
<param name="hostingEnvironment">An instance of <see cref="T:Microsoft.Extensions.Hosting.IHostingEnvironment" />.</param>
<summary>Checks if the current hosting environment name is <see cref="F:Microsoft.Extensions.Hosting.EnvironmentName.Staging" />. This API should not be used in libraries, see remarks for details.</summary>
<returns>
<see langword="true" /> if the environment name is <see cref="F:Microsoft.Extensions.Hosting.EnvironmentName.Staging" />; otherwise, <see langword="false" />.</returns>
<remarks>
The environment names "Development", "Production" and "Staging" are provided as a utility for application developers. Library
authors should avoid coupling specific behavior to these environment names.
</remarks>
</Docs>
</Member>
</Members>
</Type>