Class ContentComposer

Facilitates the creation and management of HTTP request content.

Inheritance

object

ContentComposer

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Coree.NETStandard.Classes.HttpRequestService

Assembly: Coree.NETStandard.dll

Syntax

public class ContentComposer

Constructors

ContentComposer()

Initializes a new instance of the ContentComposer with no initial content.

Declaration

public ContentComposer()

ContentComposer(byte[], string?)

Initializes a new instance of the ContentComposer and adds byte array content.

Declaration

public ContentComposer(byte[] bytes, string? name = null)

Parameters

Type	Name	Description
byte[]	bytes	The byte array to be added as content.
string	name	An optional name for the content part, useful in multipart form data scenarios.

Remarks

The content type for the byte array is set to 'application/octet-stream' by default.

ContentComposer(Dictionary<string, string>, string?)

Initializes a new instance of the ContentComposer with form URL encoded content from a dictionary.

Declaration

public ContentComposer(Dictionary<string, string> formData, string? name = null)

Parameters

Type	Name	Description
Dictionary<string, string>	formData	The form data as a dictionary of key-value pairs.
string	name	An optional name for the content part in multipart form data.

Remarks

This constructor is ideal for constructing content for HTTP POST requests using 'application/x-www-form-urlencoded'.

ContentComposer(Stream, string?, string?)

Initializes a new instance of the ContentComposer and adds stream content, suitable for large data uploads like files.

Declaration

public ContentComposer(Stream stream, string? name = null, string? filename = null)

Parameters

Type	Name	Description
Stream	stream	The stream representing the content to be uploaded.
string	name	An optional name for the content part, used in multipart form data.
string	filename	An optional filename for the content part, used when adding file-based content in multipart form data.

Remarks

Stream content is not read into memory all at once, making this method suitable for large file uploads.

ContentComposer(string, string, Encoding?, string?)

Initializes a new instance of the ContentComposer and adds plain string content with a specified media type.

Declaration

public ContentComposer(string data, string mediaType, Encoding? encoding = null, string? name = null)

Parameters

Type	Name	Description
string	data	The string data to add as content.
string	mediaType	The media type to use for the content (e.g., "text/plain", "application/json").
Encoding	encoding	The encoding of the string content, defaulting to UTF-8 if not specified.
string	name	An optional descriptor for the content part, useful in multipart scenarios.

Remarks

This method directly adds string content with the specified media type, useful for simple text-based content types.

ContentComposer(string, Encoding?, string?)

Initializes a new instance of the ContentComposer and adds string content automatically determining the media type.

Declaration

public ContentComposer(string data, Encoding? encoding = null, string? name = null)

Parameters

Type	Name	Description
string	data	The string data to be added as content.
Encoding	encoding	The encoding to use for the content. Defaults to UTF-8 if not specified.
string	name	An optional name for the content part in a multipart form data context.

Remarks

The content type is determined based on whether the data is valid JSON or XML. If neither, 'text/plain' is used.

Methods

AddAutoStringContent(string, Encoding?, string?)

Adds string content to the composer, automatically determining the appropriate media type based on the content.

Declaration

public void AddAutoStringContent(string data, Encoding? encoding = null, string? name = null)

Parameters

Type	Name	Description
string	data	The string data to be added as content.
Encoding	encoding	The encoding to use for the content. Defaults to UTF-8 if not specified.
string	name	An optional name for the content part in a multipart form data context.

Remarks

This method checks if the data is valid JSON or XML and sets the content type accordingly. If neither JSON nor XML is detected, the content type defaults to 'text/plain'.

AddByteArrayContent(byte[], string?)

Adds byte array content to the composer.

Declaration

public void AddByteArrayContent(byte[] bytes, string? name = null)

Parameters

Type	Name	Description
byte[]	bytes	The byte array to be added as content.
string	name	An optional name for the content part, useful in multipart form data scenarios.

Remarks

This method wraps the provided byte array into a ByteArrayContent and sets the content type to 'application/octet-stream' by default.

AddFormUrlEncodedContent(Dictionary<string, string>, string?)

Adds form URL encoded content constructed from a dictionary of key-value pairs.

Declaration

public void AddFormUrlEncodedContent(Dictionary<string, string> formData, string? name = null)

Parameters

Type	Name	Description
Dictionary<string, string>	formData	The dictionary containing form data as key-value pairs.
string	name	An optional name for the content part in multipart form data.

Remarks

Use this method to encode dictionary data as 'application/x-www-form-urlencoded', which is commonly used in HTTP POST requests.

AddPlainStringContent(string, string, Encoding?, string?)

Adds plain string content with a specified media type to the content composer.

Declaration

public void AddPlainStringContent(string data, string mediaType, Encoding? encoding = null, string? name = null)

Parameters

Type	Name	Description
string	data	The string data to add as content.
string	mediaType	The media type to use for the content (e.g., "text/plain", "application/json").
Encoding	encoding	The encoding of the string content, defaulting to UTF-8 if not specified.
string	name	An optional descriptor for the content part, useful in multipart scenarios.

Remarks

This method directly adds string content with the specified media type, useful for simple text-based content types.

AddStreamContent(Stream, string?, string?)

Adds stream content to the composer, useful for large data uploads like files.

Declaration

public void AddStreamContent(Stream stream, string? name = null, string? filename = null)

Parameters

Type	Name	Description
Stream	stream	The stream representing the content to be uploaded.
string	name	An optional name for the content part, used in multipart form data.
string	filename	An optional filename for the content part, used when adding file-based content in multipart form data.

Remarks

Stream content is not read into memory all at once, making this method suitable for large file uploads.

Build()

Consolidates all added content into a single HttpContent instance, suitable for HTTP transmission.

Declaration

public HttpContent? Build()

Returns

Type	Description
HttpContent	A HttpContent instance containing all the previously added content pieces, or null if no content was added.

Remarks

If multiple content pieces are added, they are combined into a MultipartFormDataContent. If only one piece is added, it is returned directly.