Class CriteriaRouteFormatter
This abstract base class defines common functionality for defining query strings with criteria filters for use in social service routes.
Inheritance
Inherited Members
Namespace: EPiServer.Social.Common.Rest
Assembly: EPiServer.Social.Common.Rest.dll
Version: 1.5.4Syntax
public abstract class CriteriaRouteFormatter : RouteFormatterConstructors
CriteriaRouteFormatter()
Declaration
protected CriteriaRouteFormatter()Methods
WithCalculateTotalCount(Boolean)
Appends an indication to the query string as to whether to calculate the matched total count.
Declaration
public CriteriaRouteFormatter WithCalculateTotalCount(bool calculateTotalCount)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | calculateTotalCount | Boolean that indicates whether to calculate total count. |
Returns
| Type | Description |
|---|---|
| CriteriaRouteFormatter | The instance of the CriteriaRouteFormatter |
WithExtensionFilter(String)
Appends an indication to the query string as to whether to filter by extension.
Declaration
public CriteriaRouteFormatter WithExtensionFilter(string filter)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | filter | The extension filter. |
Returns
| Type | Description |
|---|---|
| CriteriaRouteFormatter | The instance of the CriteriaRouteFormatter |
WithExtensionType(String)
Appends an indication to the query string as to whether to filter by extension type.
Declaration
public CriteriaRouteFormatter WithExtensionType(string type)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | type | The extension type. |
Returns
| Type | Description |
|---|---|
| CriteriaRouteFormatter | The instance of the CriteriaRouteFormatter |
WithIncludeSubclasses(Nullable<Boolean>)
Appends an indication to the query string as to whether to include subclasses.
Declaration
public CriteriaRouteFormatter WithIncludeSubclasses(bool? includeSubclasses)Parameters
| Type | Name | Description |
|---|---|---|
| System.Nullable<System.Boolean> | includeSubclasses | Whether to include subclasses or not. |
Returns
| Type | Description |
|---|---|
| CriteriaRouteFormatter | The instance of the CriteriaRouteFormatter |
WithOffset(String)
Appends an indication to the query string as to whether to start taking matched items starting at some offset.
Declaration
public CriteriaRouteFormatter WithOffset(string offset)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | offset | The offset to start taking matched items from. |
Returns
| Type | Description |
|---|---|
| CriteriaRouteFormatter | The instance of the CriteriaRouteFormatter |
WithSize(String)
Appends an indication to the query string as to whether to limite the results set by some size.
Declaration
public CriteriaRouteFormatter WithSize(string size)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | size | The max size of the result set. |
Returns
| Type | Description |
|---|---|
| CriteriaRouteFormatter | The instance of the CriteriaRouteFormatter |
WithSort(String)
Appends an indication to the query string as to whether to sort results.
Declaration
public CriteriaRouteFormatter WithSort(string sort)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | sort | The sort specification. |
Returns
| Type | Description |
|---|---|
| CriteriaRouteFormatter | The instance of the CriteriaRouteFormatter |