Class PageStoreService
EPiServer CMS 5 Web Service for DataFactory. Implements operations corresponding to all methods in IPageStore.
Inheritance
Namespace: EPiServer.WebServices
Assembly: EPiServer.dll
Version: 8.11.0Syntax
public class PageStoreService : WebServiceConstructors
PageStoreService()
Declaration
public PageStoreService()Properties
ContentVersionsService
Declaration
public Injected<IContentVersionRepository> ContentVersionsService { get; set; }Property Value
| Type | Description |
|---|---|
| Injected<IContentVersionRepository> |
DataFactory
Declaration
public Injected<IContentRepository> DataFactory { get; set; }Property Value
| Type | Description |
|---|---|
| Injected<IContentRepository> |
PageCriteriaQueryService
Declaration
public Injected<IPageCriteriaQueryService> PageCriteriaQueryService { get; set; }Property Value
| Type | Description |
|---|---|
| Injected<IPageCriteriaQueryService> |
Methods
Copy(PageReference, PageReference, AccessLevel, AccessLevel, Boolean, Boolean)
Copy a page to another container.
Declaration
public PageReference Copy(PageReference pageLink, PageReference destinationLink, AccessLevel requiredSourceAccess, AccessLevel requiredDestinationAccess, bool publishOnDestination, bool allowThreading)Parameters
| Type | Name | Description |
|---|---|---|
| PageReference | pageLink | The page link. |
| PageReference | destinationLink | The destination link. |
| AccessLevel | requiredSourceAccess | The required source access. |
| AccessLevel | requiredDestinationAccess | The required destination access. |
| System.Boolean | publishOnDestination | If the new pages should be published on the destination. |
| System.Boolean | allowThreading | if set to |
Returns
| Type | Description |
|---|---|
| PageReference |
CreateLanguageBranch(PageReference, LanguageSelector, AccessLevel)
Creates a page of specified language.
Declaration
public RawPage CreateLanguageBranch(PageReference pageLink, LanguageSelector selector, AccessLevel access)Parameters
| Type | Name | Description |
|---|---|---|
| PageReference | pageLink | The link to the page to create a language branch for. |
| LanguageSelector | selector | The language to create. |
| AccessLevel | access | The access. |
Returns
| Type | Description |
|---|---|
| RawPage |
Delete(PageReference, Boolean, AccessLevel)
Deletes the specified page.
Declaration
public void Delete(PageReference pageLink, bool forceDelete, AccessLevel access)Parameters
| Type | Name | Description |
|---|---|---|
| PageReference | pageLink | The page link. |
| System.Boolean | forceDelete | if set to |
| AccessLevel | access | The access. |
DeleteChildren(PageReference, Boolean, AccessLevel)
Deletes the children pages for a specific page.
Declaration
public void DeleteChildren(PageReference pageLink, bool forceDelete, AccessLevel access)Parameters
| Type | Name | Description |
|---|---|---|
| PageReference | pageLink | The page link. |
| System.Boolean | forceDelete | if set to |
| AccessLevel | access | The access. |
DeleteLanguageBranch(PageReference, String, AccessLevel)
Deletes a specific language branch for a page.
Declaration
public void DeleteLanguageBranch(PageReference pageLink, string languageBranch, AccessLevel access)Parameters
| Type | Name | Description |
|---|---|---|
| PageReference | pageLink | The page link to the page. |
| System.String | languageBranch | The language branch to delete. |
| AccessLevel | access | The access. |
DeleteVersion(PageReference, AccessLevel)
Deletes a specific version.
Declaration
public void DeleteVersion(PageReference pageLink, AccessLevel access)Parameters
| Type | Name | Description |
|---|---|---|
| PageReference | pageLink | The page link including version information. |
| AccessLevel | access | The access. |
FindPagesWithCriteria(PageReference, PropertyCriteriaCollection, String, LanguageSelector, AccessLevel)
Finds all pages that matches specified criterias.
Declaration
public RawPage[] FindPagesWithCriteria(PageReference pageLink, PropertyCriteriaCollection criterias, string languageBranch, LanguageSelector selector, AccessLevel requiredAccess)Parameters
| Type | Name | Description |
|---|---|---|
| PageReference | pageLink | The root page for which the search will be performed |
| PropertyCriteriaCollection | criterias | The criterias for pages |
| System.String | languageBranch | Only search for pages on specific language branch |
| LanguageSelector | selector | A language selector used to determine the language of pages to return |
| AccessLevel | requiredAccess | The required access. |
Returns
| Type | Description |
|---|---|
| RawPage[] | A collection of pages that fulfil the criteras, will be empty if no match is found. |
GetChildren(PageReference, LanguageSelector, Int32, Int32)
Gets all children to given page reference.
Declaration
public RawPage[] GetChildren(PageReference pageLink, LanguageSelector selector, int startIndex, int maxRows)Parameters
| Type | Name | Description |
|---|---|---|
| PageReference | pageLink | The page link to get children for. |
| LanguageSelector | selector | Specifies how languages should be handled. |
| System.Int32 | startIndex | The start index of the listing. Used to obtain paging. |
| System.Int32 | maxRows | The maximum amout of pages returned. |
Returns
| Type | Description |
|---|---|
| RawPage[] | An array of children. |
GetDefaultPageData(PageReference, Int32, LanguageSelector, AccessLevel)
Declaration
public RawPage GetDefaultPageData(PageReference parentPageLink, int pageTypeID, LanguageSelector selector, AccessLevel access)Parameters
| Type | Name | Description |
|---|---|---|
| PageReference | parentPageLink | |
| System.Int32 | pageTypeID | |
| LanguageSelector | selector | |
| AccessLevel | access |
Returns
| Type | Description |
|---|---|
| RawPage |
GetLanguageBranches(PageReference, AccessLevel)
Gets all the language branches for a specific page.
Declaration
public RawPage[] GetLanguageBranches(PageReference pageLink, AccessLevel access)Parameters
| Type | Name | Description |
|---|---|---|
| PageReference | pageLink | The page link to get language branches for. |
| AccessLevel | access | The access. |
Returns
| Type | Description |
|---|---|
| RawPage[] | An array of all language branches. |
Remarks
No access check is performed.
GetPage(PageReference, LanguageSelector, AccessLevel)
Gets the page with specified id and language.
Declaration
public RawPage GetPage(PageReference pageLink, LanguageSelector selector, AccessLevel access)Parameters
| Type | Name | Description |
|---|---|---|
| PageReference | pageLink | The page link. |
| LanguageSelector | selector | The selector to use. |
| AccessLevel | access | The access. |
Returns
| Type | Description |
|---|---|
| RawPage | Requested page. |
Remarks
No access check is performed.
Move(PageReference, PageReference, AccessLevel, AccessLevel)
Move a page to another container.
Declaration
public void Move(PageReference pageLink, PageReference destinationLink, AccessLevel requiredSourceAccess, AccessLevel requiredDestinationAccess)Parameters
| Type | Name | Description |
|---|---|---|
| PageReference | pageLink | The link to the page to move. |
| PageReference | destinationLink | The container to which the page will be moved. |
| AccessLevel | requiredSourceAccess | The required source access. |
| AccessLevel | requiredDestinationAccess | The required destination access. |
MoveToWastebasket(PageReference)
Moves a page to wastebasket.
Declaration
public void MoveToWastebasket(PageReference pageLink)Parameters
| Type | Name | Description |
|---|---|---|
| PageReference | pageLink | The page link. |
Ping()
Method to check that the web service is responding.
Declaration
public bool Ping()Returns
| Type | Description |
|---|---|
| System.Boolean |
Save(RawPage, SaveAction, AccessLevel)
Saves the specified page to storage.
Declaration
public PageReference Save(RawPage page, SaveAction action, AccessLevel access)Parameters
| Type | Name | Description |
|---|---|---|
| RawPage | page | The page to save. |
| SaveAction | action | The action that will be performed during save. |
| AccessLevel | access | The access to check for. |
Returns
| Type | Description |
|---|---|
| PageReference |
ValidateWebServiceAccess()
Validates that the user has been granted access to web service.
Declaration
public static void ValidateWebServiceAccess()