SmartAPI
Open Source .NET RQL library for RedDot CMS / OpenText WSM Management Server
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Properties Pages
erminas.SmartAPI.CMS.Project.Pages.Pages Class Reference
+ Inheritance diagram for erminas.SmartAPI.CMS.Project.Pages.Pages:
+ Collaboration diagram for erminas.SmartAPI.CMS.Project.Pages.Pages:

Public Member Functions

 Pages (IProject project)
 
IPage Create (IContentClass cc, string headline=null)
 Create a new page.
 
IPage CreateAndConnect (IContentClass cc, Guid linkGuid, string headline=null)
 Create a new page in the current language variant and link it.
 
IExtendedPageSearch CreateExtendedSearch ()
 Create an extended page search on this project.
 
IPageSearch CreateSearch ()
 Create a simple page search on this project.
 
IPage GetByGuid (Guid pageGuid, ILanguageVariant languageVariant)
 
IEnumerable< IPageSearch (Action< IPageSearch > configurator=null)
 Convenience function for simple page searches. Creates a PageSearch object, configures it through the configurator parameter and returns the search result.
 
List< ResultGroupSearchExtended (Action< IExtendedPageSearch > configurator=null)
 Convenience funtion for extended page searches. Creates a new PageSearchExtended object which gets configured through the configurator parameter and returns the result of the search.
 
bool TryGetByGuid (Guid pageGuid, ILanguageVariant languageVariant, out IPage page)
 
- Public Member Functions inherited from erminas.SmartAPI.CMS.Project.Pages.IPages
IPage Create (IContentClass cc, string headline=null)
 Create a new page.
 
IPage CreateAndConnect (IContentClass cc, Guid linkGuid, string headline=null)
 Create a new page in the current language variant and link it.
 
IExtendedPageSearch CreateExtendedSearch ()
 Create an extended page search on this project.
 
IPageSearch CreateSearch ()
 Create a simple page search on this project.
 
IPage GetByGuid (Guid pageGuid, ILanguageVariant languageVariant)
 Get a page by its guid and its language variant. Does not load all Pages.
 
IEnumerable< IPageSearch (Action< IPageSearch > configurator=null)
 Convenience function for simple page searches. Creates a PageSearch object, configures it through the configurator parameter and returns the search result.
 
List< ResultGroupSearchExtended (Action< IExtendedPageSearch > configurator=null)
 Convenience funtion for extended page searches. Creates a new PageSearchExtended object which gets configured through the configurator parameter and returns the result of the search.
 
bool TryGetByGuid (Guid pageGuid, ILanguageVariant languageVariant, out IPage page)
 Try to get a page by its guid and its language variant.
 

Properties

IndexedRDList< int, IPageOfCurrentLanguage [get]
 All pages of the current language variant, indexed by page id. The list is cached by default.
 
IStartPagesValue StartPages [get]
 
IndexedRDList< int, IPagethis[string language] [get]
 All pages of the a specific language variant, indexed by page id. The list is cached by default.
 
- Properties inherited from erminas.SmartAPI.CMS.Project.Pages.IPages
IndexedRDList< int, IPageOfCurrentLanguage [get]
 All pages of the current language variant, indexed by page id. The list is cached by default.
 
IStartPagesValue StartPages [get]
 
IndexedRDList< int, IPagethis[string language] [get]
 All pages of the a specific language variant, indexed by page id. The list is cached by default.
 

Detailed Description

Definition at line 127 of file IPages.cs.

Constructor & Destructor Documentation

erminas.SmartAPI.CMS.Project.Pages.Pages.Pages ( IProject  project)

Definition at line 135 of file IPages.cs.

Member Function Documentation

IPage erminas.SmartAPI.CMS.Project.Pages.Pages.Create ( IContentClass  cc,
string  headline = null 
)

Create a new page.

Parameters
ccContent class of the page
headlineThe headline, or null (default) for the default headline
Returns
The newly created page

Definition at line 171 of file IPages.cs.

IPage erminas.SmartAPI.CMS.Project.Pages.Pages.CreateAndConnect ( IContentClass  cc,
Guid  linkGuid,
string  headline = null 
)

Create a new page in the current language variant and link it.

Parameters
ccContent class of the page
linkGuidGuid of the link the page should be linked to
headlineThe headline, or null (default) for the default headline
Returns
The newly created (and linked) page

Definition at line 184 of file IPages.cs.

IExtendedPageSearch erminas.SmartAPI.CMS.Project.Pages.Pages.CreateExtendedSearch ( )

Create an extended page search on this project.

CreateSearch

Definition at line 196 of file IPages.cs.

IPageSearch erminas.SmartAPI.CMS.Project.Pages.Pages.CreateSearch ( )

Create a simple page search on this project.

CreateExtendedSearch

Definition at line 205 of file IPages.cs.

IPage erminas.SmartAPI.CMS.Project.Pages.Pages.GetByGuid ( Guid  pageGuid,
ILanguageVariant  languageVariant 
)

Definition at line 146 of file IPages.cs.

+ Here is the call graph for this function:

IEnumerable<IPage> erminas.SmartAPI.CMS.Project.Pages.Pages.Search ( Action< IPageSearch configurator = null)

Convenience function for simple page searches. Creates a PageSearch object, configures it through the configurator parameter and returns the search result.

Parameters
configuratorAction to configure the search
Returns
The search results

The following code searches for all pages with headline "test": var results = project.SearchForPages(search => search.Headline="test");

Definition at line 236 of file IPages.cs.

List<ResultGroup> erminas.SmartAPI.CMS.Project.Pages.Pages.SearchExtended ( Action< IExtendedPageSearch configurator = null)

Convenience funtion for extended page searches. Creates a new PageSearchExtended object which gets configured through the configurator parameter and returns the result of the search.

Parameters
configuratorAn action to configure the search
Returns
The search results

The following code searches for all pages saved as draft by the current user:

            var results = project.SearchForPagesExtended(
            search => search.AddPredicate(
            new PageStatusPredicate(PageStatusPredicate.PageStatusType.SavedAsDraft,
            PageStatusPredicate.UserType.CurrentUser)
            )
            );
        

Definition at line 266 of file IPages.cs.

bool erminas.SmartAPI.CMS.Project.Pages.Pages.TryGetByGuid ( Guid  pageGuid,
ILanguageVariant  languageVariant,
out IPage  page 
)

Definition at line 151 of file IPages.cs.

Property Documentation

IndexedRDList<int, IPage> erminas.SmartAPI.CMS.Project.Pages.Pages.OfCurrentLanguage
get

All pages of the current language variant, indexed by page id. The list is cached by default.

Definition at line 222 of file IPages.cs.

IStartPagesValue erminas.SmartAPI.CMS.Project.Pages.Pages.StartPages
get

Definition at line 142 of file IPages.cs.

IndexedRDList<int, IPage> erminas.SmartAPI.CMS.Project.Pages.Pages.this[string language]
get

All pages of the a specific language variant, indexed by page id. The list is cached by default.

Definition at line 214 of file IPages.cs.


The documentation for this class was generated from the following file: