Table of Contents

Class FunctionEndpoint<TEntity, TResult>

Namespace
TypedRest.Endpoints.Rpc
Assembly
TypedRest.dll

RPC endpoint that takes TEntity as input and returns TResult as output when invoked.

public class FunctionEndpoint<TEntity, TResult> : RpcEndpointBase, IFunctionEndpoint<TEntity, TResult>, IRpcEndpoint, IEndpoint

Type Parameters

TEntity

The type of entity the endpoint takes as input.

TResult

The type of entity the endpoint returns as output.

Inheritance
FunctionEndpoint<TEntity, TResult>
Implements
IFunctionEndpoint<TEntity, TResult>
Inherited Members

Constructors

FunctionEndpoint(IEndpoint, string)

Creates a new function endpoint with a relative URI.

public FunctionEndpoint(IEndpoint referrer, string relativeUri)

Parameters

referrer IEndpoint

The endpoint used to navigate to this one.

relativeUri string

The URI of this endpoint relative to the referrer's. Add a ./ prefix here to imply a trailing slash referrer's URI.

FunctionEndpoint(IEndpoint, Uri)

Creates a new function endpoint with a relative URI.

public FunctionEndpoint(IEndpoint referrer, Uri relativeUri)

Parameters

referrer IEndpoint

The endpoint used to navigate to this one.

relativeUri Uri

The URI of this endpoint relative to the referrer's.

Methods

InvokeAsync(TEntity, CancellationToken)

Invokes the function.

public Task<TResult> InvokeAsync(TEntity entity, CancellationToken cancellationToken = default)

Parameters

entity TEntity

The entity to post as input.

cancellationToken CancellationToken

Used to cancel the request.

Returns

Task<TResult>

The result returned by the server.

Exceptions

AuthenticationException

Unauthorized

UnauthorizedAccessException

Forbidden

KeyNotFoundException

NotFound or Gone

HttpRequestException

Other non-success status code.