Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 9abc42c

Browse files
migueldeicazaRon Petrusha
authored andcommitted
Add NSUrlSessionHandler docs (dotnet#2783)
* Add NSUrlSessionHandler docs * Update NSUrlSessionHandler.xml
1 parent 3280a3c commit 9abc42c

File tree

1 file changed

+20
-14
lines changed

1 file changed

+20
-14
lines changed

xml/System.Net.Http/NSUrlSessionHandler.xml

Lines changed: 20 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<Type Name="NSUrlSessionHandler" FullName="System.Net.Http.NSUrlSessionHandler">
1+
<Type Name="NSUrlSessionHandler" FullName="System.Net.Http.NSUrlSessionHandler">
22
<TypeSignature Language="C#" Value="public class NSUrlSessionHandler : System.Net.Http.HttpMessageHandler" />
33
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit NSUrlSessionHandler extends System.Net.Http.HttpMessageHandler" />
44
<TypeSignature Language="DocId" Value="T:System.Net.Http.NSUrlSessionHandler" />
@@ -14,8 +14,14 @@
1414
</Base>
1515
<Interfaces />
1616
<Docs>
17-
<summary>To be added.</summary>
18-
<remarks>To be added.</remarks>
17+
<summary>The default message handler used by <see cref="T:System.Net.Http.HttpClient" /> on Apple platforms using the Xamarin stack (iOS, macOS, watchOS, tvOS)</summary>
18+
<remarks>
19+
<para>The NSUrlSessionHandler is an HTTP client handler that delegates its work to Apple’s built-in <see cref="T:Foundation.NSUrlSession" />.   This is the default when you compile your application, but you can opt-out of it manually in your application by selecting a different handler.  </para>
20+
<para />
21+
<para>Using the Apple NSUrlSession has some advantages over using any socket-based implementation, the chief one being that on a mobile device, it will automatically turn on the radio on your behalf and you will avoid a potential timeout or an error if the radio is down.</para>
22+
<para />
23+
<para>Additionally, you can configure the handler to continue your downloads even if your application is suspended or has stopped running.</para>
24+
</remarks>
1925
</Docs>
2026
<Members>
2127
<Member MemberName=".ctor">
@@ -31,7 +37,7 @@
3137
</AssemblyInfo>
3238
<Parameters />
3339
<Docs>
34-
<summary>To be added.</summary>
40+
<summary>The default constructor for NSUrlSessionHandler configures the handler with a <see cref="T:Foundation.NSUrlSessionConfiguration" /> set to the default value, and customizes the resources time out to be 24 hours (as infinite timeouts are not supported by Apple’s own transport).</summary>
3541
<remarks>To be added.</remarks>
3642
</Docs>
3743
</Member>
@@ -51,8 +57,8 @@
5157
<ReturnType>System.Boolean</ReturnType>
5258
</ReturnValue>
5359
<Docs>
54-
<summary>To be added.</summary>
55-
<value>To be added.</value>
60+
<summary>Gets or sets a value that allows automatic redirection. Its default value is <see langword="true" />.</summary>
61+
<value><see langword="true" /> to allow automatic redirection; otherwise, <see langword="false" />.</value>
5662
<remarks>To be added.</remarks>
5763
</Docs>
5864
</Member>
@@ -72,8 +78,8 @@
7278
<ReturnType>System.Net.ICredentials</ReturnType>
7379
</ReturnValue>
7480
<Docs>
75-
<summary>To be added.</summary>
76-
<value>To be added.</value>
81+
<summary>Gets or sets authentication information used by this handler.</summary>
82+
<value>The authentication credentials associated with the handler. The default is <see langword="null" />.</value>
7783
<remarks>To be added.</remarks>
7884
</Docs>
7985
</Member>
@@ -146,12 +152,12 @@
146152
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
147153
</Parameters>
148154
<Docs>
149-
<param name="request">To be added.</param>
150-
<param name="cancellationToken">To be added.</param>
151-
<summary>To be added.</summary>
152-
<returns>To be added.</returns>
153-
<remarks>To be added.</remarks>
155+
<param name="request">The HTTP request message to send.</param>
156+
<param name="cancellationToken">The cancellation token to cancel the operation.</param>
157+
<summary>Sends an HTTP request as an asynchronous operation.</summary>
158+
<returns>The task object representing the asynchronous operation.</returns>
159+
<remarks>This operation is does not block. It returns an instance of <see cref="T:System.Threading.Tasks.Task`1" /> to represent the asynchronous operation. When the operation completes, <see cref="P:System.Threading.Tasks.Task`1.Result" /> contains the response message.</remarks>
154160
</Docs>
155161
</Member>
156162
</Members>
157-
</Type>
163+
</Type>

0 commit comments

Comments
 (0)