SynchronizationObjectSettings Class

Class encapsulating parameters for GeneralizedInfo serialization (export).

Inheritance Hierarchy

System.Object
  CMS.DataEngine.SynchronizationObjectSettings
    CMS.DataEngine.TraverseObjectSettings

Namespace: CMS.DataEngine
Assembly: CMS.DataEngine (in CMS.DataEngine.dll) Version: 13.0.131

Syntax

public class SynchronizationObjectSettings

The SynchronizationObjectSettings type exposes the following members.

Constructors

	Name	Description
Public method	SynchronizationObjectSettings

Properties

	Name	Description
Public property	Binary	If true, binary data is exported as well.
Public property	BindingDuplicities	Gets duplicities for object bindings
Public property	Columns	Gets or sets COLUMNS clause.
Public property	CreateHierarchy	If true, result will be hierarchical (children, bindings in lower level than parent etc.).
Public property	DisableCollectionPaging	If true, the traversal process sets AllowPaging to false to all the collections it goes through.
Public property	DocAliasPath	Path. It may contain % and _ as wild card characters for any number of unknown characters or one unknown character respectively (for MS SQL).
Public property	DocClassNames	List of classNames to select separated by semicolon (e.g.: "cms.article;cms.product").
Public property	DocCombineWithDefaultCulture	Specifies if return the default culture document when specified culture not found.
Public property	DocConnectedObjects	Gets or sets the list of collections from ConnectedObjects collection which will go into the result.
Public property	DocCoupledData	If false, coupled data are not included in the result.
Public property	DocCultureCode	Nodes culture code.
Public property	DocDeleteAllCultures	If true, all cultures are deleted when document is being deleted.
Public property	DocDestroyHistory	If true, the history is deleted when the document is being deleted.
Public property	DocLinkedDocuments	If true, linked documents are included in the result.
Public property	DocSelectOnlyPublished	Select only published nodes.
Public property	DocSingleDocument	If true, only single document is selected
Public property	DocSiteName	Nodes site name.
Public property	DocVersion	Version of the document to return.
Public property	EnsureBinaryData	If true, all the collections are forced to load binary data.
Public property	ExportItemURI	Gets or sets URI of the exported item (needed for ODATA export).
Public property	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.)
Public property	IncludeBindings	If true, binding objects are included in the result.
Public property	IncludeCategories	If true, parent category hierarchy of the object is included in the result as well.
Public property	IncludeChildren	If true, child objects are included in the result.
Public property	IncludeMetafiles	If true, metafiles of the object are included in the result as well.
Public property	IncludeObjectData	If false, object data are not exported (true by default).
Public property	IncludeOtherBindings	If true, other binding objects are included in the result.
Public property	IncludeProcesses	If true, automation processes of the object are included in the result as well.
Public property	IncludeRelationships	If true, relationships of the object are included in the result as well.
Public property	IncludeScheduledTasks	If true, scheduled tasks of the object are included in the result as well.
Public property	IncludeSiteBindings	If true, site binding objects are included in the result. This setting is applied only when IncludeBindings is true.
Public property	IncludeTranslations	If true, translation table is exported within the result as well.
Public property	JSONCallback	Gets or sets the callback JS code used a JSONP.
Public property	MaxRecords	Gets or sets maximum number of records.
Public property	MaxRelativeLevel	Determines maximal level of the relationship (parent-child). -1 means all levels, 0 means no child objects, 1 means first level of children, etc.
Public property	Offset	Gets or sets offset of the records.
Public property	Operation	Operation type (Export / Synchronization / etc.). According to this parameter export determines which child / binding objects to include in the export.
Public property	OrderBy	Gets or sets ORDER BY clause.
Public property	ProcessIDCallback	Method which is called to process any FK ID.
Public property	ProcessTranslations	If true, translation table is filled within ProcessTranslations method.
Public property	RequestStockKey	Returns key for request stock helper caching.
Public property	RootName	Name of the root element of the resulting export (root of xml).
Public property	TopN	Gets or sets TOP N clause.
Public property	TranslationHelper	Translation helper to pass to the callback methods.
Public property	WhereCondition	Where condition.