Interface IRpcEndpoint

Namespace

TypedRest.Endpoints.Rpc

Assembly

TypedRest.dll

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

public interface IRpcEndpoint : IEndpoint

Inherited Members

IEndpoint.Uri

IEndpoint.HttpClient

IEndpoint.Serializers

IEndpoint.ErrorHandler

IEndpoint.LinkExtractor

IEndpoint.GetLinks(string)

IEndpoint.Link(string)

IEndpoint.LinkTemplate(string, IDictionary<string, object>)

IEndpoint.LinkTemplate(string, object)

Properties

InvokeAllowed

Indicates whether the server has specified the invoke method is currently allowed.

bool? InvokeAllowed { get; }

Property Value

bool?

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.

Remarks

Uses cached data from last response.

Methods

ProbeAsync(CancellationToken)

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

Task ProbeAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Used to cancel the request.

Returns

Task

Exceptions

AuthenticationException

Unauthorized

UnauthorizedAccessException

Forbidden

KeyNotFoundException

NotFound or Gone

HttpRequestException

Other non-success status code.