-
Notifications
You must be signed in to change notification settings - Fork 112
/
IProblemDetailsService.xml
99 lines (99 loc) · 7.24 KB
/
IProblemDetailsService.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
<Type Name="IProblemDetailsService" FullName="Microsoft.AspNetCore.Http.IProblemDetailsService">
<TypeSignature Language="C#" Value="public interface IProblemDetailsService" />
<TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract IProblemDetailsService" FrameworkAlternate="aspnetcore-7.0" />
<TypeSignature Language="DocId" Value="T:Microsoft.AspNetCore.Http.IProblemDetailsService" />
<TypeSignature Language="VB.NET" Value="Public Interface IProblemDetailsService" />
<TypeSignature Language="F#" Value="type IProblemDetailsService = interface" />
<TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract beforefieldinit IProblemDetailsService" FrameworkAlternate="aspnetcore-8.0;aspnetcore-9.0" />
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.Http.Abstractions</AssemblyName>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Interfaces />
<Docs>
<summary>
Defines a type that provide functionality to
create a <see cref="T:Microsoft.AspNetCore.Mvc.ProblemDetails" /> response.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="TryWriteAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.ValueTask<bool> TryWriteAsync (Microsoft.AspNetCore.Http.ProblemDetailsContext context);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance valuetype System.Threading.Tasks.ValueTask`1<bool> TryWriteAsync(class Microsoft.AspNetCore.Http.ProblemDetailsContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.AspNetCore.Http.IProblemDetailsService.TryWriteAsync(Microsoft.AspNetCore.Http.ProblemDetailsContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function TryWriteAsync (context As ProblemDetailsContext) As ValueTask(Of Boolean)" />
<MemberSignature Language="F#" Value="abstract member TryWriteAsync : Microsoft.AspNetCore.Http.ProblemDetailsContext -> System.Threading.Tasks.ValueTask<bool>
override this.TryWriteAsync : Microsoft.AspNetCore.Http.ProblemDetailsContext -> System.Threading.Tasks.ValueTask<bool>" Usage="iProblemDetailsService.TryWriteAsync context" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.Http.Abstractions</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.ValueTask<System.Boolean></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="context" Type="Microsoft.AspNetCore.Http.ProblemDetailsContext" Index="0" FrameworkAlternate="aspnetcore-8.0;aspnetcore-9.0">
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(1)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.Nullable(1)>]</AttributeName>
</Attribute>
</Attributes>
</Parameter>
</Parameters>
<Docs>
<param name="context">The <see cref="T:Microsoft.AspNetCore.Http.ProblemDetailsContext" /> associated with the current request/response.</param>
<summary>
Try to write a <see cref="T:Microsoft.AspNetCore.Mvc.ProblemDetails" /> response to the current context,
using the registered <see cref="T:Microsoft.AspNetCore.Http.IProblemDetailsWriter" /> services.
</summary>
<returns>To be added.</returns>
<remarks>The <see cref="T:Microsoft.AspNetCore.Http.IProblemDetailsWriter" /> registered services
are processed in sequence and the processing is completed when:
<list type="bullet"><item><description>One of them reports that the response was written successfully, or.</description></item><item><description>All <see cref="T:Microsoft.AspNetCore.Http.IProblemDetailsWriter" /> were executed and none of them was able to write the response successfully.</description></item></list></remarks>
</Docs>
</Member>
<Member MemberName="WriteAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.ValueTask WriteAsync (Microsoft.AspNetCore.Http.ProblemDetailsContext context);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance valuetype System.Threading.Tasks.ValueTask WriteAsync(class Microsoft.AspNetCore.Http.ProblemDetailsContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.AspNetCore.Http.IProblemDetailsService.WriteAsync(Microsoft.AspNetCore.Http.ProblemDetailsContext)" />
<MemberSignature Language="VB.NET" Value="Public Function WriteAsync (context As ProblemDetailsContext) As ValueTask" />
<MemberSignature Language="F#" Value="abstract member WriteAsync : Microsoft.AspNetCore.Http.ProblemDetailsContext -> System.Threading.Tasks.ValueTask" Usage="iProblemDetailsService.WriteAsync context" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.Http.Abstractions</AssemblyName>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="aspnetcore-8.0;aspnetcore-9.0">
<AttributeName Language="C#">[System.Runtime.CompilerServices.NullableContext(1)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.NullableContext(1)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Threading.Tasks.ValueTask</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="context" Type="Microsoft.AspNetCore.Http.ProblemDetailsContext" />
</Parameters>
<Docs>
<param name="context">The <see cref="T:Microsoft.AspNetCore.Http.ProblemDetailsContext" /> associated with the current request/response.</param>
<summary>
Write a <see cref="T:Microsoft.AspNetCore.Mvc.ProblemDetails" /> response to the current context,
using the registered <see cref="T:Microsoft.AspNetCore.Http.IProblemDetailsWriter" /> services.
</summary>
<returns>To be added.</returns>
<remarks>The <see cref="T:Microsoft.AspNetCore.Http.IProblemDetailsWriter" /> registered services
are processed in sequence and the processing is completed when:
<list type="bullet"><item><description>One of them reports that the response was written successfully, or.</description></item><item><description>All <see cref="T:Microsoft.AspNetCore.Http.IProblemDetailsWriter" /> were executed and none of them was able to write the response successfully.</description></item></list></remarks>
<exception cref="T:System.InvalidOperationException">If no <see cref="T:Microsoft.AspNetCore.Http.IProblemDetailsWriter" /> can write to the given context.</exception>
</Docs>
</Member>
</Members>
</Type>