View Source

Class PublishedContentQuery

A class used to query for published content, media items

Inheritance

object

Namespace: Umbraco.Cms.Infrastructure

Assembly: Umbraco.Infrastructure.dll

Syntax

public class PublishedContentQuery : IPublishedContentQuery

Constructors

PublishedContentQuery(IVariationContextAccessor, IExamineManager, IPublishedContentCache, IPublishedMediaCache)

Initializes a new instance of the PublishedContentQuery class.

Declaration

[Obsolete("Scheduled for removal in Umbraco 18")]
public PublishedContentQuery(IVariationContextAccessor variationContextAccessor, IExamineManager examineManager, IPublishedContentCache publishedContent, IPublishedMediaCache publishedMediaCache)

Parameters

Type	Name	Description
IVariationContextAccessor	variationContextAccessor
IExamineManager	examineManager
IPublishedContentCache	publishedContent
IPublishedMediaCache	publishedMediaCache

PublishedContentQuery(IVariationContextAccessor, IExamineManager, IPublishedContentCache, IPublishedMediaCache, IDocumentNavigationQueryService)

Initializes a new instance of the PublishedContentQuery class.

Declaration

public PublishedContentQuery(IVariationContextAccessor variationContextAccessor, IExamineManager examineManager, IPublishedContentCache publishedContent, IPublishedMediaCache publishedMediaCache, IDocumentNavigationQueryService documentNavigationQueryService)

Parameters

Type	Name	Description
IVariationContextAccessor	variationContextAccessor
IExamineManager	examineManager
IPublishedContentCache	publishedContent
IPublishedMediaCache	publishedMediaCache
IDocumentNavigationQueryService	documentNavigationQueryService

Methods

Content(IEnumerable<Guid>)

Declaration

public IEnumerable<IPublishedContent> Content(IEnumerable<Guid> ids)

Parameters

Type	Name	Description
IEnumerable<Guid>	ids

Returns

Type	Description
IEnumerable<IPublishedContent>

Content(IEnumerable<int>)

Declaration

public IEnumerable<IPublishedContent> Content(IEnumerable<int> ids)

Parameters

Type	Name	Description
IEnumerable<int>	ids

Returns

Type	Description
IEnumerable<IPublishedContent>

Content(IEnumerable<object>)

Declaration

public IEnumerable<IPublishedContent> Content(IEnumerable<object> ids)

Parameters

Type	Name	Description
IEnumerable<object>	ids

Returns

Type	Description
IEnumerable<IPublishedContent>

Content(Guid)

Declaration

public IPublishedContent? Content(Guid id)

Parameters

Type	Name	Description
Guid	id

Returns

Type	Description
IPublishedContent

Content(int)

Declaration

public IPublishedContent? Content(int id)

Parameters

Type	Name	Description
int	id

Returns

Type	Description
IPublishedContent

Content(object)

Declaration

public IPublishedContent? Content(object id)

Parameters

Type	Name	Description
object	id

Returns

Type	Description
IPublishedContent

Content(Udi?)

Declaration

public IPublishedContent? Content(Udi? id)

Parameters

Type	Name	Description
Udi	id

Returns

Type	Description
IPublishedContent

ContentAtRoot()

Declaration

public IEnumerable<IPublishedContent> ContentAtRoot()

Returns

Type	Description
IEnumerable<IPublishedContent>

Media(IEnumerable<Guid>)

Declaration

public IEnumerable<IPublishedContent> Media(IEnumerable<Guid> ids)

Parameters

Type	Name	Description
IEnumerable<Guid>	ids

Returns

Type	Description
IEnumerable<IPublishedContent>

Media(IEnumerable<int>)

Declaration

public IEnumerable<IPublishedContent> Media(IEnumerable<int> ids)

Parameters

Type	Name	Description
IEnumerable<int>	ids

Returns

Type	Description
IEnumerable<IPublishedContent>

Media(IEnumerable<object>)

Declaration

public IEnumerable<IPublishedContent> Media(IEnumerable<object> ids)

Parameters

Type	Name	Description
IEnumerable<object>	ids

Returns

Type	Description
IEnumerable<IPublishedContent>

Media(Guid)

Declaration

public IPublishedContent? Media(Guid id)

Parameters

Type	Name	Description
Guid	id

Returns

Type	Description
IPublishedContent

Media(int)

Declaration

public IPublishedContent? Media(int id)

Parameters

Type	Name	Description
int	id

Returns

Type	Description
IPublishedContent

Media(object)

Declaration

public IPublishedContent? Media(object id)

Parameters

Type	Name	Description
object	id

Returns

Type	Description
IPublishedContent

Media(Udi?)

Declaration

public IPublishedContent? Media(Udi? id)

Parameters

Type	Name	Description
Udi	id

Returns

Type	Description
IPublishedContent

MediaAtRoot()

Declaration

public IEnumerable<IPublishedContent> MediaAtRoot()

Returns

Type	Description
IEnumerable<IPublishedContent>

Search(IQueryExecutor)

Executes the query and converts the results to PublishedSearchResult.

Declaration

public IEnumerable<PublishedSearchResult> Search(IQueryExecutor query)

Parameters

Type	Name	Description
IQueryExecutor	query	The query.

Returns

Type	Description
IEnumerable<PublishedSearchResult>	The search results.

Search(IQueryExecutor, int, int, out long)

Executes the query and converts the results to PublishedSearchResult.

Declaration

public IEnumerable<PublishedSearchResult> Search(IQueryExecutor query, int skip, int take, out long totalRecords)

Parameters

Type	Name	Description
IQueryExecutor	query	The query.
int	skip	The amount of results to skip.
int	take	The amount of results to take/return.
long	totalRecords	The total amount of records.

Returns

Type	Description
IEnumerable<PublishedSearchResult>	The search results.

Search(IQueryExecutor, int, int, out long, string?)

Executes the query and converts the results to PublishedSearchResult.

Declaration

public IEnumerable<PublishedSearchResult> Search(IQueryExecutor query, int skip, int take, out long totalRecords, string? culture)

Parameters

Type	Name	Description
IQueryExecutor	query	The query.
int	skip	The amount of results to skip.
int	take	The amount of results to take/return.
long	totalRecords	The total amount of records.
string	culture	The culture (defaults to a culture insensitive search).

Returns

Type	Description
IEnumerable<PublishedSearchResult>	The search results.

Remarks

While enumerating results, the ambient culture is changed to be the searched culture.

Search(string, int, int, out long, string, string, ISet<string>?)

Searches content.

Declaration

public IEnumerable<PublishedSearchResult> Search(string term, int skip, int take, out long totalRecords, string culture = "*", string indexName = "ExternalIndex", ISet<string>? loadedFields = null)

Parameters

Type	Name	Description
string	term	The term to search.
int	skip	The amount of results to skip.
int	take	The amount of results to take/return.
long	totalRecords	The total amount of records.
string	culture	The culture (defaults to a culture insensitive search).
string	indexName	The name of the index to search (defaults to ExternalIndexName).
ISet<string>	loadedFields	This parameter is no longer used, because the results are loaded from the published snapshot using the single item ID field.

Returns

Type	Description
IEnumerable<PublishedSearchResult>	The search results.

Remarks

When the culture is not specified or is *, all cultures are searched. To search for only invariant documents and fields use null. When searching on a specific culture, all culture specific fields are searched for the provided culture and all invariant fields for all documents.

While enumerating results, the ambient culture is changed to be the searched culture.

Search(string, string, string)

Searches content.

Declaration

public IEnumerable<PublishedSearchResult> Search(string term, string culture = "*", string indexName = "ExternalIndex")

Parameters

Type	Name	Description
string	term	The term to search.
string	culture	The culture (defaults to a culture insensitive search).
string	indexName	The name of the index to search (defaults to ExternalIndexName).

Returns

Type	Description
IEnumerable<PublishedSearchResult>	The search results.

Remarks

When the culture is not specified or is *, all cultures are searched. To search for only invariant documents and fields use null. When searching on a specific culture, all culture specific fields are searched for the provided culture and all invariant fields for all documents.

While enumerating results, the ambient culture is changed to be the searched culture.