View Source

Class PublishedContentQuery

A class used to query for published content, media items

Inheritance
System.Object
Namespace: Umbraco.Cms.Infrastructure
Assembly: Umbraco.Infrastructure.dll
Syntax
public class PublishedContentQuery : IPublishedContentQuery

Constructors

View Source

PublishedContentQuery(IPublishedSnapshot, IVariationContextAccessor, IExamineManager)

Initializes a new instance of the PublishedContentQuery class.

Declaration
public PublishedContentQuery(IPublishedSnapshot publishedSnapshot, IVariationContextAccessor variationContextAccessor, IExamineManager examineManager)
Parameters
Type Name Description
IPublishedSnapshot publishedSnapshot
IVariationContextAccessor variationContextAccessor
IExamineManager examineManager

Methods

View Source

Content(Guid)

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

Content(IEnumerable<Guid>)

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

Content(IEnumerable<Int32>)

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

Content(IEnumerable<Object>)

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

Content(Int32)

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

Content(Object)

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

Content(Udi)

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

ContentAtRoot()

Declaration
public IEnumerable<IPublishedContent> ContentAtRoot()
Returns
Type Description
System.Collections.IEnumerable<IPublishedContent>
View Source

ContentAtXPath(String, XPathVariable[])

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

ContentAtXPath(XPathExpression, XPathVariable[])

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

ContentSingleAtXPath(String, XPathVariable[])

Declaration
public 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
public IPublishedContent Media(Guid id)
Parameters
Type Name Description
Guid id
Returns
Type Description
IPublishedContent
View Source

Media(IEnumerable<Guid>)

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

Media(IEnumerable<Int32>)

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

Media(IEnumerable<Object>)

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

Media(Int32)

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

Media(Object)

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

Media(Udi)

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

MediaAtRoot()

Declaration
public IEnumerable<IPublishedContent> MediaAtRoot()
Returns
Type Description
System.Collections.IEnumerable<IPublishedContent>
View Source

Search(IQueryExecutor)

Declaration
public IEnumerable<PublishedSearchResult> Search(IQueryExecutor query)
Parameters
Type Name Description
IQueryExecutor query
Returns
Type Description
System.Collections.IEnumerable<PublishedSearchResult>
View Source

Search(IQueryExecutor, Int32, Int32, out Int64)

Declaration
public IEnumerable<PublishedSearchResult> Search(IQueryExecutor query, int skip, int take, out long totalRecords)
Parameters
Type Name Description
IQueryExecutor query
System.Int32 skip
System.Int32 take
System.Int64 totalRecords
Returns
Type Description
System.Collections.IEnumerable<PublishedSearchResult>
View Source

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

Declaration
public IEnumerable<PublishedSearchResult> Search(IQueryExecutor query, int skip, int take, out long totalRecords, string culture)
Parameters
Type Name Description
IQueryExecutor query
System.Int32 skip
System.Int32 take
System.Int64 totalRecords
System.String culture
Returns
Type Description
System.Collections.IEnumerable<PublishedSearchResult>
View Source

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

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
System.String term
System.Int32 skip
System.Int32 take
System.Int64 totalRecords
System.String culture
System.String indexName
System.Nullable<ISet<System.String>> loadedFields
Returns
Type Description
System.Collections.IEnumerable<PublishedSearchResult>
View Source

Search(String, String, String)

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