Class DataFactoryService
Web service for DataFactory
Inheritance
Namespace: EPiServer.WebServices
Assembly: EPiServer.dll
Version: 8.11.0Syntax
public class DataFactoryService : WebServiceConstructors
DataFactoryService()
Declaration
public DataFactoryService()Fields
ExceptionTextPermissionWebServiceAccess
The text that are returned to callers that does not have been granted webservice access.
Declaration
public const string ExceptionTextPermissionWebServiceAccess = "The user does not have the 'Permission.WebServiceAccess' access right to access web services on the remote site, for user "Field Value
| Type | Description |
|---|---|
| System.String |
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)
Copy a page to another container.
Declaration
public PageReference Copy(PageReference pageLink, PageReference destinationLink)Parameters
| Type | Name | Description |
|---|---|---|
| PageReference | pageLink | The page link. |
| PageReference | destinationLink | The destination link. |
Returns
| Type | Description |
|---|---|
| PageReference |
CreateLanguageBranch(PageReference, String)
Creates a page of specified language.
Declaration
public RawPage CreateLanguageBranch(PageReference pageLink, string languageBranch)Parameters
| Type | Name | Description |
|---|---|---|
| PageReference | pageLink | The link to the page to create a language branch for. |
| System.String | languageBranch | The language branch. |
Returns
| Type | Description |
|---|---|
| RawPage |
Delete(PageReference, Boolean)
Deletes the specified page.
Declaration
public void Delete(PageReference pageLink, bool forceDelete)Parameters
| Type | Name | Description |
|---|---|---|
| PageReference | pageLink | The page link. |
| System.Boolean | forceDelete | if set to |
DeleteChildren(PageReference, Boolean)
Deletes the children pages for a specific page.
Declaration
public void DeleteChildren(PageReference pageLink, bool forceDelete)Parameters
| Type | Name | Description |
|---|---|---|
| PageReference | pageLink | The page link. |
| System.Boolean | forceDelete | if set to |
DeleteLanguageBranch(PageReference, String)
Deletes a specific language branch for a page.
Declaration
public void DeleteLanguageBranch(PageReference pageLink, string languageBranch)Parameters
| Type | Name | Description |
|---|---|---|
| PageReference | pageLink | The page link to the page. |
| System.String | languageBranch | The language branch to delete. |
DeleteVersion(PageReference)
Deletes a specific version of a page.
Declaration
public void DeleteVersion(PageReference pageLink)Parameters
| Type | Name | Description |
|---|---|---|
| PageReference | pageLink | The page link including version information. |
Dispose(Boolean)
Clean up any resources being used.
Declaration
protected override void Dispose(bool disposing)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | disposing |
FindPagesWithCriteria(PageReference, PropertyCriteriaCollection)
Finds all pages that matches specified criterias.
Declaration
public RawPage[] FindPagesWithCriteria(PageReference pageLink, PropertyCriteriaCollection criterias)Parameters
| Type | Name | Description |
|---|---|---|
| PageReference | pageLink | The root page for which the search will be performed |
| PropertyCriteriaCollection | criterias | The criterias for pages |
Returns
| Type | Description |
|---|---|
| RawPage[] | A collection of pages that fulfil the criteras, will be empty if no match is found. |
GetChildren(PageReference)
Gets the children for a specific page.
Declaration
public RawPage[] GetChildren(PageReference pageLink)Parameters
| Type | Name | Description |
|---|---|---|
| PageReference | pageLink | The page link. |
Returns
| Type | Description |
|---|---|
| RawPage[] |
GetDefaultPageData(PageReference, Int32)
Gets a default initialized RawPage according to given pagetype.
Declaration
public RawPage GetDefaultPageData(PageReference pageLink, int pageTypeID)Parameters
| Type | Name | Description |
|---|---|---|
| PageReference | pageLink | The parent page link. |
| System.Int32 | pageTypeID | The page type ID. |
Returns
| Type | Description |
|---|---|
| RawPage | An initilized RawPage |
GetLanguageBranches(PageReference)
Gets all the language branches for a specific page.
Declaration
public RawPage[] GetLanguageBranches(PageReference pageLink)Parameters
| Type | Name | Description |
|---|---|---|
| PageReference | pageLink | The page link to get language branches for. |
Returns
| Type | Description |
|---|---|
| RawPage[] | An array of all language branches. |
Remarks
No access check is performed.
GetPage(PageReference)
Gets the page in master language branch.
Declaration
public RawPage GetPage(PageReference pageLink)Parameters
| Type | Name | Description |
|---|---|---|
| PageReference | pageLink | The page link. |
Returns
| Type | Description |
|---|---|
| RawPage |
Move(PageReference, PageReference)
Move a page to another container.
Declaration
public void Move(PageReference pageLink, PageReference destinationLink)Parameters
| Type | Name | Description |
|---|---|---|
| PageReference | pageLink | The link to the page to move. |
| PageReference | destinationLink | The container to which the page will be moved. |
Ping()
Method to check that the web service is responding.
Declaration
public bool Ping()Returns
| Type | Description |
|---|---|
| System.Boolean |
Save(RawPage, SaveAction)
Saves the specified page to storage.
Declaration
public PageReference Save(RawPage page, SaveAction action)Parameters
| Type | Name | Description |
|---|---|---|
| RawPage | page | The page to save. |
| SaveAction | action | The action that will be performed during save. |
Returns
| Type | Description |
|---|---|
| PageReference |
ValidateWebServiceAccess()
Validates that the user has been granted access to web service.
Declaration
public static void ValidateWebServiceAccess()