View Source

Interface IPublishedContentQuery

Query methods used for accessing strongly typed content in templates.

Namespace: Umbraco.Cms.Core
Assembly: Umbraco.Infrastructure.dll
Syntax
public interface IPublishedContentQuery

Methods

View Source

Content(Guid)

Declaration
IPublishedContent Content(Guid id)
Parameters
Type Name Description
Guid id
Returns
Type Description
IPublishedContent
View Source

Content(IEnumerable<Guid>)

Declaration
IEnumerable<IPublishedContent> Content(IEnumerable<Guid> ids)
Parameters
Type Name Description
IEnumerable<Guid> ids
Returns
Type Description
IEnumerable<IPublishedContent>
View Source

Content(IEnumerable<Int32>)

Declaration
IEnumerable<IPublishedContent> Content(IEnumerable<int> ids)
Parameters
Type Name Description
IEnumerable<System.Int32> ids
Returns
Type Description
IEnumerable<IPublishedContent>
View Source

Content(IEnumerable<Object>)

Declaration
IEnumerable<IPublishedContent> Content(IEnumerable<object> ids)
Parameters
Type Name Description
IEnumerable<System.Object> ids
Returns
Type Description
IEnumerable<IPublishedContent>
View Source

Content(Int32)

Declaration
IPublishedContent Content(int id)
Parameters
Type Name Description
System.Int32 id
Returns
Type Description
IPublishedContent
View Source

Content(Object)

Declaration
IPublishedContent Content(object id)
Parameters
Type Name Description
System.Object id
Returns
Type Description
IPublishedContent
View Source

Content(Udi)

Declaration
IPublishedContent Content(Udi id)
Parameters
Type Name Description
Udi id
Returns
Type Description
IPublishedContent
View Source

ContentAtRoot()

Declaration
IEnumerable<IPublishedContent> ContentAtRoot()
Returns
Type Description
IEnumerable<IPublishedContent>
View Source

ContentAtXPath(String, XPathVariable[])

Declaration
IEnumerable<IPublishedContent> ContentAtXPath(string xpath, params XPathVariable[] vars)
Parameters
Type Name Description
System.String xpath
XPathVariable[] vars
Returns
Type Description
IEnumerable<IPublishedContent>
View Source

ContentAtXPath(XPathExpression, XPathVariable[])

Declaration
IEnumerable<IPublishedContent> ContentAtXPath(XPathExpression xpath, params XPathVariable[] vars)
Parameters
Type Name Description
System.Xml.XPath.XPathExpression xpath
XPathVariable[] vars
Returns
Type Description
IEnumerable<IPublishedContent>
View Source

ContentSingleAtXPath(String, XPathVariable[])

Declaration
IPublishedContent ContentSingleAtXPath(string xpath, params XPathVariable[] vars)
Parameters
Type Name Description
System.String xpath
XPathVariable[] vars
Returns
Type Description
IPublishedContent
View Source

Media(Guid)

Declaration
IPublishedContent Media(Guid id)
Parameters
Type Name Description
Guid id
Returns
Type Description
IPublishedContent
View Source

Media(IEnumerable<Guid>)

Declaration
IEnumerable<IPublishedContent> Media(IEnumerable<Guid> ids)
Parameters
Type Name Description
IEnumerable<Guid> ids
Returns
Type Description
IEnumerable<IPublishedContent>
View Source

Media(IEnumerable<Int32>)

Declaration
IEnumerable<IPublishedContent> Media(IEnumerable<int> ids)
Parameters
Type Name Description
IEnumerable<System.Int32> ids
Returns
Type Description
IEnumerable<IPublishedContent>
View Source

Media(IEnumerable<Object>)

Declaration
IEnumerable<IPublishedContent> Media(IEnumerable<object> ids)
Parameters
Type Name Description
IEnumerable<System.Object> ids
Returns
Type Description
IEnumerable<IPublishedContent>
View Source

Media(Int32)

Declaration
IPublishedContent Media(int id)
Parameters
Type Name Description
System.Int32 id
Returns
Type Description
IPublishedContent
View Source

Media(Object)

Declaration
IPublishedContent Media(object id)
Parameters
Type Name Description
System.Object id
Returns
Type Description
IPublishedContent
View Source

Media(Udi)

Declaration
IPublishedContent Media(Udi id)
Parameters
Type Name Description
Udi id
Returns
Type Description
IPublishedContent
View Source

MediaAtRoot()

Declaration
IEnumerable<IPublishedContent> MediaAtRoot()
Returns
Type Description
IEnumerable<IPublishedContent>
View Source

Search(IQueryExecutor)

Executes the query and converts the results to PublishedSearchResult.

Declaration
IEnumerable<PublishedSearchResult> Search(IQueryExecutor query)
Parameters
Type Name Description
IQueryExecutor query

The query.
Returns
Type Description
IEnumerable<PublishedSearchResult>

The search results.
View Source

Search(IQueryExecutor, Int32, Int32, out Int64)

Executes the query and converts the results to PublishedSearchResult.

Declaration
IEnumerable<PublishedSearchResult> Search(IQueryExecutor query, int skip, int take, out long totalRecords)
Parameters
Type Name Description
IQueryExecutor query

The query.
System.Int32 skip

The amount of results to skip.
System.Int32 take

The amount of results to take/return.
System.Int64 totalRecords

The total amount of records.
Returns
Type Description
IEnumerable<PublishedSearchResult>

The search results.
View Source

Search(IQueryExecutor, Int32, Int32, out Int64, String)

Executes the query and converts the results to PublishedSearchResult.

Declaration
virtual IEnumerable<PublishedSearchResult> Search(IQueryExecutor query, int skip, int take, out long totalRecords, string culture)
Parameters
Type Name Description
IQueryExecutor query

The query.
System.Int32 skip

The amount of results to skip.
System.Int32 take

The amount of results to take/return.
System.Int64 totalRecords

The total amount of records.
System.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.

View Source

Search(String, Int32, Int32, out Int64, String, String, Nullable<ISet<String>>)

Searches content.

Declaration
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
System.String term

The term to search.
System.Int32 skip

The amount of results to skip.
System.Int32 take

The amount of results to take/return.
System.Int64 totalRecords

The total amount of records.
System.String culture

The culture (defaults to a culture insensitive search).
System.String indexName

The name of the index to search (defaults to ExternalIndexName).
System.Nullable<ISet<System.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.

View Source

Search(String, String, String)

Searches content.

Declaration
IEnumerable<PublishedSearchResult> Search(string term, string culture = "*", string indexName = "ExternalIndex")
Parameters
Type Name Description
System.String term

The term to search.
System.String culture

The culture (defaults to a culture insensitive search).
System.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.