IPostaSectionClient Methods

Docs/Reference/Search C# APIs/CommunityToolkit.Aspire.Posta/IPostaSectionClient/Methods

Methods

Docs Reference Search C# APIs CommunityToolkit.Aspire.Posta IPostaSectionClient Methods

InterfaceMethods3 members

Common operations exposed by each Posta API section.

SendAsync(PostaEndpoint, PostaRequest?, CancellationToken)abstractTask<TResponse?>

Invokes an endpoint and deserializes its JSON response.

public interface IPostaSectionClient
{
    public abstract Task<TResponse?> SendAsync<TResponse>(
        PostaEndpoint endpoint,
        PostaRequest? request = null,
        CancellationToken cancellationToken = default(CancellationToken))
    {
        // ...
    }
}

Parameters

endpointPostaEndpoint

requestPostaRequest?optional

cancellationTokenCancellationTokenoptional

SendAsync(PostaEndpoint, PostaRequest?, CancellationToken)abstractTask<JsonDocument?>

Invokes an endpoint and returns its JSON response.

public interface IPostaSectionClient
{
    public abstract Task<JsonDocument?> SendAsync(
        PostaEndpoint endpoint,
        PostaRequest? request = null,
        CancellationToken cancellationToken = default(CancellationToken))
    {
        // ...
    }
}

Parameters

endpointPostaEndpoint

requestPostaRequest?optional

cancellationTokenCancellationTokenoptional

SendStreamAsync(PostaEndpoint, PostaRequest?, CancellationToken)abstractTask<PostaStreamResponse>

Invokes an endpoint and returns a streaming response. Disposing the result disposes the HTTP response.

public interface IPostaSectionClient
{
    public abstract Task<PostaStreamResponse> SendStreamAsync(
        PostaEndpoint endpoint,
        PostaRequest? request = null,
        CancellationToken cancellationToken = default(CancellationToken))
    {
        // ...
    }
}

Parameters

endpointPostaEndpoint

requestPostaRequest?optional

cancellationTokenCancellationTokenoptional