TypedRest for .NET 1.3.5
build type-safe fluent-style REST API clients
TypedRest.Endpoints.Rpc.IRpcEndpoint Interface Reference

An endpoint for a non-RESTful resource that acts like a callable function. More...

Inheritance diagram for TypedRest.Endpoints.Rpc.IRpcEndpoint:
TypedRest.Endpoints.IEndpoint TypedRest.Endpoints.Rpc.IActionEndpoint TypedRest.Endpoints.Rpc.IConsumerEndpoint< in in TEntity > TypedRest.Endpoints.Rpc.IFunctionEndpoint< in in TEntity, TResult > TypedRest.Endpoints.Rpc.IProducerEndpoint< out out TResult > TypedRest.Endpoints.Rpc.RpcEndpointBase TypedRest.Endpoints.Rpc.ActionEndpoint TypedRest.Endpoints.Rpc.ActionEndpoint TypedRest.Endpoints.Rpc.ConsumerEndpoint< TEntity > TypedRest.Endpoints.Rpc.FunctionEndpoint< TEntity, TResult > TypedRest.Endpoints.Rpc.ProducerEndpoint< TResult >

Public Member Functions

Task ProbeAsync (CancellationToken cancellationToken=default)
 Queries the server about capabilities of the endpoint without performing any action. More...
 
- Public Member Functions inherited from TypedRest.Endpoints.IEndpoint
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...
 
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...
 

Properties

bool? InvokeAllowed [get]
 Shows whether the server has indicated that the invoke method is currently allowed. More...
 
- 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

An endpoint for a non-RESTful resource that acts like a callable function.

Member Function Documentation

◆ ProbeAsync()

Task TypedRest.Endpoints.Rpc.IRpcEndpoint.ProbeAsync ( CancellationToken  cancellationToken = default)

Queries the server about capabilities of the endpoint without performing any action.

Parameters
cancellationTokenUsed to cancel the request.
Exceptions
AuthenticationExceptionHttpStatusCode.Unauthorized
UnauthorizedAccessExceptionHttpStatusCode.Forbidden
KeyNotFoundExceptionHttpStatusCode.NotFound or HttpStatusCode.Gone
HttpRequestExceptionOther non-success status code.

Implemented in TypedRest.Endpoints.Rpc.RpcEndpointBase.

Property Documentation

◆ InvokeAllowed

bool? TypedRest.Endpoints.Rpc.IRpcEndpoint.InvokeAllowed
get

Shows whether the server has indicated that the invoke method is currently allowed.

Uses cached data from last response.

Returns
true if the method is allowed, false if the method is not allowed, null If no request has been sent yet or the server did not specify allowed methods.

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