mirror of
https://github.com/aphrody-labs/PowerShell.git
synced 2026-10-17 12:45:47 +00:00
Add documentation for WebResponseObject and BasicHtmlWebResponseObject properties (#11876)
This commit is contained in:
1 parent
cce214e884
commit
68442a33e5
2 files changed
+21
-12
No files matched your search
+12
-6
@@ -57,22 +57,28 @@ namespace Microsoft.PowerShell.Commands
|
||||
#region Properties
|
||||
|
||||
/// <summary>
|
||||
/// Gets the Content property.
|
||||
/// Gets the text body content of this response.
|
||||
/// </summary>
|
||||
/// <value>
|
||||
/// Content of the response body, decoded using <see cref="Encoding"/>,
|
||||
/// if the <c>Content-Type</c> response header is a recognized text
|
||||
/// type. Otherwise <c>null</c>.
|
||||
/// </value>
|
||||
public new string Content { get; private set; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets the Encoding that was used to decode the Content.
|
||||
/// Gets the encoding of the text body content of this response.
|
||||
/// </summary>
|
||||
/// <value>
|
||||
/// The Encoding used to decode the Content; otherwise, a null reference if the content is not text.
|
||||
/// Encoding of the response body from the <c>Content-Type</c> header,
|
||||
/// or <c>null</c> if the encoding could not be determined.
|
||||
/// </value>
|
||||
public Encoding Encoding { get; private set; }
|
||||
|
||||
private WebCmdletElementCollection _inputFields;
|
||||
|
||||
/// <summary>
|
||||
/// Gets the Fields property.
|
||||
/// Gets the HTML input field elements parsed from <see cref="Content"/>.
|
||||
/// </summary>
|
||||
public WebCmdletElementCollection InputFields
|
||||
{
|
||||
@@ -99,7 +105,7 @@ namespace Microsoft.PowerShell.Commands
|
||||
private WebCmdletElementCollection _links;
|
||||
|
||||
/// <summary>
|
||||
/// Gets the Links property.
|
||||
/// Gets the HTML a link elements parsed from <see cref="Content"/>.
|
||||
/// </summary>
|
||||
public WebCmdletElementCollection Links
|
||||
{
|
||||
@@ -126,7 +132,7 @@ namespace Microsoft.PowerShell.Commands
|
||||
private WebCmdletElementCollection _images;
|
||||
|
||||
/// <summary>
|
||||
/// Gets the Images property.
|
||||
/// Gets the HTML img elements parsed from <see cref="Content"/>.
|
||||
/// </summary>
|
||||
public WebCmdletElementCollection Images
|
||||
{
|
||||
|
||||
+9
-6
@@ -18,13 +18,13 @@ namespace Microsoft.PowerShell.Commands
|
||||
#region Properties
|
||||
|
||||
/// <summary>
|
||||
/// Gets or protected sets the Content property.
|
||||
/// Gets or protected sets the response body content.
|
||||
/// </summary>
|
||||
[SuppressMessage("Microsoft.Performance", "CA1819:PropertiesShouldNotReturnArrays")]
|
||||
public byte[] Content { get; protected set; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets the StatusCode property.
|
||||
/// Gets the response status code.
|
||||
/// </summary>
|
||||
public int StatusCode
|
||||
{
|
||||
@@ -32,7 +32,7 @@ namespace Microsoft.PowerShell.Commands
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets the StatusDescription property.
|
||||
/// Gets the response status description.
|
||||
/// </summary>
|
||||
public string StatusDescription
|
||||
{
|
||||
@@ -41,7 +41,7 @@ namespace Microsoft.PowerShell.Commands
|
||||
|
||||
private MemoryStream _rawContentStream;
|
||||
/// <summary>
|
||||
/// Gets the RawContentStream property.
|
||||
/// Gets the response body content as a <see cref="MemoryStream"/>.
|
||||
/// </summary>
|
||||
public MemoryStream RawContentStream
|
||||
{
|
||||
@@ -49,7 +49,7 @@ namespace Microsoft.PowerShell.Commands
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets the RawContentLength property.
|
||||
/// Gets the length (in bytes) of <see cref="RawContentStream"/>.
|
||||
/// </summary>
|
||||
public long RawContentLength
|
||||
{
|
||||
@@ -57,8 +57,11 @@ namespace Microsoft.PowerShell.Commands
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets or protected sets the RawContent property.
|
||||
/// Gets or protected sets the full response content.
|
||||
/// </summary>
|
||||
/// <value>
|
||||
/// Full response content, including the HTTP status line, headers, and body.
|
||||
/// </value>
|
||||
public string RawContent { get; protected set; }
|
||||
|
||||
#endregion Properties
|
||||
|
||||
Reference in new issue
Block a user