RestierRouteBuilder

Definition

Assembly: Microsoft.Restier.Core.dll Namespace: Microsoft.Restier.Core Inheritance: System.Object

Syntax

Microsoft.Restier.Core.RestierRouteBuilder

Summary

A fluent configuration helper that maps ApiBase instances to ASP.NET OData routes.

Constructors

.ctor

Syntax

public RestierRouteBuilder()

.ctor Inherited

Inherited from object

Syntax

public Object()

Methods

Equals Inherited Virtual

Inherited from object

Syntax

public virtual bool Equals(object obj)

Parameters

Name	Type	Description
`obj`	`object?`	-

Returns

Type: bool

Equals Inherited

Inherited from object

Syntax

public static bool Equals(object objA, object objB)

Parameters

Name	Type	Description
`objA`	`object?`	-
`objB`	`object?`	-

Returns

Type: bool

GetHashCode Inherited Virtual

Inherited from object

Syntax

public virtual int GetHashCode()

Returns

Type: int

GetType Inherited

Inherited from object

Syntax

public System.Type GetType()

Returns

Type: System.Type

MapApiRoute

Maps the specified Restier API to an ASP.NET OData Route.

Syntax

public Microsoft.Restier.Core.RestierRouteBuilder MapApiRoute<TApi>(string routeName, string routePrefix, bool allowBatching = true) where TApi : Microsoft.Restier.Core.ApiBase

Parameters

Name	Type	Description
`routeName`	`string`	The name of the Route. Used to map the Route to a specific OData per-route container. Defaults to ‘RestierDefault’.
`routePrefix`	`string`	A string
`allowBatching`	`bool`	A boolean specifying if the RestierBatchHandler will be mapped to the ‘$batch’ route.

Returns

Type: Microsoft.Restier.Core.RestierRouteBuilder The RestierRouteBuilder instance to allow for fluent method chaining.

Type Parameters

TApi -

MemberwiseClone Inherited

Inherited from object

Syntax

protected internal object MemberwiseClone()

Returns

Type: object

ReferenceEquals Inherited

Inherited from object

Syntax

public static bool ReferenceEquals(object objA, object objB)

Parameters

Name	Type	Description
`objA`	`object?`	-
`objB`	`object?`	-

Returns

Type: bool

ToString Inherited Virtual

Inherited from object

Syntax

public virtual string ToString()

Returns

Type: string?

​Definition

​Syntax

​Summary

​Constructors

​ .ctor

​Syntax

​ .ctor Inherited

​Syntax

​Methods

​ Equals Inherited Virtual

​Syntax

​Parameters

​Returns

​ Equals Inherited

​Syntax

​Parameters

​Returns

​ GetHashCode Inherited Virtual

​Syntax

​Returns

​ GetType Inherited

​Syntax

​Returns

​ MapApiRoute

​Syntax

​Parameters

​Returns

​Type Parameters

​ MemberwiseClone Inherited

​Syntax

​Returns

​ ReferenceEquals Inherited

​Syntax

​Parameters

​Returns

​ ToString Inherited Virtual

​Syntax

​Returns

Definition

Syntax

Summary

Constructors

.ctor

Syntax

.ctor Inherited

Syntax

Methods

Equals Inherited Virtual

Syntax

Parameters

Returns

Equals Inherited

Syntax

Parameters

Returns

GetHashCode Inherited Virtual

Syntax

Returns

GetType Inherited

Syntax

Returns

MapApiRoute

Syntax

Parameters

Returns

Type Parameters

MemberwiseClone Inherited

Syntax

Returns

ReferenceEquals Inherited

Syntax

Parameters

Returns

ToString Inherited Virtual

Syntax

Returns