 |
SmartAPI
Open Source .NET RQL library for RedDot CMS / OpenText WSM Management Server
|
|
SmartAPI
Open Source .NET RQL library for RedDot CMS / OpenText WSM Management Server
|
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< IPage > | 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. | |
| List< ResultGroup > | 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. | |
| 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< IPage > | 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. | |
| List< ResultGroup > | 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. | |
| bool | TryGetByGuid (Guid pageGuid, ILanguageVariant languageVariant, out IPage page) |
| Try to get a page by its guid and its language variant. | |
Properties | |
| IndexedRDList< int, IPage > | OfCurrentLanguage [get] |
| All pages of the current language variant, indexed by page id. The list is cached by default. | |
| IStartPagesValue | StartPages [get] |
| IndexedRDList< int, IPage > | this[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, IPage > | OfCurrentLanguage [get] |
| All pages of the current language variant, indexed by page id. The list is cached by default. | |
| IStartPagesValue | StartPages [get] |
| IndexedRDList< int, IPage > | this[string language] [get] |
| All pages of the a specific language variant, indexed by page id. The list is cached by default. | |
| erminas.SmartAPI.CMS.Project.Pages.Pages.Pages | ( | IProject | project | ) |
| IPage erminas.SmartAPI.CMS.Project.Pages.Pages.Create | ( | IContentClass | cc, |
| string | headline = null |
||
| ) |
| 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.
| cc | Content class of the page |
| linkGuid | Guid of the link the page should be linked to |
| headline | The headline, or null (default) for the default headline |
| IExtendedPageSearch erminas.SmartAPI.CMS.Project.Pages.Pages.CreateExtendedSearch | ( | ) |
Create an extended page search on this project.
| IPageSearch erminas.SmartAPI.CMS.Project.Pages.Pages.CreateSearch | ( | ) |
Create a simple page search on this project.
| IPage erminas.SmartAPI.CMS.Project.Pages.Pages.GetByGuid | ( | Guid | pageGuid, |
| ILanguageVariant | languageVariant | ||
| ) |
| 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.
| configurator | Action to configure the search |
The following code searches for all pages with headline "test": var results = project.SearchForPages(search => search.Headline="test");
| 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.
| configurator | An action to configure the search |
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)
)
);
| bool erminas.SmartAPI.CMS.Project.Pages.Pages.TryGetByGuid | ( | Guid | pageGuid, |
| ILanguageVariant | languageVariant, | ||
| out IPage | page | ||
| ) |
|
get |
|
get |
|
get |
1.8.2