Package erminas.SmartAPI.CMS.Project.Pages

Namespaces
package	Elements

Classes
class	AbstractPageSearchFilter
class	ContentClassExclusionFilter
class	ContentClassFilter
class	HeadlineAndContentFilter
class	HeadlineFilter
interface	IAssignedKeywords
interface	IExtendedPageSearch
	An extended page search more powerful than the normale PageSearch that can be refined by adding filters to it (e.g. on the page status). More...
interface	ILinkingAndAppearance
interface	ILinkTarget
interface	IPage
	Wrapper for the RedDot Page object. If status changes occur, you have to call PartialRedDotObject.Refresh to see them reflected in the status field, More...
interface	IPageCopyAndConnectJob
	Preliminary version of a page copy and connect job. Currently only RunAsync() is supported, so you have to check for its success yourself, if you need to. More...
interface	IPagePublishJob
interface	IPages
interface	IPageSearch
interface	IPageSearchFilter
interface	IStartPagesValue
class	Pages
class	PageStatusFilter
class	ReleaseInfo
class	Result
class	ResultGroup
class	SpecialPageFilter
class	WorkflowFilter
class	WorkflowInfo

Enumerations
enum	GroupBy { None = 0, ContentClass, CreatedBy, ChangedBy }
enum	OrderBy {   Headline = 0, PageId, CreationDate, ChangeDate,   ContentClass }
enum	PageCopyAndConnectFlags {   None = 0, AlsoCopyCompleteTree = 1, CopyElementContentsInsteadOfReferencing = 2, AdoptFileNames = 4,   AdoptPublicationSettingsOfLinkElements = 8, AdoptAuthorizationsOfLinkElements = 16, AdoptAuthorizationsOfOtherElements = 32, AdoptProjectVariantAssignments = 64,   AdoptTargetContainterReferenceFromNewlyCreatedContainer = 128 }
enum	PageFlags {   NotSet = 0, NotForBreadcrumb = 4, Workflow = 64, WaitingForTranslation = 1024,   Unlinked = 8192, WaitingForCorrection = 131072, Draft = 262144, Released = 524288,   BreadCrumbStaringPoint = 2097152, ContainsExternalReference = 8388608, OwnPageWaitingForRelease = 134217728, Locked = 268435456,   Null = -1 }
enum	PageReleaseStatus {   Draft = 65536, WorkFlow = 32768, Released = 4096, NotSet = 0,   Rejected = 16384 }
enum	PageState {   NotSet = 0, IsReleased = 1, WaitsForRelease = 2, WaitsForCorrection = 3,   SavedAsDraft = 4, NotAvailableInLanguage = 5, NeverHasBeenReleasedInOriginalLanguage = 6, IsInRecycleBin = 10,   WillBeArchived = 50, WillBeRemovedCompletely = 99 }
enum	PageType { All = 0, Released = 1, Unlinked = 8192, Draft = 262144 }
enum	PreviewHtmlType { Raw = 0, AddCmsBaseUrlToHeadSection }
enum	Replace { OnlyForThisPage, ForAllPagesOfContentClass }
enum	SortDirection { Ascending = 0, Descending }

Enumeration Type Documentation

enum erminas.SmartAPI.CMS.Project.Pages.GroupBy

Enumerator:

None
ContentClass
CreatedBy
ChangedBy

Definition at line 303 of file IExtendedPageSearch.cs.

enum erminas.SmartAPI.CMS.Project.Pages.OrderBy

Enumerator:

Headline
PageId
CreationDate
ChangeDate
ContentClass

Definition at line 294 of file IExtendedPageSearch.cs.

enum erminas.SmartAPI.CMS.Project.Pages.PageCopyAndConnectFlags

Enumerator:

None
AlsoCopyCompleteTree
CopyElementContentsInsteadOfReferencing
AdoptFileNames
AdoptPublicationSettingsOfLinkElements
AdoptAuthorizationsOfLinkElements
AdoptAuthorizationsOfOtherElements
AdoptProjectVariantAssignments
AdoptTargetContainterReferenceFromNewlyCreatedContainer

Definition at line 13 of file IPageCopyAndConnectJob.cs.

enum erminas.SmartAPI.CMS.Project.Pages.PageFlags

Enumerator:

NotSet
NotForBreadcrumb
Workflow
WaitingForTranslation
Unlinked
WaitingForCorrection
Draft
Released
BreadCrumbStaringPoint
ContainsExternalReference
OwnPageWaitingForRelease
Locked
Null

Definition at line 70 of file IPage.cs.

enum erminas.SmartAPI.CMS.Project.Pages.PageReleaseStatus

Enumerator:

Draft
WorkFlow
Released
NotSet
Rejected

Definition at line 60 of file IPage.cs.

enum erminas.SmartAPI.CMS.Project.Pages.PageState

Enumerator:

NotSet
IsReleased
WaitsForRelease
WaitsForCorrection
SavedAsDraft
NotAvailableInLanguage
NeverHasBeenReleasedInOriginalLanguage	From RQL docs: 6= Page has never been released in the selected language variant, in which it was created for the first time.
IsInRecycleBin
WillBeArchived
WillBeRemovedCompletely

Definition at line 41 of file IPage.cs.

enum erminas.SmartAPI.CMS.Project.Pages.PageType

Enumerator:

All
Released
Unlinked
Draft

Definition at line 27 of file IPage.cs.

enum erminas.SmartAPI.CMS.Project.Pages.PreviewHtmlType

Enumerator:

Raw
AddCmsBaseUrlToHeadSection

Definition at line 87 of file IPage.cs.

enum erminas.SmartAPI.CMS.Project.Pages.Replace

Enumerator:

OnlyForThisPage
ForAllPagesOfContentClass

Definition at line 35 of file IPage.cs.

enum erminas.SmartAPI.CMS.Project.Pages.SortDirection

Enumerator:

Ascending
Descending

Definition at line 288 of file IExtendedPageSearch.cs.