Add NSUrlSessionHandler docs #2783
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
rpetrusha
suggested changes
Jul 23, 2019
There was a problem hiding this comment.
This looks good, @migueldeicaza. I've left a few suggested changes, including two to fix broken reference links.
| @@ -14,8 +14,14 @@ | |||
| </Base> | |||
| <Interfaces /> | |||
| <Docs> | |||
| <summary>To be added.</summary> | |||
| <remarks>To be added.</remarks> | |||
| <summary>The default message handler used by <see cref="T:System.Net.Http.Http.HttpClient" /> on Apple platforms using the Xamarin stack (iOS, macOS, watchOS, tvOS)</summary> | |||
There was a problem hiding this comment.
Suggested change
| <summary>The default message handler used by <see cref="T:System.Net.Http.Http.HttpClient" /> on Apple platforms using the Xamarin stack (iOS, macOS, watchOS, tvOS)</summary> | |
| <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> |
| <remarks> | ||
| <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> | ||
| <para /> | ||
| <para>Using the Apple NSUrlSession has some advantages over using any socket-based implementation, the chief one being that on 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> |
There was a problem hiding this comment.
Suggested change
| <para>Using the Apple NSUrlSession has some advantages over using any socket-based implementation, the chief one being that on 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> | |
| <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> |
| <para /> | ||
| <para>Using the Apple NSUrlSession has some advantages over using any socket-based implementation, the chief one being that on 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> | ||
| <para /> | ||
| <para>Additionally, you can configure the handler to continue your downloads even if your application is suspended or has stopped runing.</para> |
There was a problem hiding this comment.
Suggested change
| <para>Additionally, you can configure the handler to continue your downloads even if your application is suspended or has stopped runing.</para> | |
| <para>Additionally, you can configure the handler to continue your downloads even if your application is suspended or has stopped running.</para> |
| @@ -51,7 +57,7 @@ | |||
| <ReturnType>System.Boolean</ReturnType> | |||
| </ReturnValue> | |||
| <Docs> | |||
| <summary>To be added.</summary> | |||
| <summary>Allows automatic redirection, this defaults to true.</summary> | |||
| <value>To be added.</value> | |||
There was a problem hiding this comment.
Suggested change
| <value>To be added.</value> | |
| <value><see langword="true" /> to allow automatic redirection; otherwise, <see langword="false" />.</value> |
| @@ -51,7 +57,7 @@ | |||
| <ReturnType>System.Boolean</ReturnType> | |||
| </ReturnValue> | |||
| <Docs> | |||
| <summary>To be added.</summary> | |||
| <summary>Allows automatic redirection, this defaults to true.</summary> | |||
There was a problem hiding this comment.
Suggested change
| <summary>Allows automatic redirection, this defaults to true.</summary> | |
| <summary>Gets or sets a valud that allows automatic redirection. Its default value is <see langword="true" />.</summary> |
There was a problem hiding this comment.
typo within the suggestion: valud -> value
| <param name="cancellationToken">The cancellation token to cancel the operation.</param> | ||
| <summary>Sends an HTTP request as an asynchronous operation.</summary> | ||
| <returns>The task object representing the asynchronous operation.</returns> | ||
| <remarks>This operation is does not block. It returns an instance of <see cref="T:System.Threading.Tasks.Task" /> to represent the asynchronous operation. When the operation completes, <see cref="P:System.Threading.Tasks.Task.Result" />contains the response message.</remarks> |
There was a problem hiding this comment.
Suggested change
| <remarks>This operation is does not block. It returns an instance of <see cref="T:System.Threading.Tasks.Task" /> to represent the asynchronous operation. When the operation completes, <see cref="P:System.Threading.Tasks.Task.Result" />contains the response message.</remarks> | |
| <remarks>This operation is does not block. It returns an instance of <see cref="T:System.Threading.Tasks.Task" /> to represent the asynchronous operation. When the operation completes, <see cref="P:System.Threading.Tasks.Task`1.Result" /> contains the response message.</remarks> |
|
@migueldeicaza friendly ping. You should be able to batch all the suggestions into a single commit via the Files changed tab (https://github.com/dotnet/dotnet-api-docs/pull/2783/files). |
rpetrusha
approved these changes
Aug 12, 2019
|
I've made the suggested changes, @migueldeicaza. I'll merge your PR when the build completes successfully. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
NSUrlSessionHandler documentation