public interface PageResource extends AuthenticatedResource
Modifier and Type | Method and Description |
---|---|
String |
autocomplete(String q,
int limit)
Do a quick search for pages that contain the given query string in their name or have it as ID.
|
GenericResponse |
cancel(Integer id,
Integer nodeId)
Cancel editing the page.
|
PageCopyResponse |
copy(PageCopyRequest request,
long waitMs)
Copy a batch of pages or a single copy using the
PageCopyRequest options. |
PageLoadResponse |
create(PageCreateRequest request)
Create a page based on the given pagecreaterequest
|
TagCreateResponse |
createTag(String id,
Integer constructId,
String keyword,
ContentTagCreateRequest request)
Create a new tag in the given page
|
GenericResponse |
delete(String id,
Integer nodeId)
Delete the page denoted by id.
|
MultiDisinheritResponse |
disinherit(List<String> ids,
Integer nodeId)
Get the multichannelling exclusion and disinherit status for a list of pages
|
GenericResponse |
disinherit(List<String> ids,
Integer nodeId,
DisinheritRequest request)
Set the multichannelling exclusion and disinherit status for a list of pages
|
DisinheritResponse |
disinherit(String id,
Integer nodeId)
Get the multichannelling exclusion and disinherit status of the page
|
GenericResponse |
disinherit(String id,
Integer nodeId,
DisinheritRequest request)
Set the multichannelling exclusion and disinherit status
|
LocalizationInfo |
getLocalizationInfo(Integer id,
Integer nodeId)
Get localization info for a page for a given channel and all master channels
|
LocalizationInfo |
getLocalizationInfo(List<Integer> ids,
Integer nodeId)
Get localization info for a list of pages for a given channel and all master channels
|
PageUsageListResponse |
getPagetagUsageInfo(Integer skipCount,
Integer maxItems,
String sortBy,
String sortOrder,
List<Integer> pageId,
Integer nodeId,
boolean returnPages,
boolean template,
boolean folder,
boolean languageVariants)
Get the pages containing pagetags pointing to one of the given pages
|
PageUsageListResponse |
getPageUsageInfo(Integer skipCount,
Integer maxItems,
String sortBy,
String sortOrder,
List<Integer> pageId,
Integer nodeId,
boolean returnPages,
boolean template,
boolean folder,
boolean languageVariants)
Get the pages using one of the given pages
|
PrivilegesResponse |
getPrivileges(Integer id)
Get the privileges of the current user on the given page
|
TagListResponse |
getTags(Integer id,
Integer skipCount,
Integer maxItems,
TagSortAttribute sortBy,
SortOrder sortOrder,
String search)
Get the list of tags (contenttags and templatetags) for this page
|
TemplateUsageListResponse |
getTemplateUsageInfo(Integer skipCount,
Integer maxItems,
String sortBy,
String sortOrder,
List<Integer> pageId,
Integer nodeId,
boolean returnTemplates)
Get the templates using one of the given pages
|
PageUsageListResponse |
getVariantsUsageInfo(Integer skipCount,
Integer maxItems,
String sortBy,
String sortOrder,
List<Integer> pageId,
Integer nodeId,
boolean returnPages,
boolean template,
boolean folder,
boolean languageVariants)
Get the page variants of the given pages
|
PageLoadResponse |
load(String id,
boolean update,
boolean template,
boolean folder,
boolean languageVariants,
boolean pageVariants,
boolean workflow,
boolean translationStatus,
boolean versionInfo,
boolean disinherited,
Integer nodeId)
Loads a page from GCN.
|
GenericResponse |
localize(Integer id,
LocalizeRequest request)
Localize the given page
|
GenericResponse |
move(MultiObjectMoveRequest request)
Move multiple pages to another folder
|
GenericResponse |
move(String id,
ObjectMoveRequest request)
Move the given page to another folder
|
PagePreviewResponse |
preview(PagePreviewRequest request)
Render given page in a preview (before actually saving it)
|
GenericResponse |
publish(Integer nodeId,
MultiPagePublishRequest request)
Publish a list of pages.
|
GenericResponse |
publish(String id,
Integer nodeId,
PagePublishRequest request)
Publish the page denoted by id (or send it in the queue when the User has not permission to publish the page).
|
GenericResponse |
pushToMaster(Integer id,
PushToMasterRequest request)
Push a page from a channel into a master
|
GenericResponse |
pushToMaster(MultiPushToMasterRequest request)
Push a list of pages from a channel into a master
|
PageRenderResponse |
render(String id,
Integer nodeId,
String template,
boolean editMode,
String proxyprefix,
LinksType linksType,
boolean tagmap,
boolean inherited)
Render the given page
Info: This currently doesn't return tag render errors.
|
TagListResponse |
restoreTag(String pageId,
String tag,
Integer versionTimestamp)
Restore a single tag in the page with the given version timestamp
|
PageLoadResponse |
restoreVersion(String id,
Integer versionTimestamp)
Restore the page version with the given version timestamp
|
GenericResponse |
save(String id,
PageSaveRequest request)
Saves a page into GCN
|
GenericResponse |
takeOffline(String id)
Take a specific page offline
|
PageLoadResponse |
translate(Integer id,
String languageCode,
boolean locked,
Integer channelId)
Translate the page into the given language.
|
GenericResponse |
unlocalize(Integer id,
UnlocalizeRequest request)
Unlocalize the given page
|
GenericResponse |
unlocalize(MultiUnlocalizeRequest request)
Unlocalize pages in a channel
|
GenericResponse |
workflowDecline(String id,
WorkflowRequest request)
Decline the workflow for the page (i.e.
|
GenericResponse |
workflowRevoke(Integer id)
Revoke the last step of the workflow
|
setSessionId
PageLoadResponse create(PageCreateRequest request)
request
- containing data for creating the pagePageCopyResponse copy(PageCopyRequest request, long waitMs) throws Exception
PageCopyRequest
options.request
- Request containing data for the batch copywaitMs
- wait timeout in millisecondsException
GenericResponse move(String id, ObjectMoveRequest request)
id
- page idrequest
- requestGenericResponse move(MultiObjectMoveRequest request)
request
- requestGenericResponse save(String id, PageSaveRequest request)
id
- Id of the page to save. This can either be a local or global idrequest
- page save requestPageLoadResponse load(String id, boolean update, boolean template, boolean folder, boolean languageVariants, boolean pageVariants, boolean workflow, boolean translationStatus, boolean versionInfo, boolean disinherited, Integer nodeId)
id
- The id of the page to load. This can either be a localid or a globalidupdate
- true when the page shall be locked, false if nottemplate
- true if the template information shall be addedfolder
- true if the folder information shall be addedlanguageVariants
- true if the language variants shall be addedworkflow
- true if the workflow information shall be addedtranslationStatus
- true if the translationstatus information shall be addedversionInfo
- true if version information shall be addeddisinherited
- if true, disinherited channel nodes shall be addednodeId
- channel idPagePreviewResponse preview(PagePreviewRequest request)
NodeException
GenericResponse publish(Integer nodeId, MultiPagePublishRequest request)
nodeId
- channel idrequest
- publish requestGenericResponse publish(String id, Integer nodeId, PagePublishRequest request)
id
- id of the Page to publish. This can either be a local or globalidnodeId
- channel idrequest
- publish page requestGenericResponse delete(String id, Integer nodeId)
id
- id of the Page to delete. This can either be a local or global idnodeId
- channel idGenericResponse cancel(Integer id, Integer nodeId)
id
- id of the Page which is currently editednodeId
- channel idPageRenderResponse render(String id, Integer nodeId, String template, boolean editMode, String proxyprefix, LinksType linksType, boolean tagmap, boolean inherited)
id
- id of the pagenodeId
- node id (if rendering a page for a channel)template
- template to render (if not set, the page's template will be rendered)editMode
- true for rendering in edit mode, false for preview modeproxyprefix
- proxyprefixlinksType
- type of links (frontend or backend)tagmap
- true to also render the tagmap entriesinherited
- true to render the inherited content and propertiesTagListResponse getTags(Integer id, Integer skipCount, Integer maxItems, TagSortAttribute sortBy, SortOrder sortOrder, String search)
id
- id of the pagePrivilegesResponse getPrivileges(Integer id)
id
- id of the pageTagCreateResponse createTag(String id, Integer constructId, String keyword, ContentTagCreateRequest request)
id
- id of the page. This can either be a local or globalidconstructId
- id of the tags constructkeyword
- keyword of the constructrequest
- tag create requestPageLoadResponse restoreVersion(String id, Integer versionTimestamp)
id
- The id of the page that should be restored. This can either be a local or globalidversionTimestamp
- version timestampTagListResponse restoreTag(String pageId, String tag, Integer versionTimestamp)
pageId
- id of the page. This can either be a local or globalidtag
- id or name of the tagversionTimestamp
- version timestampPageLoadResponse translate(Integer id, String languageCode, boolean locked, Integer channelId)
id
- id of the page to translatelanguageCode
- code of the language into which the page shall be translatedlocked
- true if the translation shall be locked, false if notchannelId
- for multichannelling, specify channel in which to create page (can be 0 or equal to node ID to be ignored)GenericResponse workflowRevoke(Integer id)
id
- id of the pageGenericResponse workflowDecline(String id, WorkflowRequest request)
id
- id of the page. This can either be a local or globalidrequest
- request object containing what should be changed about the workflowPageUsageListResponse getPagetagUsageInfo(Integer skipCount, Integer maxItems, String sortBy, String sortOrder, List<Integer> pageId, Integer nodeId, boolean returnPages, boolean template, boolean folder, boolean languageVariants)
skipCount
- number of items to be skipped, set to 0 for skipping no itemsmaxItems
- maximum number of items to be returned, set to -1 for
returning all itemssortby
- (optional) attribute to sort by. defaults to namesortorder
- (optional) result sort order - may be "asc" for ascending or
"desc" for descending other strings will be ignored. defaults
to "asc".pageId
- list of page idsnodeId
- id of the nodereturnPages
- true (default) if the pages shall be returned, false for only returning the countstemplate
- true for adding template info to the pages, default is falsefolder
- true for adding folder info to the pages, default is falselanguageVariants
- true for adding the language variants to the pages, default is falsePageUsageListResponse getVariantsUsageInfo(Integer skipCount, Integer maxItems, String sortBy, String sortOrder, List<Integer> pageId, Integer nodeId, boolean returnPages, boolean template, boolean folder, boolean languageVariants)
skipCount
- number of items to be skipped, set to 0 for skipping no itemsmaxItems
- maximum number of items to be returned, set to -1 for
returning all itemssortby
- (optional) attribute to sort by. defaults to namesortorder
- (optional) result sort order - may be "asc" for ascending or
"desc" for descending other strings will be ignored. defaults
to "asc".pageId
- list of page idsnodeId
- id of the nodereturnPages
- true (default) if the pages shall be returned, false for only returning the countstemplate
- true for adding template info to the pages, default is falsefolder
- true for adding folder info to the pages, default is falselanguageVariants
- true for adding the language variants to the pages, default is falsePageUsageListResponse getPageUsageInfo(Integer skipCount, Integer maxItems, String sortBy, String sortOrder, List<Integer> pageId, Integer nodeId, boolean returnPages, boolean template, boolean folder, boolean languageVariants)
skipCount
- number of items to be skipped, set to 0 for skipping no itemsmaxItems
- maximum number of items to be returned, set to -1 for
returning all itemssortby
- (optional) attribute to sort by. defaults to namesortorder
- (optional) result sort order - may be "asc" for ascending or
"desc" for descending other strings will be ignored. defaults
to "asc".pageId
- list of page ids, for which the usage shall be fetchednodeId
- id of the nodereturnPages
- true (default) if the pages shall be returned, false for only returning the countstemplate
- true for adding template info to the pages, default is falsefolder
- true for adding folder info to the pages, default is falselanguageVariants
- true for adding the language variants to the pages, default is falseTemplateUsageListResponse getTemplateUsageInfo(Integer skipCount, Integer maxItems, String sortBy, String sortOrder, List<Integer> pageId, Integer nodeId, boolean returnTemplates)
skipCount
- number of items to be skipped, set to 0 for skipping no itemsmaxItems
- maximum number of items to be returned, set to -1 for
returning all itemssortby
- (optional) attribute to sort by. defaults to namesortorder
- (optional) result sort order - may be "asc" for ascending or
"desc" for descending other strings will be ignored. defaults
to "asc".pageId
- list of page ids, for which the usage shall be fetchednodeId
- id of the nodereturnTemplates
- true (default) if the templates shall be returned, false for only returning the countsGenericResponse pushToMaster(Integer id, PushToMasterRequest request)
id
- id of the pagerequest
- requestGenericResponse pushToMaster(MultiPushToMasterRequest request)
request
- requestGenericResponse unlocalize(Integer id, UnlocalizeRequest request)
id
- id of the page to unlocalizerequest
- requestGenericResponse unlocalize(MultiUnlocalizeRequest request)
request
- requestGenericResponse localize(Integer id, LocalizeRequest request)
id
- id of the page to localizerequest
- requestLocalizationInfo getLocalizationInfo(List<Integer> ids, Integer nodeId)
ids
- list of page idsnodeId
- id of the node to start withLocalizationInfo getLocalizationInfo(Integer id, Integer nodeId)
id
- id of the pagenodeId
- id of the node to start withGenericResponse takeOffline(String id)
id
- ID of the pageString autocomplete(String q, int limit)
q
- query string, must contain at least three characters (otherwise an empty result is returned).limit
- maximum number of results returned. Default is 15DisinheritResponse disinherit(String id, Integer nodeId) throws Exception
id
- page IDnodeId
- node IDException
GenericResponse disinherit(String id, Integer nodeId, DisinheritRequest request) throws Exception
id
- page IDnodeId
- node IDrequest
- request objectException
MultiDisinheritResponse disinherit(List<String> ids, Integer nodeId) throws Exception
ids
- list of page IDsnodeId
- node IDException
GenericResponse disinherit(List<String> ids, Integer nodeId, DisinheritRequest request) throws Exception
ids
- list of page IDsnodeId
- node IDrequest
- request objectException
Copyright © 2015 Gentics Software GmbH. All rights reserved.