TypedRest for .NET 1.3.5
build type-safe fluent-style REST API clients
TypedRest.Endpoints.Raw.UploadEndpoint Class Reference

Endpoint that accepts binary uploads using multi-part form encoding or raw bodies. More...

Inheritance diagram for TypedRest.Endpoints.Raw.UploadEndpoint:
TypedRest.Endpoints.EndpointBase TypedRest.Endpoints.Raw.IUploadEndpoint TypedRest.Endpoints.IEndpoint TypedRest.Endpoints.IEndpoint

Public Member Functions

 UploadEndpoint (IEndpoint referrer, Uri relativeUri, string? formField=null)
 Creates a new upload endpoint. More...
 
 UploadEndpoint (IEndpoint referrer, string relativeUri, string? formField=null)
 Creates a new upload endpoint using multi-part form encoding. More...
 
async Task UploadFromAsync (Stream stream, string? fileName=null, string? mimeType=null, CancellationToken cancellationToken=default)
 Uploads data to the endpoint from a stream. More...
 
- Public Member Functions inherited from TypedRest.Endpoints.EndpointBase
void SetDefaultLink (string rel, string? href)
 Registers one or more default links for a specific relation type. These links are used when no links with this relation type are provided by the server. This should only be called during initial setup of the endpoint. More...
 
void SetDefaultLinkTemplate (string rel, string? href)
 Registers a default link template for a specific relation type. This template is used when no template with this relation type is provided by the server. This should only be called during initial setup of the endpoint. More...
 
IReadOnlyList<(Uri uri, string? title)> GetLinks (string rel)
 Resolves all links with a specific relation type. Uses cached data from last response. More...
 
Uri Link (string rel)
 Resolves a single link with a specific relation type. Uses cached data from last response if possible. Tries lazy lookup with HTTP HEAD on cache miss. More...
 
UriTemplate GetLinkTemplate (string rel)
 Retrieves a link template with a specific relation type. Prefer IEndpoint.LinkTemplate(string,object) when possible. More...
 
Uri LinkTemplate (string rel, IDictionary< string, object > variables)
 Resolves a link template with a specific relation type. Uses cached data from last response if possible. Tries lazy lookup with HTTP HEAD on cache miss. More...
 
Uri LinkTemplate (string rel, object variables)
 Resolves a link template with a specific relation type. More...
 
override string ToString ()
 

Additional Inherited Members

- Protected Member Functions inherited from TypedRest.Endpoints.EndpointBase
 EndpointBase (Uri uri, HttpClient httpClient, MediaTypeFormatter serializer, IErrorHandler errorHandler, ILinkExtractor linkExtractor)
 Creates a new endpoint with an absolute URI. More...
 
 EndpointBase (IEndpoint referrer, Uri relativeUri)
 Creates a new endpoint with a relative URI. More...
 
 EndpointBase (IEndpoint referrer, string relativeUri)
 Creates a new endpoint with a relative URI. More...
 
virtual async Task< HttpResponseMessage > HandleAsync (Func< Task< HttpResponseMessage > > request, [CallerMemberName] string caller="unknown")
 Handles various cross-cutting concerns regarding a response message such as discovering links and handling errors. More...
 
Activity? StartActivity ([CallerMemberName] string caller="unknown")
 Starts a new Activity if there is any listener registered (e.g. OpenTelemetry), returns null otherwise. More...
 
virtual void HandleCapabilities (HttpResponseMessage response)
 Handles allowed HTTP methods and other capabilities reported by the server. More...
 
bool? IsMethodAllowed (HttpMethod method)
 Shows whether the server has indicated that a specific HTTP method is currently allowed. More...
 
- Static Protected Member Functions inherited from TypedRest.Endpoints.EndpointBase
static Func< IEndpoint, Uri, TEndpoint > GetConstructor< TEndpoint > ()
 Returns a constructor for TEndpoint as a function with a referrer an a relative URI as input. More...
 
- Properties inherited from TypedRest.Endpoints.EndpointBase
Uri Uri [get]
 
HttpClient HttpClient [get]
 
MediaTypeFormatter Serializer [get]
 
IErrorHandler ErrorHandler [get]
 
ILinkExtractor LinkExtractor [get]
 
- Properties inherited from TypedRest.Endpoints.IEndpoint
Uri Uri [get]
 The HTTP URI of the remote resource.
 
HttpClient HttpClient [get]
 The HTTP client used to communicate with the remote resource.
 
MediaTypeFormatter Serializer [get]
 Controls the serialization of entities sent to and received from the server.
 
IErrorHandler ErrorHandler [get]
 Handles errors in responses.
 
ILinkExtractor LinkExtractor [get]
 Extracts links from responses.
 

Detailed Description

Endpoint that accepts binary uploads using multi-part form encoding or raw bodies.

Constructor & Destructor Documentation

◆ UploadEndpoint() [1/2]

TypedRest.Endpoints.Raw.UploadEndpoint.UploadEndpoint ( IEndpoint  referrer,
Uri  relativeUri,
string?  formField = null 
)
inline

Creates a new upload endpoint.

Parameters
referrerThe endpoint used to navigate to this one.
relativeUriThe URI of this endpoint relative to the referrer 's.
formFieldThe name of the form field to place the uploaded data into; leave null to use raw bodies instead of a multi-part forms.

◆ UploadEndpoint() [2/2]

TypedRest.Endpoints.Raw.UploadEndpoint.UploadEndpoint ( IEndpoint  referrer,
string  relativeUri,
string?  formField = null 
)
inline

Creates a new upload endpoint using multi-part form encoding.

Parameters
referrerThe endpoint used to navigate to this one.
relativeUriThe URI of this endpoint relative to the referrer 's.
formFieldThe name of the form field to place the uploaded data into; leave null to use raw bodies instead of a multi-part forms.

Member Function Documentation

◆ UploadFromAsync()

async Task TypedRest.Endpoints.Raw.UploadEndpoint.UploadFromAsync ( Stream  stream,
string?  fileName = null,
string?  mimeType = null,
CancellationToken  cancellationToken = default 
)
inline

Uploads data to the endpoint from a stream.

Parameters
streamThe stream to read the upload data from.
fileNameThe name of the uploaded file.
mimeTypeThe MIME type of the data to upload.
cancellationTokenUsed to cancel the request.
Exceptions
InvalidDataExceptionHttpStatusCode.BadRequest
AuthenticationExceptionHttpStatusCode.Unauthorized
UnauthorizedAccessExceptionHttpStatusCode.Forbidden
KeyNotFoundExceptionHttpStatusCode.NotFound or HttpStatusCode.Gone
HttpRequestExceptionOther non-success status code.

Implements TypedRest.Endpoints.Raw.IUploadEndpoint.


The documentation for this class was generated from the following file: