ExportObjectSettings Properties |
The ExportObjectSettings type exposes the following members.
Name | Description | |
---|---|---|
![]() | Binary |
If true, binary data is exported as well.
|
![]() | BindingDuplicities |
Gets duplicities for object bindings
(Inherited from TraverseObjectSettings.) |
![]() | Columns |
Gets or sets COLUMNS clause.
|
![]() | CreateHierarchy |
If true, result will be hierarchical (children, bindings in lower level than parent etc.).
(Inherited from TraverseObjectSettings.) |
![]() | DisableCollectionPaging |
If true, the traversal process sets AllowPaging to false to all the collections it goes through.
(Inherited from TraverseObjectSettings.) |
![]() | DocAliasPath |
Path. It may contain % and _ as wild card characters for any number of unknown characters or one unknown character respectively (for MS SQL).
|
![]() | DocClassNames |
List of classNames to select separated by semicolon (e.g.: "cms.article;cms.product").
|
![]() | DocCombineWithDefaultCulture |
Specifies if return the default culture document when specified culture not found.
|
![]() | DocConnectedObjects |
Gets or sets the list of collections from ConnectedObjects collection which will go into the result.
(Inherited from TraverseObjectSettings.) |
![]() | DocCoupledData |
If false, coupled data are not included in the result.
|
![]() | DocCultureCode |
Nodes culture code.
|
![]() | DocDeleteAllCultures |
If true, all cultures are deleted when document is being deleted.
|
![]() | DocDeleteProduct | Obsolete.
If true, the associated product is deleted with the deleted page.
|
![]() | DocDestroyHistory |
If true, the history is deleted when the document is being deleted.
|
![]() | DocLinkedDocuments |
If true, linked documents are included in the result.
(Inherited from TraverseObjectSettings.) |
![]() | DocSelectOnlyPublished |
Select only published nodes.
|
![]() | DocSingleDocument |
If true, only single document is selected
|
![]() | DocSiteName |
Nodes site name.
|
![]() | DocVersion |
Version of the document to return.
|
![]() | Encoding |
Gets or sets the encoding used for REST responses.
|
![]() | EnsureBinaryData |
If true, all the collections are forced to load binary data.
(Inherited from TraverseObjectSettings.) |
![]() | ExcludedNames |
Objects with codename or display name starting with these names will be filtered out.
(Inherited from TraverseObjectSettings.) |
![]() | ExportItemURI |
Gets or sets URI of the exported item (needed for ODATA export).
|
![]() | Format |
Format of the export data (xml/json/etc.).
|
![]() | FormatResult |
If true, result is formatted for better readability.
|
![]() | HandleBoundObjects |
If false, all bound objects (such as children or all types of bindings) are not being handled.
If true, handling of these objects is determined by more specific settings (such as IncludeChildren, IncludeBindings, etc.)
(Inherited from TraverseObjectSettings.) |
![]() | IncludeBindings |
If true, binding objects are included in the result.
(Inherited from TraverseObjectSettings.) |
![]() | IncludeCategories |
If true, parent category hierarchy of the object is included in the result as well.
(Inherited from TraverseObjectSettings.) |
![]() | IncludeChildren |
If true, child objects are included in the result.
(Inherited from TraverseObjectSettings.) |
![]() | IncludeMetadata |
If true, metadata are included in the result as well.
|
![]() | IncludeMetafiles |
If true, metafiles of the object are included in the result as well.
(Inherited from TraverseObjectSettings.) |
![]() | IncludeObjectData |
If false, object data are not exported (true by default).
|
![]() | IncludeOtherBindings |
If true, other binding objects are included in the result.
(Inherited from TraverseObjectSettings.) |
![]() | IncludeProcesses |
If true, automation processes of the object are included in the result as well.
(Inherited from TraverseObjectSettings.) |
![]() | IncludeRelationships |
If true, relationships of the object are included in the result as well.
(Inherited from TraverseObjectSettings.) |
![]() | IncludeScheduledTasks |
If true, scheduled tasks of the object are included in the result as well.
(Inherited from TraverseObjectSettings.) |
![]() | IncludeSiteBindings |
If true, site binding objects are included in the result. This setting is applied only when IncludeBindings is true.
(Inherited from TraverseObjectSettings.) |
![]() | IncludeTranslations |
If true, translation table is exported within the result as well.
(Inherited from TraverseObjectSettings.) |
![]() | JSONCallback |
Gets or sets the callback JS code used a JSONP.
|
![]() | LocalizeToLanguage |
Culture code of the language to which the resulting response will be localized (if there are any localization macros - for example as a display name of the object).
Null or empty string mean no localization is done to the response.
|
![]() | MaxRecords |
Gets or sets maximum number of records.
|
![]() | MaxRelativeLevel |
Determines maximal level of the relationship (prent-child). -1 means all levels, 0 means no child objects, 1 means first level of children, etc.
(Inherited from TraverseObjectSettings.) |
![]() | Offset |
Gets or sets offset of the records.
|
![]() | Operation |
Operation type (Export / Synchronization / etc.). According to this parameter export determines which child / binding objects to include in the export.
(Inherited from TraverseObjectSettings.) |
![]() | OrderBy |
Gets or sets ORDER BY clause.
|
![]() | Parameter |
Custom object passed as a parameter to export settings.
(Inherited from TraverseObjectSettings.) |
![]() | ProcessArraySeparatorCallback |
Method which is called when a separator should be added to a result (needed for JSON).
(Inherited from TraverseObjectSettings.) |
![]() | ProcessEndCollectionCallback |
Method which is called when a level in hierarchy is finished (end of the collection).
(Inherited from TraverseObjectSettings.) |
![]() | ProcessIDCallback |
Method which is called to process any FK ID.
(Inherited from TraverseObjectSettings.) |
![]() | ProcessItemCallback |
Method which is called to process an item within collection.
(Inherited from TraverseObjectSettings.) |
![]() | ProcessObjectCallback |
Method which is called to process info object.
(Inherited from TraverseObjectSettings.) |
![]() | ProcessStartCollectionCallback |
Method which is called when new level in hierarchy is created.
(Inherited from TraverseObjectSettings.) |
![]() | ProcessTranslations |
If true, translation table is filled within ProcessTranslations metod.
(Inherited from TraverseObjectSettings.) |
![]() | RequestStockKey |
Returns key for request stock helper caching.
(Overrides TraverseObjectSettingsRequestStockKey.) |
![]() | RootName |
Name of the root element of the resulting export (root of xml).
|
![]() | TopN |
Gets or sets TOP N clause.
|
![]() | Translate |
If true, REST request was for translation.
|
![]() | TranslationHelper |
Translation helper to pass to the callback methods.
(Inherited from TraverseObjectSettings.) |
![]() | Where | Obsolete.
Where condition.
|
![]() | WhereCondition |
Where condition.
|