Class RetrievePagesQueryParameters

Namespace

Kentico.Content.Web.Mvc

Assembly

Kentico.Content.Web.Mvc.dll

Parameters for retrieving web pages of specified content type with fluent API for configuring of the underlying query. IContentRetriever

public sealed class RetrievePagesQueryParameters : RetrievePagesQueryParametersBase<RetrievePagesQueryParameters>

Inheritance

object

RetrieveQueryParametersBase<RetrievePagesQueryParameters>

RetrievePagesQueryParametersBase<RetrievePagesQueryParameters>

RetrievePagesQueryParameters

Inherited Members

RetrievePagesQueryParametersBase<RetrievePagesQueryParameters>.Where(Action<WhereParameters>)

RetrievePagesQueryParametersBase<RetrievePagesQueryParameters>.OrderBy(params string[])

RetrievePagesQueryParametersBase<RetrievePagesQueryParameters>.OrderBy(params OrderByColumn[])

RetrievePagesQueryParametersBase<RetrievePagesQueryParameters>.TopN(int)

RetrievePagesQueryParametersBase<RetrievePagesQueryParameters>.Offset(int, int)

RetrievePagesQueryParametersBase<RetrievePagesQueryParameters>.IncludeTotalCount()

RetrievePagesQueryParametersBase<RetrievePagesQueryParameters>.LinkedFrom(string, string, IEnumerable<IContentItemIdentifier>)

RetrievePagesQueryParametersBase<RetrievePagesQueryParameters>.LinkedFromSchemaField(string, IEnumerable<IContentItemIdentifier>)

RetrievePagesQueryParametersBase<RetrievePagesQueryParameters>.LinkingSchemaField(string, IEnumerable<int>)

RetrievePagesQueryParametersBase<RetrievePagesQueryParameters>.UrlPathColumns()

RetrieveQueryParametersBase<RetrievePagesQueryParameters>.Columns(params string[])

RetrieveQueryParametersBase<RetrievePagesQueryParameters>.Columns(params QueryColumn[])

RetrieveQueryParametersBase<RetrievePagesQueryParameters>.WithLinkedItems(Action<LinkedItemsOptions>)

RetrieveQueryParametersBase<RetrievePagesQueryParameters>.SetUrlLanguageBehavior(UrlLanguageBehavior)

RetrieveQueryParametersBase<RetrievePagesQueryParameters>.Default

Extension Methods

DataExtensions.With<T>(T, Action<T>)

QueryExtensions.AsLiteral<T>(T)

QueryExtensions.AsValue<T>(T, bool)

Methods

Linking(string, IEnumerable<int>)

Configure query to retrieve linked items which reference any of items in the referenceFieldName.

public RetrievePagesQueryParameters Linking(string referenceFieldName, IEnumerable<int> items)

Parameters

referenceFieldName string

Field name of the retrieved content item which includes the items.

items IEnumerable<int>

Identifiers of items which are linked from the retrieved items.

Returns

RetrievePagesQueryParameters

Returns this RetrieveContentQueryParameters instance to chain further configuration.

Remarks

Can be used together with WithLinkedItems(Action<LinkedItemsOptions>) to retrieve further links. Simultaneous call with LinkedFrom(string, string, IEnumerable<IContentItemIdentifier>) is not supported.