Interface IPublishedContentQuery

Query methods used for accessing strongly typed content in templates.

Namespace: Umbraco.Cms.Core

Assembly: cs.temp.dll.dll

Syntax

public interface IPublishedContentQuery

Methods

Content(IEnumerable<Guid>)

Declaration

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

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<System.Guid>	ids

Returns

Type	Description
System.Collections.Generic.IEnumerable<IPublishedContent>

Content(IEnumerable<Int32>)

Declaration

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

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<System.Int32>	ids

Returns

Type	Description
System.Collections.Generic.IEnumerable<IPublishedContent>

Content(IEnumerable<Object>)

Declaration

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

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<System.Object>	ids

Returns

Type	Description
System.Collections.Generic.IEnumerable<IPublishedContent>

Content(Guid)

Declaration

IPublishedContent Content(Guid id)

Parameters

Type	Name	Description
System.Guid	id

Returns

Type	Description
IPublishedContent

Content(Int32)

Declaration

IPublishedContent Content(int id)

Parameters

Type	Name	Description
System.Int32	id

Returns

Type	Description
IPublishedContent

Content(Object)

Declaration

IPublishedContent Content(object id)

Parameters

Type	Name	Description
System.Object	id

Returns

Type	Description
IPublishedContent

Content(Udi)

Declaration

IPublishedContent Content(Udi id)

Parameters

Type	Name	Description
Udi	id

Returns

Type	Description
IPublishedContent

ContentAtRoot()

Declaration

IEnumerable<IPublishedContent> ContentAtRoot()

Returns

Type	Description
System.Collections.Generic.IEnumerable<IPublishedContent>

ContentAtXPath(String, XPathVariable[])

Declaration

IEnumerable<IPublishedContent> ContentAtXPath(string xpath, params XPathVariable[] vars)

Parameters

Type	Name	Description
System.String	xpath
XPathVariable[]	vars

Returns

Type	Description
System.Collections.Generic.IEnumerable<IPublishedContent>

ContentAtXPath(XPathExpression, XPathVariable[])

Declaration

IEnumerable<IPublishedContent> ContentAtXPath(XPathExpression xpath, params XPathVariable[] vars)

Parameters

Type	Name	Description
XPathExpression	xpath
XPathVariable[]	vars

Returns

Type	Description
System.Collections.Generic.IEnumerable<IPublishedContent>

ContentSingleAtXPath(String, XPathVariable[])

Declaration

IPublishedContent ContentSingleAtXPath(string xpath, params XPathVariable[] vars)

Parameters

Type	Name	Description
System.String	xpath
XPathVariable[]	vars

Returns

Type	Description
IPublishedContent

Media(IEnumerable<Guid>)

Declaration

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

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<System.Guid>	ids

Returns

Type	Description
System.Collections.Generic.IEnumerable<IPublishedContent>

Media(IEnumerable<Int32>)

Declaration

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

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<System.Int32>	ids

Returns

Type	Description
System.Collections.Generic.IEnumerable<IPublishedContent>

Media(IEnumerable<Object>)

Declaration

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

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<System.Object>	ids

Returns

Type	Description
System.Collections.Generic.IEnumerable<IPublishedContent>

Media(Guid)

Declaration

IPublishedContent Media(Guid id)

Parameters

Type	Name	Description
System.Guid	id

Returns

Type	Description
IPublishedContent

Media(Int32)

Declaration

IPublishedContent Media(int id)

Parameters

Type	Name	Description
System.Int32	id

Returns

Type	Description
IPublishedContent

Media(Object)

Declaration

IPublishedContent Media(object id)

Parameters

Type	Name	Description
System.Object	id

Returns

Type	Description
IPublishedContent

Media(Udi)

Declaration

IPublishedContent Media(Udi id)

Parameters

Type	Name	Description
Udi	id

Returns

Type	Description
IPublishedContent

MediaAtRoot()

Declaration

IEnumerable<IPublishedContent> MediaAtRoot()

Returns

Type	Description
System.Collections.Generic.IEnumerable<IPublishedContent>

Search(IQueryExecutor)

Executes the query and converts the results to .

Declaration

IEnumerable<PublishedSearchResult> Search(IQueryExecutor query)

Parameters

Type	Name	Description
IQueryExecutor	query	The query.

Returns

Type	Description
System.Collections.Generic.IEnumerable<PublishedSearchResult>	The search results.

Search(IQueryExecutor, Int32, Int32, out Int64)

Executes the query and converts the results to .

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
System.Collections.Generic.IEnumerable<PublishedSearchResult>	The search results.

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

Searches content.

Declaration

IEnumerable<PublishedSearchResult> Search(string term, int skip, int take, out long totalRecords, string culture = "*", string indexName = null, 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 ).
System.Collections.Generic.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
System.Collections.Generic.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

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

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 ).

Returns

Type	Description
System.Collections.Generic.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.