CMS.Synchronization.xml
|
<?xml version="1.0"?>
<doc> <assembly> <name>CMS.Synchronization</name> </assembly> <members> <member name="T:CMS.Synchronization.StagingChildProcessingTypeEventArgs"> <summary> Event arguments for getting object synchronization processing type </summary> </member> <member name="P:CMS.Synchronization.StagingChildProcessingTypeEventArgs.ProcessingType"> <summary> Indicates how object should be processed </summary> </member> <member name="P:CMS.Synchronization.StagingChildProcessingTypeEventArgs.ObjectType"> <summary> Currently processed object type </summary> </member> <member name="P:CMS.Synchronization.StagingChildProcessingTypeEventArgs.ParentObjectType"> <summary> Object type of parent object of the processed object </summary> </member> <member name="T:CMS.Synchronization.StagingChildProcessingTypeHandler"> <summary> Handler used to override default processing type for child object type when creating/updating object via staging </summary> </member> <member name="T:CMS.Synchronization.ISyncClient"> <summary> Interface for SyncClient </summary> </member> <member name="P:CMS.Synchronization.ISyncClient.Server"> <summary> Synchronization server. </summary> </member> <member name="M:CMS.Synchronization.ISyncClient.RunTask(CMS.Synchronization.StagingTaskInfo)"> <summary> Runs the synchronization task. </summary> <param name="taskObj">Task object</param> <returns>Returns error message</returns> </member> <member name="T:CMS.Synchronization.IntegrationTaskEventArgs"> <summary> Integration task event arguments </summary> </member> <member name="P:CMS.Synchronization.IntegrationTaskEventArgs.Task"> <summary> Integration task </summary> </member> <member name="P:CMS.Synchronization.IntegrationTaskEventArgs.Object"> <summary> Task object </summary> </member> <member name="T:CMS.Synchronization.IntegrationTaskHandler"> <summary> Integration task handler </summary> </member> <member name="M:CMS.Synchronization.IntegrationTaskHandler.StartEvent(CMS.Synchronization.IntegrationTaskInfo,CMS.DataEngine.BaseInfo)"> <summary> Initiates the event handling </summary> <param name="task">Task object</param> <param name="infoObj">Task object</param> </member> <member name="T:CMS.Synchronization.StagingEvents"> <summary> Staging events </summary> </member> <member name="F:CMS.Synchronization.StagingEvents.LogTask"> <summary> Fires on the source server when the staging logs the task </summary> </member> <member name="F:CMS.Synchronization.StagingEvents.Synchronize"> <summary> Fires on the source server when the staging synchronizes task or a bulk of tasks to the server </summary> </member> <member name="F:CMS.Synchronization.StagingEvents.SynchronizeTask"> <summary> Fires on the source server when the staging synchronizes task to a server </summary> </member> <member name="F:CMS.Synchronization.StagingEvents.ProcessTask"> <summary> Fires on the target server when the staging processes task </summary> </member> <member name="F:CMS.Synchronization.StagingEvents.GetChildProcessingType"> <summary> Fires on the target server when the staging updates child objects of created/update main object for each processed child object type </summary> </member> <member name="T:CMS.Synchronization.StagingLogTaskHandler"> <summary> Staging handler </summary> </member> <member name="M:CMS.Synchronization.StagingLogTaskHandler.StartEvent(CMS.Synchronization.StagingTaskInfo,CMS.DataEngine.BaseInfo)"> <summary> Initiates the event handling </summary> <param name="task">Task object</param> <param name="infoObj">Info object</param> </member> <member name="T:CMS.Synchronization.StagingLogTaskEventArgs"> <summary> Staging event arguments </summary> </member> <member name="P:CMS.Synchronization.StagingLogTaskEventArgs.Object"> <summary> Task object </summary> </member> <member name="T:CMS.Synchronization.StagingTaskEventArgs"> <summary> Event arguments for the staging task event </summary> </member> <member name="P:CMS.Synchronization.StagingTaskEventArgs.Task"> <summary> Synchronization task </summary> </member> <member name="T:CMS.Synchronization.StagingTaskHandler"> <summary> Staging handler </summary> </member> <member name="M:CMS.Synchronization.StagingTaskHandler.StartEvent(CMS.Synchronization.StagingTaskInfo)"> <summary> Initiates the event handling </summary> <param name="task">Task object</param> </member> <member name="T:CMS.Synchronization.IntegrationEvents"> <summary> Integration events </summary> </member> <member name="F:CMS.Synchronization.IntegrationEvents.LogInternalTask"> <summary> Fires on the server when the integration bus logs the task </summary> </member> <member name="F:CMS.Synchronization.IntegrationEvents.LogExternalTask"> <summary> Fires on the server when the integration bus logs the external task </summary> </member> <member name="T:CMS.Synchronization.StagingSynchronizationEventArgs"> <summary> Synchronization event arguments </summary> </member> <member name="P:CMS.Synchronization.StagingSynchronizationEventArgs.TaskType"> <summary> Task type </summary> </member> <member name="P:CMS.Synchronization.StagingSynchronizationEventArgs.ObjectType"> <summary> Object type </summary> </member> <member name="P:CMS.Synchronization.StagingSynchronizationEventArgs.TaskData"> <summary> Task data </summary> </member> <member name="P:CMS.Synchronization.StagingSynchronizationEventArgs.TaskBinaryData"> <summary> Task binary data </summary> </member> <member name="P:CMS.Synchronization.StagingSynchronizationEventArgs.TaskHandled"> <summary> Indicates if current task was handled by event handler. </summary> </member> <member name="P:CMS.Synchronization.StagingSynchronizationEventArgs.SyncManager"> <summary> SyncManager instance. </summary> </member> <member name="T:CMS.Synchronization.StagingSynchronizationHandler"> <summary> Staging handler </summary> </member> <member name="M:CMS.Synchronization.StagingSynchronizationHandler.StartEvent(CMS.DataEngine.TaskTypeEnum,System.String,System.Data.DataSet,System.Data.DataSet,CMS.Synchronization.ISyncManager)"> <summary> Initiates the event handling </summary> <param name="taskType">Task type</param> <param name="objectType">Object type</param> <param name="taskData">Task data</param> <param name="taskBinaryData">Task binary data</param> <param name="syncManager">Instance of SyncManager</param> </member> <member name="T:CMS.Synchronization.ISyncManager"> <summary> Interface for SyncManager </summary> </member> <member name="P:CMS.Synchronization.ISyncManager.LogTasks"> <summary> Indicates if logging staging tasks is enabled. </summary> </member> <member name="P:CMS.Synchronization.ISyncManager.SiteName"> <summary> Gets or sets current site name. </summary> </member> <member name="P:CMS.Synchronization.ISyncManager.SiteID"> <summary> Gets site ID. </summary> </member> <member name="M:CMS.Synchronization.ISyncManager.ProceedWithTranslations(CMS.DataEngine.TranslationHelper)"> <summary> Determines whether to continue with translation operations. </summary> <param name="th">Current translation helper object</param> <returns>TRUE if OperationType is other than Integration. When OperationType is Integration there also have to be some translations present.</returns> </member> <member name="T:CMS.Synchronization.StagingUsageDataSource"> <summary> Module usage tracking data source for staging. </summary> </member> <member name="P:CMS.Synchronization.StagingUsageDataSource.Name"> <summary> Staging data source name. </summary> </member> <member name="M:CMS.Synchronization.StagingUsageDataSource.GetData"> <summary> Get module usage data. </summary> </member> <member name="T:CMS.Synchronization.VersioningUsageDataSource"> <summary> Module usage tracking data source for staging. </summary> </member> <member name="P:CMS.Synchronization.VersioningUsageDataSource.Name"> <summary> Staging data source name. </summary> </member> <member name="M:CMS.Synchronization.VersioningUsageDataSource.GetData"> <summary> Get module usage data. </summary> </member> <member name="T:CMS.Synchronization.Synchronization"> <summary> Synchronization actions </summary> </member> <member name="M:CMS.Synchronization.Synchronization.Init"> <summary> Initializes the actions for synchronization </summary> </member> <member name="M:CMS.Synchronization.Synchronization.GetUserId(CMS.DataEngine.AbstractSynchronizationSettings)"> <summary> Returns user id obtained from settings or from <see cref="T:CMS.Base.CMSActionContext"/> when settings does not have assigned user </summary> </member> <member name="T:CMS.Synchronization.VersioningHandlers"> <summary> Handlers that trim object version history if the limit settings are changed. </summary> </member> <member name="M:CMS.Synchronization.VersioningHandlers.DeleteOlderVersions(System.String,System.Int32)"> <summary> Deletes excessive old object versions from site specified by given <paramref name="siteId"/> or global and all sites that inherit the global setting if the <paramref name="siteId"/> is 0 or less. </summary> <param name="settingsKeyName">Settings key that may be overridden on sites.</param> <param name="siteId">Settings key site ID</param> </member> <member name="T:CMS.Synchronization.ObjectQueryRelationshipExtensions"> <summary> Object query extension methods for getting data related to the query. </summary> </member> <member name="M:CMS.Synchronization.ObjectQueryRelationshipExtensions.GetChildren(CMS.DataEngine.IObjectQuery,System.String)"> <summary> Gets the query for all children of the given type of the objects that the query represents </summary> <param name="objectType">Nested object type</param> <param name="query">Query</param> </member> <member name="M:CMS.Synchronization.ObjectQueryRelationshipExtensions.GetBindings(CMS.DataEngine.IObjectQuery,System.String)"> <summary> Gets the query for all children of the given type of the objects that the query represents </summary> <param name="objectType">Nested object type</param> <param name="query">Query</param> </member> <member name="M:CMS.Synchronization.ObjectQueryRelationshipExtensions.GetOtherBindings(CMS.DataEngine.IObjectQuery,System.String)"> <summary> Gets the query for all other bindings of the given type of the objects that the query represents </summary> <param name="objectType">Nested object type</param> <param name="query">Query</param> </member> <member name="M:CMS.Synchronization.ObjectQueryRelationshipExtensions.GetNested(CMS.DataEngine.IObjectQuery,System.String)"> <summary> Gets the query for all nested objects of the given type of the objects that the query represents </summary> <param name="objectType">Nested object type</param> <param name="query">Query</param> </member> <member name="M:CMS.Synchronization.ObjectQueryRelationshipExtensions.GetRelatedObjects(CMS.DataEngine.IObjectQuery,System.String,System.String)"> <summary> Gets the query for all related objects of the given type of the objects that the query represents, referenced by the given column name </summary> <param name="objectType">Object type</param> <param name="columnName">Column name with the foreign key that points to the related objects</param> <param name="query">Query</param> </member> <member name="M:CMS.Synchronization.ObjectQueryRelationshipExtensions.GetMetaFiles(CMS.DataEngine.IObjectQuery)"> <summary> Gets the query for all metafiles of the objects that the query represents </summary> <param name="query">Query</param> </member> <member name="M:CMS.Synchronization.ObjectQueryRelationshipExtensions.GetScheduledTasks(CMS.DataEngine.IObjectQuery)"> <summary> Gets the query for all scheduled tasks of the objects that the query represents </summary> <param name="query">Query</param> </member> <member name="M:CMS.Synchronization.ObjectQueryRelationshipExtensions.GetProcesses(CMS.DataEngine.IObjectQuery)"> <summary> Gets the query for all processes of the objects that the query represents </summary> <param name="query">Query</param> </member> <member name="M:CMS.Synchronization.ObjectQueryRelationshipExtensions.GetIdColumn(CMS.DataEngine.ObjectTypeInfo,System.String)"> <summary> Gets ID column of the given type from the given type info </summary> <param name="ti">Type info</param> <param name="idColumnType">ID column type</param> </member> <member name="T:CMS.Synchronization.ObjectXmlHelper"> <summary> Provides methods for providing object hierarchy XML </summary> </member> <member name="M:CMS.Synchronization.ObjectXmlHelper.ExecuteWithEmptyXMLCacheForObject(CMS.DataEngine.BaseInfo,System.Action)"> <summary> Executes the given action using with emptied XML cache for the given object but allowing caching of ObjectXmlHelper data during the action. </summary> <param name="infoObj">Info object</param> <param name="action">Action to execute</param> </member> <member name="M:CMS.Synchronization.ObjectXmlHelper.GetObjectXmlCacheKey(CMS.DataEngine.GeneralizedInfo)"> <summary> Gets a cache key for the object XML </summary> <param name="infoObj">Info object</param> </member> <member name="M:CMS.Synchronization.ObjectXmlHelper.GetObjectXml(CMS.DataEngine.SynchronizationObjectSettings,CMS.DataEngine.BaseInfo)"> <summary> Returns XML representation of given instance of info object. Caches the object XML for the given settings in current thread/request. Use <see cref="M:CMS.Helpers.AbstractStockHelper`1.ExecuteWithEmptyStorage(System.Action,System.String,System.Boolean)" /> wrapper to execute a block of code with its own cache. </summary> <param name="settings">Export settings</param> <param name="infoObj">Info object to export</param> <returns>XML representation of given instance of info object.</returns> </member> <member name="M:CMS.Synchronization.ObjectXmlHelper.GetObjectXmlInternal(CMS.DataEngine.SynchronizationObjectSettings,CMS.DataEngine.GeneralizedInfo)"> <summary> Gets the object XML based on the given settings </summary> <param name="settings">Settings</param> <param name="infoObj">Info object</param> </member> <member name="M:CMS.Synchronization.ObjectXmlHelper.CacheObjectXml(CMS.DataEngine.SynchronizationObjectSettings,System.String,System.String,System.String)"> <summary> Puts the result of the export to the cache (including TranslationHelper if present). </summary> <param name="settings">Export settings object</param> <param name="export">Exported data</param> <param name="storageKey">Storage key</param> <param name="key">Cache key</param> </member> <member name="M:CMS.Synchronization.ObjectXmlHelper.GetObjectXmlFromCache(CMS.DataEngine.SynchronizationObjectSettings,System.String,System.String)"> <summary> Tries find exported data and TranslationHelper in cache. </summary> <param name="settings">Export settings object</param> <param name="storageKey">Storage key</param> <param name="key">Cache key</param> </member> <member name="T:CMS.Synchronization.ObjectXmlWriter"> <summary> Writes the given object and its hierarchy to the output as XML </summary> </member> <member name="P:CMS.Synchronization.ObjectXmlWriter.Settings"> <summary> Synchronization settings </summary> </member> <member name="P:CMS.Synchronization.ObjectXmlWriter.Writer"> <summary> Writer for the output </summary> </member> <member name="P:CMS.Synchronization.ObjectXmlWriter.TranslationWriter"> <summary> Translation XML writer instance </summary> </member> <member name="M:CMS.Synchronization.ObjectXmlWriter.#ctor(CMS.IO.StreamWriter,CMS.DataEngine.SynchronizationObjectSettings)"> <summary> Constructor </summary> <param name="writer">Output writer</param> <param name="settings">Writer settings</param> <exception cref="T:System.ArgumentNullException"><paramref name="writer"/></exception> <exception cref="T:System.ArgumentNullException"><paramref name="settings"/></exception> </member> <member name="M:CMS.Synchronization.ObjectXmlWriter.WriteObjectXml(CMS.DataEngine.GeneralizedInfo)"> <summary> Writes the object XML </summary> <param name="infoObj">Info object</param> </member> <member name="M:CMS.Synchronization.ObjectXmlWriter.WriteObjectHierarchy(CMS.DataEngine.GeneralizedInfo)"> <summary> Writes the object data to the output </summary> <param name="infoObj">Info object</param> </member> <member name="M:CMS.Synchronization.ObjectXmlWriter.WriteSingleObject(CMS.DataEngine.GeneralizedInfo)"> <summary> Writes a single object to the output </summary> <param name="infoObj">Info object</param> </member> <member name="M:CMS.Synchronization.ObjectXmlWriter.WriteParentCategory(CMS.DataEngine.GeneralizedInfo)"> <summary> Exports the parent category of the given object </summary> <param name="infoObj">Info object</param> </member> <member name="M:CMS.Synchronization.ObjectXmlWriter.WriteNestedHierarchy(CMS.DataEngine.IObjectQuery,System.Int32)"> <summary> Traverses the nested hierarchy for the given parent query, traverses children, bindings, etc. based on settings </summary> <param name="parentQuery">Parent query</param> <param name="currentLevel">Current level</param> </member> <member name="M:CMS.Synchronization.ObjectXmlWriter.WriteProcesses(CMS.DataEngine.IObjectQuery,System.Int32)"> <summary> Writes related processes to the output </summary> <param name="parentQuery">Parent query</param> <param name="currentLevel">Current level</param> </member> <member name="M:CMS.Synchronization.ObjectXmlWriter.WriteScheduledTasks(CMS.DataEngine.IObjectQuery,System.Int32)"> <summary> Writes related scheduled tasks to the output </summary> <param name="parentQuery">Parent query</param> <param name="currentLevel">Current level</param> </member> <member name="M:CMS.Synchronization.ObjectXmlWriter.WriteMetafiles(CMS.DataEngine.IObjectQuery,System.Int32)"> <summary> Writes meta files to the output </summary> <param name="parentQuery">Parent query</param> <param name="currentLevel">Current level</param> </member> <member name="M:CMS.Synchronization.ObjectXmlWriter.WriteOtherBindings(CMS.DataEngine.IObjectQuery,System.Int32)"> <summary> Writes other bindings to the output </summary> <param name="parentQuery">Parent query</param> <param name="currentLevel">Current level</param> </member> <member name="M:CMS.Synchronization.ObjectXmlWriter.WriteBindings(CMS.DataEngine.IObjectQuery,System.Int32)"> <summary> Writes bindings to the output </summary> <param name="parentQuery">Parent query</param> <param name="currentLevel">Current level</param> </member> <member name="M:CMS.Synchronization.ObjectXmlWriter.WriteChildren(CMS.DataEngine.IObjectQuery,System.Int32)"> <summary> Writes children to the output </summary> <param name="parentQuery">Parent query</param> <param name="currentLevel">Current level</param> </member> <member name="M:CMS.Synchronization.ObjectXmlWriter.WriteChildDependencies(CMS.DataEngine.IObjectQuery,System.Int32)"> <summary> Writes child dependencies to the output </summary> <param name="parentQuery">Parent query</param> <param name="currentLevel">Current level</param> </member> <member name="M:CMS.Synchronization.ObjectXmlWriter.CheckLevel(System.Int32)"> <summary> Checks if the given level is allowed to be written </summary> <param name="currentLevel">Level to check</param> </member> <member name="M:CMS.Synchronization.ObjectXmlWriter.WriteObjects(CMS.DataEngine.ObjectQuery,System.Int32)"> <summary> Writes objects from the given query to the output </summary> <param name="objects">List of objects to write</param> <param name="currentLevel">Current level of processing</param> </member> <member name="M:CMS.Synchronization.ObjectXmlWriter.WriteObjectData(CMS.DataEngine.BaseInfo)"> <summary> Writes the given object to the output </summary> <param name="infoObj">Object</param> </member> <member name="M:CMS.Synchronization.ObjectXmlWriter.GetCompositeID(System.String,CMS.DataEngine.BaseInfo)"> <summary> Returns object ID even if it is composed out of multiple columns. </summary> <param name="idColumns">ID columns separated with semicolon</param> <param name="infoObj">Object to get ID from</param> </member> <member name="T:CMS.Synchronization.TaskGroupUserInfo"> <summary> TaskGroupUserInfo data container class. </summary> </member> <member name="F:CMS.Synchronization.TaskGroupUserInfo.OBJECT_TYPE"> <summary> Object type </summary> </member> <member name="F:CMS.Synchronization.TaskGroupUserInfo.TYPEINFO"> <summary> Type information. </summary> </member> <member name="P:CMS.Synchronization.TaskGroupUserInfo.TaskGroupUserID"> <summary> Task group user ID </summary> </member> <member name="P:CMS.Synchronization.TaskGroupUserInfo.TaskGroupID"> <summary> Task group ID </summary> </member> <member name="P:CMS.Synchronization.TaskGroupUserInfo.UserID"> <summary> User ID </summary> </member> <member name="M:CMS.Synchronization.TaskGroupUserInfo.DeleteObject"> <summary> Deletes the object using appropriate provider. </summary> </member> <member name="M:CMS.Synchronization.TaskGroupUserInfo.SetObject"> <summary> Updates the object using appropriate provider. </summary> </member> <member name="M:CMS.Synchronization.TaskGroupUserInfo.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Constructor for de-serialization. </summary> <param name="info">Serialization info</param> <param name="context">Streaming context</param> </member> <member name="M:CMS.Synchronization.TaskGroupUserInfo.#ctor"> <summary> Constructor - Creates an empty TaskGroupUserInfo object. </summary> </member> <member name="M:CMS.Synchronization.TaskGroupUserInfo.#ctor(System.Data.DataRow)"> <summary> Constructor - Creates a new TaskGroupUserInfo object from the given DataRow. </summary> <param name="dr">DataRow with the object data</param> </member> <member name="T:CMS.Synchronization.TaskGroupUserInfoProvider"> <summary> Class providing TaskGroupUserInfo management. </summary> </member> <member name="M:CMS.Synchronization.TaskGroupUserInfoProvider.GetTaskGroupUsers"> <summary> Returns all TaskGroupUserInfo bindings. </summary> </member> <member name="M:CMS.Synchronization.TaskGroupUserInfoProvider.GetTaskGroupUserInfo(System.Int32,System.Int32)"> <summary> Returns TaskGroupUserInfo binding structure. </summary> <param name="taskgroupId">Task group ID</param> <param name="userId">User ID</param> </member> <member name="M:CMS.Synchronization.TaskGroupUserInfoProvider.SetTaskGroupUserInfo(CMS.Synchronization.TaskGroupUserInfo)"> <summary> Sets specified TaskGroupUserInfo. </summary> <param name="infoObj">TaskGroupUserInfo to set</param> </member> <member name="M:CMS.Synchronization.TaskGroupUserInfoProvider.DeleteTaskGroupUserInfo(CMS.Synchronization.TaskGroupUserInfo)"> <summary> Deletes specified TaskGroupUserInfo binding. </summary> <param name="infoObj">TaskGroupUserInfo object</param> </member> <member name="M:CMS.Synchronization.TaskGroupUserInfoProvider.RemoveTaskGroupFromUser(System.Int32,System.Int32)"> <summary> Deletes TaskGroupUserInfo binding. </summary> <param name="taskgroupId">Task group ID</param> <param name="userId">User ID</param> </member> <member name="M:CMS.Synchronization.TaskGroupUserInfoProvider.AddTaskGroupToUser(System.Int32,System.Int32)"> <summary> Creates TaskGroupUserInfo binding. </summary> <param name="taskgroupId">Task group ID</param> <param name="userId">User ID</param> </member> <member name="M:CMS.Synchronization.TaskGroupUserInfoProvider.GetTaskGroupUserInfoInternal(System.Int32,System.Int32)"> <summary> Returns the TaskGroupUserInfo structure. Null if binding doesn't exist. </summary> <param name="taskgroupId">Task group ID</param> <param name="userId">User ID</param> </member> <member name="M:CMS.Synchronization.TaskGroupUserInfoProvider.RemoveTaskGroupFromUserInternal(System.Int32,System.Int32)"> <summary> Deletes TaskGroupUserInfo binding. </summary> <param name="taskgroupId">Task group ID</param> <param name="userId">User ID</param> </member> <member name="M:CMS.Synchronization.TaskGroupUserInfoProvider.AddTaskGroupToUserInternal(System.Int32,System.Int32)"> <summary> Creates TaskGroupUserInfo binding. </summary> <param name="taskgroupId">Task group ID</param> <param name="userId">User ID</param> </member> <member name="T:CMS.Synchronization.StagingTaskUserInfo"> <summary> StagingTaskUserInfo data container class. </summary> </member> <member name="F:CMS.Synchronization.StagingTaskUserInfo.OBJECT_TYPE"> <summary> Object type </summary> </member> <member name="F:CMS.Synchronization.StagingTaskUserInfo.TYPEINFO"> <summary> Type information. </summary> </member> <member name="P:CMS.Synchronization.StagingTaskUserInfo.TaskUserID"> <summary> Identifies binding between StagingTaskInfo and UserInfo. </summary> </member> <member name="P:CMS.Synchronization.StagingTaskUserInfo.TaskID"> <summary> Identifies StagingTaskInfo in binding. </summary> </member> <member name="P:CMS.Synchronization.StagingTaskUserInfo.UserID"> <summary> Identifies UserInfo in binding. </summary> </member> <member name="M:CMS.Synchronization.StagingTaskUserInfo.DeleteObject"> <summary> Deletes the object using appropriate provider. </summary> </member> <member name="M:CMS.Synchronization.StagingTaskUserInfo.SetObject"> <summary> Updates the object using appropriate provider. </summary> </member> <member name="M:CMS.Synchronization.StagingTaskUserInfo.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Creates instance for de-serialization. </summary> <param name="info">Serialization info</param> <param name="context">Streaming context</param> </member> <member name="M:CMS.Synchronization.StagingTaskUserInfo.#ctor"> <summary> Creates an empty TaskUserInfo object. </summary> </member> <member name="M:CMS.Synchronization.StagingTaskUserInfo.#ctor(System.Data.DataRow)"> <summary> Creates a new TaskUserInfo object from the given DataRow. </summary> <param name="dr">DataRow with the object data</param> </member> <member name="T:CMS.Synchronization.StagingTaskUserInfoProvider"> <summary> Class providing <see cref="T:CMS.Synchronization.StagingTaskUserInfo"/> management. </summary> </member> <member name="M:CMS.Synchronization.StagingTaskUserInfoProvider.GetTaskUsers"> <summary> Returns all <see cref="T:CMS.Synchronization.StagingTaskUserInfo"/> bindings. </summary> </member> <member name="M:CMS.Synchronization.StagingTaskUserInfoProvider.GetStagingTaskUserInfo(System.Int32,System.Int32)"> <summary> Returns <see cref="T:CMS.Synchronization.StagingTaskUserInfo"/> binding structure. </summary> <param name="taskId">StagingTaskInfo ID</param> <param name="userId">UserInfo ID</param> </member> <member name="M:CMS.Synchronization.StagingTaskUserInfoProvider.SetStagingTaskUserInfo(CMS.Synchronization.StagingTaskUserInfo)"> <summary> Sets specified <see cref="T:CMS.Synchronization.StagingTaskUserInfo"/>. </summary> <param name="infoObj"><see cref="T:CMS.Synchronization.StagingTaskUserInfo"/> to set</param> </member> <member name="M:CMS.Synchronization.StagingTaskUserInfoProvider.DeleteStagingTaskUserInfo(CMS.Synchronization.StagingTaskUserInfo)"> <summary> Deletes specified <see cref="T:CMS.Synchronization.StagingTaskUserInfo"/> binding. </summary> <param name="infoObj"><see cref="T:CMS.Synchronization.StagingTaskUserInfo"/> object</param> </member> <member name="M:CMS.Synchronization.StagingTaskUserInfoProvider.RemoveStagingTaskFromUser(System.Int32,System.Int32)"> <summary> Deletes <see cref="T:CMS.Synchronization.StagingTaskUserInfo"/> binding. </summary> <param name="taskId">StagingTaskInfo ID</param> <param name="userId">UserInfo ID</param> </member> <member name="M:CMS.Synchronization.StagingTaskUserInfoProvider.AddStagingTaskToUser(System.Int32,System.Int32)"> <summary> Creates <see cref="T:CMS.Synchronization.StagingTaskUserInfo"/> binding. </summary> <param name="taskId">StagingTaskInfo ID</param> <param name="userId">UserInfo ID</param> </member> <member name="M:CMS.Synchronization.StagingTaskUserInfoProvider.UpdateStagingTaskUsers(CMS.DataEngine.IWhereCondition,System.Collections.Generic.IEnumerable{System.Collections.Generic.KeyValuePair{System.String,System.Object}})"> <summary> Updates staging tasks user bindings for given where condition with values. </summary> <param name="where">Staging tasks user bindings to be updated</param> <param name="values">Values to be updated in columns</param> </member> <member name="M:CMS.Synchronization.StagingTaskUserInfoProvider.GetStagingTaskInfoInternal(System.Int32,System.Int32)"> <summary> Returns the <see cref="T:CMS.Synchronization.StagingTaskUserInfo"/> structure. Null if binding doesn't exist. </summary> <param name="taskId">StagingTaskInfo ID</param> <param name="userId">UserInfo ID</param> </member> <member name="M:CMS.Synchronization.StagingTaskUserInfoProvider.RemoveStagingTaskFromUserInternal(System.Int32,System.Int32)"> <summary> Deletes <see cref="T:CMS.Synchronization.StagingTaskUserInfo"/> binding. </summary> <param name="taskId">StagingTaskInfo ID</param> <param name="userId">UserInfo ID</param> </member> <member name="M:CMS.Synchronization.StagingTaskUserInfoProvider.AddStagingTaskToUserInternal(System.Int32,System.Int32)"> <summary> Creates <see cref="T:CMS.Synchronization.StagingTaskUserInfo"/> binding. </summary> <param name="taskId">StagingTaskInfo ID</param> <param name="userId">UserInfo ID</param> </member> <member name="T:CMS.Synchronization.IStagingTaskData"> <summary> Interface for objects that are used for sending staging task to target server. </summary> </member> <member name="P:CMS.Synchronization.IStagingTaskData.TaskType"> <summary> Type of task, for example update, delete, add to site etc... </summary> </member> <member name="P:CMS.Synchronization.IStagingTaskData.TaskObjectType"> <summary> Object type of object for which the given staging task was created. </summary> </member> <member name="P:CMS.Synchronization.IStagingTaskData.TaskData"> <summary> Data of object, which will be recreated on target server. </summary> </member> <member name="P:CMS.Synchronization.IStagingTaskData.TaskBinaryData"> <summary> Binary data of object which will be recreated on target server. </summary> </member> <member name="P:CMS.Synchronization.IStagingTaskData.TaskServers"> <summary> List of tasks servers separated by ';', eg. ';server1;server2;server3;'. On which servers was staging task processed already. </summary> </member> <member name="P:CMS.Synchronization.IStagingTaskData.SystemVersion"> <summary> Current version of Kentico. Version should be the same on source and target. </summary> </member> <member name="P:CMS.Synchronization.IStagingTaskData.UserGuid"> <summary> Guid of user who has synchronized the task. </summary> </member> <member name="P:CMS.Synchronization.IStagingTaskData.UserName"> <summary> Name of user who has synchronized the task. </summary> </member> <member name="P:CMS.Synchronization.IStagingTaskData.TaskGroups"> <summary> Task groups under which object encapsulated within staging task got modified. </summary> <remarks> Cannot be a generic collection since the SOAP serializer doesn't support those. </remarks> </member> <member name="M:CMS.Synchronization.IStagingTaskData.Serialize"> <summary> Serializes current IStagingTaskData. </summary> <returns>String serialized IStagingTaskData</returns> </member> <member name="T:CMS.Synchronization.StagingTaskData"> <summary> Object that implements IStagingTaskData and is used for sending staging task related data from source server to target. </summary> </member> <member name="P:CMS.Synchronization.StagingTaskData.TaskType"> <summary> Type of task, for example update, delete, add to site etc... </summary> </member> <member name="P:CMS.Synchronization.StagingTaskData.TaskObjectType"> <summary> Object type of object for which the given staging task was created. </summary> </member> <member name="P:CMS.Synchronization.StagingTaskData.TaskData"> <summary> Data of object, which will be recreated on target server. </summary> </member> <member name="P:CMS.Synchronization.StagingTaskData.TaskBinaryData"> <summary> Binary data of object which will be recreated on target server. </summary> </member> <member name="P:CMS.Synchronization.StagingTaskData.TaskServers"> <summary> List of tasks servers separated by ';', eg. ';server1;server2;server3;'. </summary> </member> <member name="P:CMS.Synchronization.StagingTaskData.SystemVersion"> <summary> From which Kentico version is this object sent. Version should be the same on source and target. If not set, current version is returned. </summary> </member> <member name="P:CMS.Synchronization.StagingTaskData.UserGuid"> <summary> Guid of user who has synchronized the task. </summary> </member> <member name="P:CMS.Synchronization.StagingTaskData.UserName"> <summary> Name of user who has synchronized the task. </summary> </member> <member name="P:CMS.Synchronization.StagingTaskData.TaskGroups"> <summary> Work labels under which object encapsulated within staging task got modified. </summary> </member> <member name="M:CMS.Synchronization.StagingTaskData.#ctor"> <summary> Parameterless constructor, for creating StagingTaskData. No properties are initialized except SystemVersion. </summary> </member> <member name="M:CMS.Synchronization.StagingTaskData.#ctor(System.String)"> <summary> Creates StagingTaskData from serialized StagingTaskData. Should be used on target server. All properties are initialized from serialized StagingTaskData. </summary> <param name="serializedStagingTaskData">Serialized StagingTaskData from which this object will be initialized</param> </member> <member name="M:CMS.Synchronization.StagingTaskData.#ctor(CMS.Synchronization.StagingTaskInfo)"> <summary> Creates StagingTaskData from serialized StagingTaskInfo. Should be used before sending data from source to target. All properties are initialized, UserName and UserGuid are equal to CurrentUser. </summary> <param name="sti">StagingTaskInfo from which this object will be initialized</param> </member> <member name="M:CMS.Synchronization.StagingTaskData.Serialize"> <summary> Serializes current StagingTaskData to string, for sending via staging. </summary> <returns>Serializesd current StagingTaskData</returns> </member> <member name="M:CMS.Synchronization.StagingTaskData.Deserialize(System.String)"> <summary> Deserializes string, to fill properties of this StagingTaskData. </summary> <param name="serializedStagingTaskData">Serialized StagingTaskData</param> </member> <member name="M:CMS.Synchronization.StagingTaskData.SetCurrentUser(CMS.Base.IUserInfo)"> <summary> Sets the current user's guid and username to <see cref="P:CMS.Synchronization.StagingTaskData.UserGuid"/> and <see cref="P:CMS.Synchronization.StagingTaskData.UserName"/> of current StagingTaskData instance. </summary> <param name="user">User to be set, if null <see cref="P:CMS.Base.CMSActionContext.CurrentUser"/> will be used</param> </member> <member name="T:CMS.Synchronization.SynchronizationActionContext"> <summary> Context for synchronization and task processing. </summary> </member> <member name="P:CMS.Synchronization.SynchronizationActionContext.CurrentTaskGroups"> <summary> Gets task group collection for current user context. </summary> <remarks> The same task group collection is used for all users if collection of task groups is set through <see cref="P:CMS.Synchronization.SynchronizationActionContext.TaskGroups"/> property. </remarks> </member> <member name="P:CMS.Synchronization.SynchronizationActionContext.CurrentLogUserWithTask"> <summary> Indicates whether user should be logged within the task creation. </summary> <remarks> By default tasks are logged with information about the current user. </remarks> </member> <member name="P:CMS.Synchronization.SynchronizationActionContext.TaskGroups"> <summary> Sets the collection of tasks used within the current task processing. </summary> <remarks> The collection of task groups defined in <see cref="P:CMS.Synchronization.SynchronizationActionContext.CurrentTaskGroups"/> property is returning currently set value for all users. </remarks> </member> <member name="P:CMS.Synchronization.SynchronizationActionContext.LogUserWithTask"> <summary> Sets the value that indicates whether user should be logged within the task creation. </summary> <remarks> By default tasks are logged with and information about user. If disabled, task are not logged with information about user. </remarks> </member> <member name="P:CMS.Synchronization.SynchronizationActionContext.UserTaskGroups"> <summary> Sets the value that indicates whether user should be logged within the task creation. </summary> <remarks> By default tasks are logged with and information about user. If disabled, task are not logged with information about user. </remarks> </member> <member name="M:CMS.Synchronization.SynchronizationActionContext.#ctor"> <summary> Creates context that affects logging additional information with staging task within using block. </summary> <example> <code> using (new SynchronizationActionContext() { LogUserWithTask = false }) { // Within this block, information about user who caused staging task creation won't be logged } </code> </example> </member> <member name="M:CMS.Synchronization.SynchronizationActionContext.#ctor(CMS.Synchronization.SynchronizationActionContext)"> <summary> Copies internal state of injected context to new one. Which causes the static SynchronizationActionContext to return values set by injected context. </summary> <param name="sac">Context to be injected</param> </member> <member name="M:CMS.Synchronization.SynchronizationActionContext.RestoreOriginalValues"> <summary> Restores original values. </summary> </member> <member name="M:CMS.Synchronization.SynchronizationActionContext.EnsureRequiredValues"> <summary> Initialize context, ensures that values will be cached for current thread and will not be changed by another thread. </summary> </member> <member name="M:CMS.Synchronization.SynchronizationActionContext.CloneForNewThread"> <summary> Ensures values in current thread for context and clones synchronization action context object for new thread. </summary> </member> <member name="M:CMS.Synchronization.SynchronizationActionContext.CloneCurrent"> <summary> Returns the clone of current <see cref="T:CMS.Synchronization.SynchronizationActionContext"/> instance. </summary> </member> <member name="M:CMS.Synchronization.SynchronizationActionContext.GetCurrentGroupInfo"> <summary> Returns collection of <see cref="T:CMS.Synchronization.TaskGroupInfo"/> objects for current user. </summary> </member> <member name="T:CMS.Synchronization.SynchronizationActionManager"> <summary> Manager for registered synchronization actions. </summary> </member> <member name="M:CMS.Synchronization.SynchronizationActionManager.RegisterAction(System.Func{CMS.DataEngine.LogObjectChangeSettings,System.Collections.Generic.IEnumerable{CMS.Synchronization.ISynchronizationTask}},System.Func{CMS.DataEngine.LogObjectChangeSettings,System.Boolean})"> <summary> Registers the given synchronization action </summary> <param name="execute">Method executed to perform the synchronization</param> <param name="condition">Condition under which the action is executed</param> </member> <member name="M:CMS.Synchronization.SynchronizationActionManager.RegisterAction(CMS.Synchronization.SynchronizationAction)"> <summary> Registers the given synchronization action </summary> <param name="action">Action to register</param> </member> <member name="M:CMS.Synchronization.SynchronizationActionManager.ExecuteActions(CMS.DataEngine.LogObjectChangeSettings)"> <summary> Executes all registered synchronization actions </summary> <param name="settings">Action settings</param> </member> <member name="M:CMS.Synchronization.SynchronizationActionManager.CanExecuteActions(CMS.DataEngine.LogObjectChangeSettings)"> <summary> Indicates if at least one of the synchronization actions can be executed </summary> <param name="settings">Action settings</param> </member> <member name="T:CMS.Synchronization.ObjectVersioningException"> <summary> Base class for the exceptions raised during versioning methods (check in/out, etc.). </summary> </member> <member name="P:CMS.Synchronization.ObjectVersioningException.Settings"> <summary> Gets or sets the object settings info. </summary> </member> <member name="P:CMS.Synchronization.ObjectVersioningException.Operation"> <summary> Gets or sets the name of the operation. </summary> </member> <member name="M:CMS.Synchronization.ObjectVersioningException.#ctor(CMS.DataEngine.ObjectSettingsInfo,System.String)"> <summary> Constructor. </summary> <param name="settings">Object settings</param> <param name="operation">Operation processed</param> </member> <member name="T:CMS.Synchronization.AbstractIntegrationConnector"> <summary> Class that needs to be inherited during implementing custom integration connector. Several members have to be implemented in order to achieve desired functionality. </summary> </member> <member name="P:CMS.Synchronization.AbstractIntegrationConnector.ConnectorName"> <summary> Name of the connector. </summary> </member> <member name="P:CMS.Synchronization.AbstractIntegrationConnector.ConnectorInfo"> <summary> Gets integration connector info object. </summary> </member> <member name="P:CMS.Synchronization.AbstractIntegrationConnector.ConnectorID"> <summary> Gets integration connector identifier. </summary> </member> <member name="P:CMS.Synchronization.AbstractIntegrationConnector.ConnectorEnabled"> <summary> Gets a value that indicates if the connector is enabled. </summary> </member> <member name="P:CMS.Synchronization.AbstractIntegrationConnector.ProcessingInternalTasks"> <summary> Indicates whether the thread for processing outgoing tasks is already running. </summary> <seealso cref="M:CMS.Synchronization.AbstractIntegrationConnector.SetProcessingInternalTasks"/> <seealso cref="M:CMS.Synchronization.AbstractIntegrationConnector.ClearProcessingInternalTasks"/> </member> <member name="P:CMS.Synchronization.AbstractIntegrationConnector.ProcessingExternalTasks"> <summary> Indicates whether the thread for processing incoming tasks is already running. </summary> <seealso cref="M:CMS.Synchronization.AbstractIntegrationConnector.SetProcessingExternalTasks"/> <seealso cref="M:CMS.Synchronization.AbstractIntegrationConnector.ClearProcessingExternalTasks"/> </member> <member name="M:CMS.Synchronization.AbstractIntegrationConnector.SetProcessingInternalTasks"> <summary> Sets the <see cref="P:CMS.Synchronization.AbstractIntegrationConnector.ProcessingInternalTasks"/> flag to true, if not already set and returns a value indicating whether the flag was set by the current call. To ensure mutual exclusion, only the thread successfully setting the flag can process internal tasks. </summary> <returns>Returns true if the <see cref="P:CMS.Synchronization.AbstractIntegrationConnector.ProcessingInternalTasks"/> flag was set by the current call.</returns> </member> <member name="M:CMS.Synchronization.AbstractIntegrationConnector.ClearProcessingInternalTasks"> <summary> Clears the "<see cref="P:CMS.Synchronization.AbstractIntegrationConnector.ProcessingInternalTasks"/>"/> flag. The flag can be cleared only after it has been previously set by a <see cref="M:CMS.Synchronization.AbstractIntegrationConnector.SetProcessingInternalTasks"/> call. </summary> <exception cref="T:System.InvalidOperationException">Thrown when clearing an already clear flag. Such exception indicates possible multi-threaded access and violation of the mutual exclusion.</exception> </member> <member name="M:CMS.Synchronization.AbstractIntegrationConnector.SetProcessingExternalTasks"> <summary> Sets the <see cref="P:CMS.Synchronization.AbstractIntegrationConnector.ProcessingExternalTasks"/> flag to true, if not already set and returns a value indicating whether the flag was set by the current call. To ensure mutual exclusion, only the thread successfully setting the flag can process internal tasks. </summary> <returns>Returns true if the <see cref="P:CMS.Synchronization.AbstractIntegrationConnector.ProcessingExternalTasks"/> flag was set by the current call.</returns> </member> <member name="M:CMS.Synchronization.AbstractIntegrationConnector.ClearProcessingExternalTasks"> <summary> Clears the "<see cref="P:CMS.Synchronization.AbstractIntegrationConnector.ProcessingExternalTasks"/>"/> flag. The flag can be cleared only after it has been previously set by a <see cref="M:CMS.Synchronization.AbstractIntegrationConnector.SetProcessingExternalTasks"/> call. </summary> <exception cref="T:System.InvalidOperationException">Thrown when clearing an already clear flag. Such exception indicates possible multi-threaded access and violation of the mutual exclusion.</exception> </member> <member name="M:CMS.Synchronization.AbstractIntegrationConnector.Init"> <summary> Initializes the provider. Suitable for making subscriptions etc. ConnectorName has to be initialized within this method. </summary> </member> <member name="M:CMS.Synchronization.AbstractIntegrationConnector.ProcessInternalTaskAsync(CMS.Base.ICMSObject,CMS.DataEngine.TranslationHelper,CMS.DataEngine.TaskTypeEnum,CMS.Synchronization.TaskDataTypeEnum,System.String,System.String@)"> <summary> Suitable for implementing asynchronous outgoing CMS object processing. Identifiers of object is already prepared to match external application. </summary> <param name="cmsObject">CMS object to process</param> <param name="translations">Translation helper object containing translations for given object</param> <param name="taskType">Type of task</param> <param name="dataType">Type of data</param> <param name="siteName">Name of site</param> <param name="errorMessage">Possible error message</param> <returns>Processing result</returns> </member> <member name="M:CMS.Synchronization.AbstractIntegrationConnector.ProcessInternalTaskSync(CMS.Base.ICMSObject,CMS.DataEngine.TaskTypeEnum,System.String,System.String@)"> <summary> Suitable for implementing synchronous outgoing CMS object processing. </summary> <param name="cmsObject">CMS object to process</param> <param name="taskType">Type of task</param> <param name="errorMessage">Possible error message</param> <param name="siteName">Name of site</param> <returns>Processing result</returns> </member> <member name="M:CMS.Synchronization.AbstractIntegrationConnector.ProcessExternalTask(System.Object,CMS.Synchronization.IntegrationProcessTypeEnum,CMS.DataEngine.TaskTypeEnum,CMS.Synchronization.TaskDataTypeEnum,System.String)"> <summary> Processes incoming task. </summary> <param name="obj">Object or document to process (either already prepared ICMSObject or raw external object)</param> <param name="result">What to do if the processing fails</param> <param name="taskType">Type of task</param> <param name="dataType">Type of input data</param> <param name="siteName">Name of the target site</param> </member> <member name="M:CMS.Synchronization.AbstractIntegrationConnector.ProcessInternalTasks"> <summary> Repeatedly fetches outgoing tasks from oldest to newest and processes them. </summary> </member> <member name="M:CMS.Synchronization.AbstractIntegrationConnector.ProcessExternalTasks"> <summary> Repeatedly fetches incoming tasks from oldest to newest and processes them. </summary> </member> <member name="T:CMS.Synchronization.AbstractIntegrationSubscription"> <summary> Class representing generic subscription object. </summary> </member> <member name="F:CMS.Synchronization.AbstractIntegrationSubscription.GLOBAL_OBJECTS"> <summary> Used for subscribing to global objects. </summary> </member> <member name="P:CMS.Synchronization.AbstractIntegrationSubscription.ConnectorName"> <summary> Name of connector the subscription is attached to </summary> </member> <member name="M:CMS.Synchronization.AbstractIntegrationSubscription.IsMatch(CMS.Base.ICMSObject,CMS.DataEngine.TaskTypeEnum,CMS.Synchronization.TaskProcessTypeEnum@)"> <summary> Determines whether given CMS object and task type match the subscription </summary> <param name="obj">CMS object object to match</param> <param name="taskType">Task type to match</param> <param name="taskProcessType">Returns type of task processing</param> <returns>TRUE if the info object and task correspond with subscription settings</returns> </member> <member name="T:CMS.Synchronization.IntegrationHelper"> <summary> Class covering functionality shared across the integration module. </summary> </member> <member name="P:CMS.Synchronization.IntegrationHelper.IntegrationEnabled"> <summary> Indicates if system integration is enabled. </summary> </member> <member name="P:CMS.Synchronization.IntegrationHelper.IntegrationIsDisabled"> <summary> Indicates if system integration is disabled in web.config. </summary> </member> <member name="P:CMS.Synchronization.IntegrationHelper.IntegrationProcessExternal"> <summary> Indicates if processing of integration tasks for inbound direction is enabled. Reflects also IntegrationEnabled setting. </summary> </member> <member name="P:CMS.Synchronization.IntegrationHelper.IntegrationProcessInternal"> <summary> Indicates if processing of integration tasks for outbound direction is enabled. Reflects also IntegrationEnabled setting. </summary> </member> <member name="P:CMS.Synchronization.IntegrationHelper.IntegrationLogExternal"> <summary> Indicates if logging of integration tasks for inbound direction is enabled. Reflects also IntegrationEnabled setting. </summary> </member> <member name="P:CMS.Synchronization.IntegrationHelper.IntegrationLogInternal"> <summary> Indicates if logging of integration tasks for outbound direction is enabled. Reflects also IntegrationEnabled setting. </summary> </member> <member name="F:CMS.Synchronization.IntegrationHelper.connectorLock"> <summary> Lock for connector loading. </summary> </member> <member name="F:CMS.Synchronization.IntegrationHelper.TOUCHED_CONNECTOR_NAMES"> <summary> Item name for storing connector names in request stock. </summary> </member> <member name="F:CMS.Synchronization.IntegrationHelper.mConnectors"> <summary> Inner connector storage </summary> </member> <member name="P:CMS.Synchronization.IntegrationHelper.Connectors"> <summary> List of enabled (and initialized) connectors </summary> </member> <member name="P:CMS.Synchronization.IntegrationHelper.TouchedConnectorNames"> <summary> List of connector names for which the task was logged </summary> </member> <member name="M:CMS.Synchronization.IntegrationHelper.Init"> <summary> Initializes integration bus </summary> </member> <member name="M:CMS.Synchronization.IntegrationHelper.LoadConnectors"> <summary> Loads connectors </summary> </member> <member name="M:CMS.Synchronization.IntegrationHelper.LoadConnectors(System.Boolean)"> <summary> Loads connectors </summary> <param name="force">Whether to load from database</param> </member> <member name="M:CMS.Synchronization.IntegrationHelper.GetConnector(System.String)"> <summary> Gets connector by name </summary> <param name="connectorName">Name of connector to get</param> <returns>Connector of specified name</returns> </member> <member name="M:CMS.Synchronization.IntegrationHelper.GetConnector(System.Int32)"> <summary> Gets connector by ID </summary> <param name="connectorId">ID of connector to get</param> <returns>Connector of specified ID</returns> </member> <member name="M:CMS.Synchronization.IntegrationHelper.InvalidateConnectors"> <summary> Invalidates collections with connectors and subscriptions </summary> </member> <member name="F:CMS.Synchronization.IntegrationHelper.mSubscriptions"> <summary> Inner subscription storage </summary> </member> <member name="P:CMS.Synchronization.IntegrationHelper.Subscriptions"> <summary> List of subscriptions for all connectors </summary> </member> <member name="M:CMS.Synchronization.IntegrationHelper.SubscribeTo(CMS.Synchronization.AbstractIntegrationSubscription)"> <summary> Adds subscription to collection of subscriptions </summary> <param name="subscription">Subscription to add</param> </member> <member name="M:CMS.Synchronization.IntegrationHelper.FilterAsyncConnectors(System.Collections.Generic.Dictionary{System.String,CMS.Synchronization.TaskProcessTypeEnum})"> <summary> Filters given set of connectors. </summary> <param name="connectors">Connector collection</param> <returns>Async connectors</returns> </member> <member name="M:CMS.Synchronization.IntegrationHelper.FilterConnectors(System.Collections.Generic.Dictionary{System.String,CMS.Synchronization.TaskProcessTypeEnum},CMS.Synchronization.TaskProcessTypeEnum)"> <summary> Filters given set of connectors by task process type. </summary> <param name="connectors">Connector collection</param> <param name="taskProcessType">Task process type</param> <returns>Dictionary filtered by task process type</returns> </member> <member name="M:CMS.Synchronization.IntegrationHelper.GetMatchingConnectors(CMS.Base.ICMSObject,CMS.DataEngine.TaskTypeEnum)"> <summary> Gets dictionary of connector names whose subscriptions match given CMS object and task type. The type of task processing is stored as dictionary value. </summary> <param name="cmsObject">CMS object to match</param> <param name="taskType">Task type to match</param> <returns>Dictionary of connector names whose subscriptions match given document/object and task type</returns> </member> <member name="M:CMS.Synchronization.IntegrationHelper.InvalidateSubscriptions"> <summary> Invalidates collection with subscriptions </summary> </member> <member name="M:CMS.Synchronization.IntegrationHelper.LogSynchronizationError(CMS.Synchronization.IntegrationSynchronizationInfo,System.String)"> <summary> Logs the integration synchronization error. </summary> <param name="synchronization">Synchronization info object</param> <param name="result">Result</param> </member> <member name="M:CMS.Synchronization.IntegrationHelper.ProcessExternalTask(System.String,System.Object,CMS.Synchronization.IntegrationProcessTypeEnum,CMS.DataEngine.TaskTypeEnum,CMS.Synchronization.TaskDataTypeEnum,System.String)"> <summary> Processes incoming task. </summary> <param name="connectorName">Name of connector</param> <param name="obj">Object or document to process</param> <param name="result">What to do if the processing fails</param> <param name="taskType">Type of task</param> <param name="dataType">Type of input data</param> <param name="siteName">Name of the target site</param> </member> <member name="M:CMS.Synchronization.IntegrationHelper.ProcessInternalTasksAsync(System.Collections.Generic.List{System.String})"> <summary> Ensures separate threads for connectors to process the logged internal tasks. Thread won't be started if processing is already running. </summary> <param name="connectorNames">Names of connectors whose tasks to process</param> </member> <member name="M:CMS.Synchronization.IntegrationHelper.ProcessExternalTasksAsync"> <summary> Ensures separate threads for connectors to process the pending logged external tasks. Thread won't be started if processing is already running. </summary> </member> <member name="M:CMS.Synchronization.IntegrationHelper.ProcessExternalTasksAsync(System.String)"> <summary> Processes external tasks of connector specified by name </summary> <param name="connectorName">Name of connector whose tasks to process</param> </member> <member name="M:CMS.Synchronization.IntegrationHelper.ProcessExternalTasksAsync(System.Int32)"> <summary> Processes external tasks of connector specified by ID </summary> <param name="connectorId">ID of connector whose tasks to process</param> </member> <member name="M:CMS.Synchronization.IntegrationHelper.ProcessTasks(System.String,System.Boolean)"> <summary> Processes pending internal or external tasks for specified connector. </summary> <param name="connectorName">Name of connector whose tasks to process</param> <param name="internalTasks">Whether to process internal or external tasks</param> </member> <member name="M:CMS.Synchronization.IntegrationHelper.ProcessTasks(System.Int32,System.Boolean)"> <summary> Processes pending internal or external tasks for specified connector. </summary> <param name="connectorId">ID of connector whose tasks to process</param> <param name="internalTasks">Whether to process internal or external tasks</param> </member> <member name="M:CMS.Synchronization.IntegrationHelper.ProcessTasks(CMS.Synchronization.AbstractIntegrationConnector,System.Boolean)"> <summary> Processes pending internal or external tasks for specified connector. </summary> <param name="connector">Connector whose tasks to process</param> <param name="internalTasks">Whether to process internal or external tasks</param> </member> <member name="M:CMS.Synchronization.IntegrationHelper.ProcessSyncTasks(CMS.DataEngine.GeneralizedInfo,CMS.DataEngine.TaskTypeEnum,System.Int32,System.Collections.Generic.Dictionary{System.String,CMS.Synchronization.TaskProcessTypeEnum})"> <summary> Processes synchronous task subscriptions. </summary> <param name="infoObj">Info object to match</param> <param name="siteId">Site identifier</param> <param name="taskType">Type of task to match</param> <param name="connectors">Connectors to process</param> </member> <member name="M:CMS.Synchronization.IntegrationHelper.LogIntegration(CMS.DataEngine.GeneralizedInfo,CMS.DataEngine.TaskTypeEnum,System.Int32,CMS.Synchronization.TaskProcessTypeEnum[])"> <summary> Logs integration task (only asynchronous process types). </summary> <param name="infoObj">Info object to log</param> <param name="taskType">Type of task to log</param> <param name="siteId">Site identifier</param> <param name="processTypes">Task process types</param> </member> <member name="M:CMS.Synchronization.IntegrationHelper.TouchAsyncConnectors(System.Collections.Generic.Dictionary{System.String,CMS.Synchronization.TaskProcessTypeEnum})"> <summary> Adds connectors to collection to be processed. </summary> <param name="connectors">Connectors to process</param> <returns>True if at least one connector was touched</returns> </member> <member name="M:CMS.Synchronization.IntegrationHelper.GetIntegrationProcessResultString(CMS.Synchronization.IntegrationProcessResultEnum)"> <summary> Returns the process result as a string. </summary> <param name="result">Process result enumeration value</param> </member> <member name="M:CMS.Synchronization.IntegrationHelper.GetIntegrationProcessResultEnum(System.String)"> <summary> Returns the process result enumeration value. </summary> <param name="result">String representing process result</param> </member> <member name="M:CMS.Synchronization.IntegrationHelper.GetIntegrationProcessTypeString(CMS.Synchronization.IntegrationProcessTypeEnum)"> <summary> Returns the process type as a string. </summary> <param name="result">Process type enumeration value</param> </member> <member name="M:CMS.Synchronization.IntegrationHelper.GetIntegrationProcessTypeEnum(System.String)"> <summary> Returns the process type enumeration value. </summary> <param name="result">String representing process type</param> </member> <member name="M:CMS.Synchronization.IntegrationHelper.GetTaskDataTypeString(CMS.Synchronization.TaskDataTypeEnum)"> <summary> Returns the task data type as a string. </summary> <param name="type">Task data type enumeration value</param> </member> <member name="M:CMS.Synchronization.IntegrationHelper.GetTaskDataTypeEnum(System.String)"> <summary> Returns the task data type enumeration value. </summary> <param name="type">String representing task data type</param> </member> <member name="M:CMS.Synchronization.IntegrationHelper.GetTaskDataTypeEnum(CMS.Synchronization.TaskProcessTypeEnum)"> <summary> Returns the task data type enumeration value based on task process type. </summary> <param name="taskProcessType">Task process type value</param> <returns>Task data type</returns> </member> <member name="T:CMS.Synchronization.IntegrationProcessTypeEnum"> <summary> Says how the CMS should process the task. See comments for each value. </summary> </member> <member name="F:CMS.Synchronization.IntegrationProcessTypeEnum.Default"> <summary> Processes the task immediately. If error occurs, the processing stops and sets the type to Error. </summary> </member> <member name="F:CMS.Synchronization.IntegrationProcessTypeEnum.SkipOnce"> <summary> Does not process the task during first processing (just sets the type to Default so it is going to be processed during next processing). </summary> </member> <member name="F:CMS.Synchronization.IntegrationProcessTypeEnum.SkipOnError"> <summary> Processes the task immediately. If error occurs, it skips the task and continues with processing. </summary> </member> <member name="F:CMS.Synchronization.IntegrationProcessTypeEnum.DeleteOnError"> <summary> Processes the task immediately. If error occurs, deletes the task and continues with processing. </summary> </member> <member name="F:CMS.Synchronization.IntegrationProcessTypeEnum.Error"> <summary> Says that processing should not continue due to critical error. </summary> </member> <member name="T:CMS.Synchronization.IntegrationProcessResultEnum"> <summary> Enumeration indicationg processing result. Task the value says whether the 3rd party system processed the task well or not. See comments for each value. </summary> </member> <member name="F:CMS.Synchronization.IntegrationProcessResultEnum.OK"> <summary> OUTBOUND TASKS - Default state of the task. Says that task was processed without any error and should be deleted (or the relation should be deleted). </summary> </member> <member name="F:CMS.Synchronization.IntegrationProcessResultEnum.Error"> <summary> OUTBOUND TASKS - The result indicating that the processing of the task failed and should not continue. - SYNC TASKS - Synchronization does not continue for other connectors. </summary> </member> <member name="F:CMS.Synchronization.IntegrationProcessResultEnum.ErrorAndSkip"> <summary> OUTBOUND TASKS - The result indicating that the processing of the task ended with error but should continue. - SYNC TASKS - Synchronization does continue for other connectors. </summary> </member> <member name="F:CMS.Synchronization.IntegrationProcessResultEnum.SkipNow"> <summary> OUTBOUND TASKS - The result indicating that the task was not processed and should be processed later. The task should remain in database with its current state. </summary> </member> <member name="T:CMS.Synchronization.IntegrationTasksWorker"> <summary> Class for asynchronous task processing. </summary> </member> <member name="P:CMS.Synchronization.IntegrationTasksWorker.Connector"> <summary> Connector info object </summary> </member> <member name="P:CMS.Synchronization.IntegrationTasksWorker.InternalTasks"> <summary> Determines whether to process internal or external tasks </summary> </member> <member name="M:CMS.Synchronization.IntegrationTasksWorker.#ctor"> <summary> Default constructor. </summary> </member> <member name="M:CMS.Synchronization.IntegrationTasksWorker.Run"> <summary> Runs the worker as a new thread. </summary> </member> <member name="M:CMS.Synchronization.IntegrationTasksWorker.LogException(System.Exception,System.String)"> <summary> Logs exception to event log </summary> <param name="exception">Exception to log</param> <param name="eventCode">Code of event</param> </member> <member name="M:CMS.Synchronization.IntegrationTasksWorker.ProcessInternalTasks"> <summary> Processes internal tasks. </summary> </member> <member name="M:CMS.Synchronization.IntegrationTasksWorker.ProcessExternalTasks"> <summary> Processes external tasks. </summary> </member> <member name="T:CMS.Synchronization.IntegrationConnectorInfo"> <summary> IntegrationConnectorInfo data container class. </summary> </member> <member name="F:CMS.Synchronization.IntegrationConnectorInfo.OBJECT_TYPE"> <summary> Object type </summary> </member> <member name="F:CMS.Synchronization.IntegrationConnectorInfo.TYPEINFO"> <summary> Type information. </summary> </member> <member name="P:CMS.Synchronization.IntegrationConnectorInfo.ConnectorAssemblyName"> <summary> Assembly which is the connector bound to. </summary> </member> <member name="P:CMS.Synchronization.IntegrationConnectorInfo.ConnectorEnabled"> <summary> Determines whether the connector is enabled. </summary> </member> <member name="P:CMS.Synchronization.IntegrationConnectorInfo.ConnectorName"> <summary> Connector's code name. </summary> </member> <member name="P:CMS.Synchronization.IntegrationConnectorInfo.ConnectorClassName"> <summary> Name of a class which is the connector bound to. </summary> </member> <member name="P:CMS.Synchronization.IntegrationConnectorInfo.ConnectorID"> <summary> Connector identifier. </summary> </member> <member name="P:CMS.Synchronization.IntegrationConnectorInfo.ConnectorDisplayName"> <summary> Connector's display name. </summary> </member> <member name="P:CMS.Synchronization.IntegrationConnectorInfo.ConnectorLastModified"> <summary> Connector last modified time stamp. </summary> </member> <member name="M:CMS.Synchronization.IntegrationConnectorInfo.DeleteObject"> <summary> Deletes the object using appropriate provider. </summary> </member> <member name="M:CMS.Synchronization.IntegrationConnectorInfo.SetObject"> <summary> Updates the object using appropriate provider. </summary> </member> <member name="M:CMS.Synchronization.IntegrationConnectorInfo.#ctor"> <summary> Constructor - Creates an empty IntegrationConnectorInfo object. </summary> </member> <member name="M:CMS.Synchronization.IntegrationConnectorInfo.#ctor(System.Data.DataRow)"> <summary> Constructor - Creates a new IntegrationConnectorInfo object from the given DataRow. </summary> <param name="dr">DataRow with the object data</param> </member> <member name="T:CMS.Synchronization.IntegrationConnectorInfoProvider"> <summary> Class providing IntegrationConnectorInfo management. </summary> </member> <member name="M:CMS.Synchronization.IntegrationConnectorInfoProvider.#ctor"> <summary> Constructor </summary> </member> <member name="M:CMS.Synchronization.IntegrationConnectorInfoProvider.GetIntegrationConnectors"> <summary> Returns all integration connectors. </summary> </member> <member name="M:CMS.Synchronization.IntegrationConnectorInfoProvider.GetIntegrationConnectors(System.String,System.String,System.Int32,System.String)"> <summary> Returns dataset of all integration connectors matching the specified parameters. </summary> <param name="where">Where condition.</param> <param name="orderBy">Order by expression.</param> <param name="topN">Number of records to be selected.</param> <param name="columns">Columns to be selected.</param> </member> <member name="M:CMS.Synchronization.IntegrationConnectorInfoProvider.GetIntegrationConnectorInfo(System.Int32)"> <summary> Returns integration connector with specified ID. </summary> <param name="connectorId">Integration connector ID.</param> </member> <member name="M:CMS.Synchronization.IntegrationConnectorInfoProvider.GetIntegrationConnectorInfo(System.String)"> <summary> Returns integration connector with specified name. </summary> <param name="connectorName">Integration connector name.</param> </member> <member name="M:CMS.Synchronization.IntegrationConnectorInfoProvider.SetIntegrationConnectorInfo(CMS.Synchronization.IntegrationConnectorInfo)"> <summary> Sets (updates or inserts) specified integration connector. </summary> <param name="connectorObj">Integration connector to be set.</param> </member> <member name="M:CMS.Synchronization.IntegrationConnectorInfoProvider.DeleteIntegrationConnectorInfo(CMS.Synchronization.IntegrationConnectorInfo)"> <summary> Deletes specified integration connector. </summary> <param name="connectorObj">Integration connector to be deleted.</param> </member> <member name="M:CMS.Synchronization.IntegrationConnectorInfoProvider.DeleteIntegrationConnectorInfo(System.Int32)"> <summary> Deletes integration connector with specified ID. </summary> <param name="connectorId">Integration connector ID.</param> </member> <member name="M:CMS.Synchronization.IntegrationConnectorInfoProvider.ClearHashtables(System.Boolean)"> <summary> Clear hashtables. </summary> <param name="logTasks">If true, web farm tasks are logged</param> </member> <member name="M:CMS.Synchronization.IntegrationConnectorInfoProvider.GetIntegrationConnectorsInternal(System.String,System.String,System.Int32,System.String)"> <summary> Returns dataset of all integration connectors matching the specified parameters. </summary> <param name="where">Where condition.</param> <param name="orderBy">Order by expression.</param> <param name="topN">Number of records to be selected.</param> <param name="columns">Columns to be selected.</param> </member> <member name="M:CMS.Synchronization.IntegrationConnectorInfoProvider.SetInfo(CMS.Synchronization.IntegrationConnectorInfo)"> <summary> Inserts or Updates the object to the database. </summary> <param name="info">Object to insert / update</param> </member> <member name="M:CMS.Synchronization.IntegrationConnectorInfoProvider.DeleteInfo(CMS.Synchronization.IntegrationConnectorInfo)"> <summary> Deletes the object to the database. </summary> <param name="info">Object to delete</param> </member> <member name="M:CMS.Synchronization.IntegrationConnectorInfoProvider.ProcessWebFarmTask(System.String,System.String,System.Byte[])"> <summary> Runs the processing of specific web farm task for current provider </summary> <param name="actionName">Action name</param> <param name="data">Custom data</param> <param name="binary">Binary data</param> </member> <member name="T:CMS.Synchronization.IntegrationSynchronizationInfo"> <summary> IntegrationSynchronizationInfo data container class. </summary> </member> <member name="F:CMS.Synchronization.IntegrationSynchronizationInfo.OBJECT_TYPE"> <summary> Object type </summary> </member> <member name="F:CMS.Synchronization.IntegrationSynchronizationInfo.TYPEINFO"> <summary> Type information. </summary> </member> <member name="P:CMS.Synchronization.IntegrationSynchronizationInfo.SynchronizationErrorMessage"> <summary> Error message (stored when synchronization fails). </summary> </member> <member name="P:CMS.Synchronization.IntegrationSynchronizationInfo.SynchronizationID"> <summary> Synchronization identifier. </summary> </member> <member name="P:CMS.Synchronization.IntegrationSynchronizationInfo.SynchronizationConnectorID"> <summary> Identifier of connector the synchronization is bound to. </summary> </member> <member name="P:CMS.Synchronization.IntegrationSynchronizationInfo.SynchronizationTaskID"> <summary> Identifier of task the synchronization is bound to. </summary> </member> <member name="P:CMS.Synchronization.IntegrationSynchronizationInfo.SynchronizationLastRun"> <summary> Last run date of synchronization. </summary> </member> <member name="P:CMS.Synchronization.IntegrationSynchronizationInfo.SynchronizationIsRunning"> <summary> Whether the synchronization of the related task is running. </summary> </member> <member name="M:CMS.Synchronization.IntegrationSynchronizationInfo.DeleteObject"> <summary> Deletes the object using appropriate provider. </summary> </member> <member name="M:CMS.Synchronization.IntegrationSynchronizationInfo.SetObject"> <summary> Updates the object using appropriate provider. </summary> </member> <member name="M:CMS.Synchronization.IntegrationSynchronizationInfo.#ctor"> <summary> Constructor - Creates an empty IntegrationSynchronizationInfo object. </summary> </member> <member name="M:CMS.Synchronization.IntegrationSynchronizationInfo.#ctor(System.Data.DataRow)"> <summary> Constructor - Creates a new IntegrationSynchronizationInfo object from the given DataRow. </summary> <param name="dr">DataRow with the object data</param> </member> <member name="T:CMS.Synchronization.IntegrationSynchronizationInfoProvider"> <summary> Class providing IntegrationSynchronizationInfo management. </summary> </member> <member name="M:CMS.Synchronization.IntegrationSynchronizationInfoProvider.GetIntegrationSynchronizations"> <summary> Returns all integration synchronization records. </summary> </member> <member name="M:CMS.Synchronization.IntegrationSynchronizationInfoProvider.GetIntegrationSynchronizationInfo(System.Int32)"> <summary> Returns integration synchronization with specified ID. </summary> <param name="synchronizationId">Integration synchronization ID</param> </member> <member name="M:CMS.Synchronization.IntegrationSynchronizationInfoProvider.GetIntegrationSynchronizationInfo(System.Int32,System.Int32)"> <summary> Gets synchronization specified by connector and task identifiers. </summary> <param name="connectorId">Connector identifier</param> <param name="taskId">Task identifier</param> </member> <member name="M:CMS.Synchronization.IntegrationSynchronizationInfoProvider.GetConnectorIdsForExternalTasks"> <summary> Gets list of connector IDs for pending external tasks. </summary> <returns>List of connector IDs for pending external tasks</returns> </member> <member name="M:CMS.Synchronization.IntegrationSynchronizationInfoProvider.SetIntegrationSynchronizationInfo(CMS.Synchronization.IntegrationSynchronizationInfo)"> <summary> Sets (updates or inserts) specified integration synchronization. </summary> <param name="synchronizationObj">Integration synchronization to be set</param> </member> <member name="M:CMS.Synchronization.IntegrationSynchronizationInfoProvider.DeleteIntegrationSynchronizationInfo(CMS.Synchronization.IntegrationSynchronizationInfo)"> <summary> Deletes specified integration synchronization. </summary> <param name="synchronizationObj">Integration synchronization to be deleted</param> </member> <member name="M:CMS.Synchronization.IntegrationSynchronizationInfoProvider.DeleteIntegrationSynchronizationInfo(System.Int32)"> <summary> Deletes integration synchronization with specified ID. </summary> <param name="synchronizationId">Integration synchronization ID</param> </member> <member name="M:CMS.Synchronization.IntegrationSynchronizationInfoProvider.SetIsRunning(System.Int32,System.Int32,System.Boolean)"> <summary> Sets a flag indicating that task is being processed. </summary> <param name="connectorId">Connector identifier</param> <param name="taskId">Task identifier</param> <param name="isRunning">Flag indicating that task is being processed</param> </member> <member name="M:CMS.Synchronization.IntegrationSynchronizationInfoProvider.DeleteInfo(CMS.Synchronization.IntegrationSynchronizationInfo)"> <summary> Deletes the object to the database. </summary> <param name="info">Object to delete</param> </member> <member name="T:CMS.Synchronization.IntegrationSyncLogInfo"> <summary> IntegrationSyncLogInfo data container class. </summary> </member> <member name="F:CMS.Synchronization.IntegrationSyncLogInfo.OBJECT_TYPE"> <summary> Object type </summary> </member> <member name="F:CMS.Synchronization.IntegrationSyncLogInfo.TYPEINFO"> <summary> Type information. </summary> </member> <member name="P:CMS.Synchronization.IntegrationSyncLogInfo.SyncLogID"> <summary> Synchronization log identifier. </summary> </member> <member name="P:CMS.Synchronization.IntegrationSyncLogInfo.SyncLogErrorMessage"> <summary> Error message (stored when synchronization fails). </summary> </member> <member name="P:CMS.Synchronization.IntegrationSyncLogInfo.SyncLogSynchronizationID"> <summary> Synchronization identifier which is the synchronization log bound to. </summary> </member> <member name="P:CMS.Synchronization.IntegrationSyncLogInfo.SyncLogTime"> <summary> Time of synchronization log event. </summary> </member> <member name="M:CMS.Synchronization.IntegrationSyncLogInfo.DeleteObject"> <summary> Deletes the object using appropriate provider. </summary> </member> <member name="M:CMS.Synchronization.IntegrationSyncLogInfo.SetObject"> <summary> Updates the object using appropriate provider. </summary> </member> <member name="M:CMS.Synchronization.IntegrationSyncLogInfo.#ctor"> <summary> Constructor - Creates an empty IntegrationSyncLogInfo object. </summary> </member> <member name="M:CMS.Synchronization.IntegrationSyncLogInfo.#ctor(System.Data.DataRow)"> <summary> Constructor - Creates a new IntegrationSyncLogInfo object from the given DataRow. </summary> <param name="dr">DataRow with the object data</param> </member> <member name="T:CMS.Synchronization.IntegrationSyncLogInfoProvider"> <summary> Class providing IntegrationSyncLogInfo management. </summary> </member> <member name="M:CMS.Synchronization.IntegrationSyncLogInfoProvider.GetIntegrationSynchronizationLogs"> <summary> Returns all integration synchronization logs. </summary> </member> <member name="M:CMS.Synchronization.IntegrationSyncLogInfoProvider.GetIntegrationSyncLogInfo(System.Int32)"> <summary> Returns integration synchronization log with specified ID. </summary> <param name="logId">Integration synchronization log ID</param> </member> <member name="M:CMS.Synchronization.IntegrationSyncLogInfoProvider.SetIntegrationSyncLogInfo(CMS.Synchronization.IntegrationSyncLogInfo)"> <summary> Sets (updates or inserts) specified integration synchronization log. </summary> <param name="logObj">Integration synchronization log to be set</param> </member> <member name="M:CMS.Synchronization.IntegrationSyncLogInfoProvider.DeleteIntegrationSyncLogInfo(CMS.Synchronization.IntegrationSyncLogInfo)"> <summary> Deletes specified integration synchronization log. </summary> <param name="logObj">Integration synchronization log to be deleted</param> </member> <member name="M:CMS.Synchronization.IntegrationSyncLogInfoProvider.DeleteIntegrationSyncLogInfo(System.Int32)"> <summary> Deletes integration synchronization log with specified ID. </summary> <param name="logId">Integration synchronization log ID</param> </member> <member name="M:CMS.Synchronization.IntegrationSyncLogInfoProvider.DeleteIntegrationSyncLogs(System.Int32)"> <summary> Deletes integration synchronization log specified by task and connector identifiers. </summary> <param name="synchronizationId">Synchronization identifier</param> </member> <member name="M:CMS.Synchronization.IntegrationSyncLogInfoProvider.DeleteIntegrationSyncLogsInternal(System.Int32)"> <summary> Deletes integration synchronization log specified by task and connector identifiers. </summary> <param name="synchronizationId">Synchronization identifier</param> </member> <member name="T:CMS.Synchronization.IntegrationTaskInfo"> <summary> IntegrationTaskInfo data container class. </summary> </member> <member name="F:CMS.Synchronization.IntegrationTaskInfo.OBJECT_TYPE"> <summary> Object type </summary> </member> <member name="F:CMS.Synchronization.IntegrationTaskInfo.TYPEINFO"> <summary> Type information. </summary> </member> <member name="P:CMS.Synchronization.IntegrationTaskInfo.TaskType"> <summary> Type of the task. </summary> </member> <member name="P:CMS.Synchronization.IntegrationTaskInfo.TaskID"> <summary> Task identifier. </summary> </member> <member name="P:CMS.Synchronization.IntegrationTaskInfo.TaskIsInbound"> <summary> Determines whether the task is inbound or outbound. </summary> </member> <member name="P:CMS.Synchronization.IntegrationTaskInfo.TaskObjectType"> <summary> Object type which the task is bound to. </summary> </member> <member name="P:CMS.Synchronization.IntegrationTaskInfo.TaskNodeID"> <summary> Node identifier which the task is bound to. </summary> </member> <member name="P:CMS.Synchronization.IntegrationTaskInfo.TaskSiteID"> <summary> Site identifier which the object is bound to. </summary> </member> <member name="P:CMS.Synchronization.IntegrationTaskInfo.TaskNodeAliasPath"> <summary> Node alias path which the task is bound to. </summary> </member> <member name="P:CMS.Synchronization.IntegrationTaskInfo.TaskProcessType"> <summary> Selected type of processing (applies only to inbound tasks). </summary> </member> <member name="P:CMS.Synchronization.IntegrationTaskInfo.TaskDataType"> <summary> Type of data. </summary> </member> <member name="P:CMS.Synchronization.IntegrationTaskInfo.TaskDocumentID"> <summary> Document identifier which the task is bound to. </summary> </member> <member name="P:CMS.Synchronization.IntegrationTaskInfo.TaskObjectID"> <summary> Object identifier which the task is bound to. </summary> </member> <member name="P:CMS.Synchronization.IntegrationTaskInfo.TaskTitle"> <summary> Title of the task. </summary> </member> <member name="P:CMS.Synchronization.IntegrationTaskInfo.TaskTime"> <summary> Time when the task was logged. </summary> </member> <member name="P:CMS.Synchronization.IntegrationTaskInfo.TaskData"> <summary> Task data. </summary> </member> <member name="M:CMS.Synchronization.IntegrationTaskInfo.DeleteObject"> <summary> Deletes the object using appropriate provider. </summary> </member> <member name="M:CMS.Synchronization.IntegrationTaskInfo.SetObject"> <summary> Updates the object using appropriate provider. </summary> </member> <member name="M:CMS.Synchronization.IntegrationTaskInfo.#ctor"> <summary> Constructor - Creates an empty IntegrationTaskInfo object. </summary> </member> <member name="M:CMS.Synchronization.IntegrationTaskInfo.#ctor(System.Data.DataRow)"> <summary> Constructor - Creates a new IntegrationTaskInfo object from the given DataRow. </summary> <param name="dr">DataRow with the object data</param> </member> <member name="T:CMS.Synchronization.IntegrationTaskInfoProvider"> <summary> Class providing IntegrationTaskInfo management. </summary> </member> <member name="M:CMS.Synchronization.IntegrationTaskInfoProvider.GetIntegrationTasks"> <summary> Returns all integration tasks. </summary> </member> <member name="M:CMS.Synchronization.IntegrationTaskInfoProvider.GetIntegrationTaskInfo(System.Int32)"> <summary> Returns integration task with specified ID. </summary> <param name="taskId">Integration task ID</param> </member> <member name="M:CMS.Synchronization.IntegrationTaskInfoProvider.SetIntegrationTaskInfo(CMS.Synchronization.IntegrationTaskInfo)"> <summary> Sets (updates or inserts) specified integration task. </summary> <param name="taskObj">Integration task to be set</param> </member> <member name="M:CMS.Synchronization.IntegrationTaskInfoProvider.DeleteIntegrationTaskInfo(CMS.Synchronization.IntegrationTaskInfo)"> <summary> Deletes specified integration task. </summary> <param name="taskObj">Integration task to be deleted</param> </member> <member name="M:CMS.Synchronization.IntegrationTaskInfoProvider.DeleteIntegrationTaskInfo(System.Int32)"> <summary> Deletes integration task with specified ID. </summary> <param name="taskId">Integration task ID</param> </member> <member name="M:CMS.Synchronization.IntegrationTaskInfoProvider.GetIntegrationTasksView(System.String,System.String,System.Int32,System.String)"> <summary> Returns dataset of all integration tasks from view matching the specified parameters. </summary> <param name="where">Where condition</param> <param name="orderBy">Order by expression</param> <param name="topN">Number of records to be selected</param> <param name="columns">Columns to be selected</param> </member> <member name="M:CMS.Synchronization.IntegrationTaskInfoProvider.LogInternalIntegration(CMS.DataEngine.GeneralizedInfo,CMS.DataEngine.TaskTypeEnum,CMS.Synchronization.TaskProcessTypeEnum,System.Int32,System.Collections.Generic.List{System.String})"> <summary> Logs the integration task for the given object. </summary> <param name="infoObj">Object to log</param> <param name="taskType">Task type</param> <param name="taskProcessType">Processing type</param> <param name="siteId">Task site identifier</param> <param name="connectorNames">Integration connector names for which to log the synchronization (nothing is logged when no connector is specified)</param> <returns>Returns new integration task</returns> </member> <member name="M:CMS.Synchronization.IntegrationTaskInfoProvider.LogExternalIntegration(CMS.DataEngine.GeneralizedInfo,CMS.DataEngine.TaskTypeEnum,CMS.Synchronization.TaskDataTypeEnum,CMS.Synchronization.IntegrationProcessTypeEnum,System.String,CMS.DataEngine.TranslationHelper,System.String)"> <summary> Logs the integration task for the given object. </summary> <param name="infoObj">Object to log</param> <param name="taskType">Task type</param> <param name="dataType">Type of data</param> <param name="result">What to do when processing fails</param> <param name="connectorName">Integration connector names for which to log the synchronization (nothing is logged when no connector is specified)</param> <param name="th">Translation helper</param> <param name="siteName">Site name of the target site (for site objects)</param> <returns>Returns new integration task</returns> </member> <member name="M:CMS.Synchronization.IntegrationTaskInfoProvider.FetchInternalTask(System.Int32,System.Int32)"> <summary> Fetches internal task for processing. </summary> <param name="connectorId">Connector identifier</param> <param name="minIntegrationTaskId">Task identifier to start from</param> <returns>Internal task to be processed</returns> </member> <member name="M:CMS.Synchronization.IntegrationTaskInfoProvider.FetchExternalTask(System.Int32,System.Int32)"> <summary> Fetches external task for processing. </summary> <param name="connectorId">Connector identifier</param> <param name="minIntegrationTaskId">Task identifier to start from</param> <returns>External task to be processed</returns> </member> <member name="M:CMS.Synchronization.IntegrationTaskInfoProvider.CreateSynchronization(System.String,CMS.Synchronization.IntegrationTaskInfo)"> <summary> Creates synchronization for given task and connector </summary> <param name="connectorName">Name of connector</param> <param name="taskInfo">Task info object</param> </member> <member name="M:CMS.Synchronization.IntegrationTaskInfoProvider.GetIntegrationTasksViewInternal(System.String,System.String,System.Int32,System.String)"> <summary> Returns dataset of all integration tasks from view matching the specified parameters. </summary> <param name="where">Where condition</param> <param name="orderBy">Order by expression</param> <param name="topN">Number of records to be selected</param> <param name="columns">Columns to be selected</param> </member> <member name="M:CMS.Synchronization.IntegrationTaskInfoProvider.LogInternalIntegrationInternal(CMS.DataEngine.GeneralizedInfo,CMS.DataEngine.TaskTypeEnum,CMS.Synchronization.TaskProcessTypeEnum,System.Int32,System.Collections.Generic.List{System.String})"> <summary> Logs the integration task for the given object. </summary> <param name="infoObj">Object to log</param> <param name="taskType">Task type</param> <param name="taskProcessType">Processing type</param> <param name="siteId">Task site identifier</param> <param name="connectorNames">Integration connector names for which to log the synchronization (nothing is logged when no connector is specified)</param> <returns>Returns new integration task</returns> </member> <member name="M:CMS.Synchronization.IntegrationTaskInfoProvider.LogExternalIntegrationInternal(CMS.DataEngine.GeneralizedInfo,CMS.DataEngine.TaskTypeEnum,CMS.Synchronization.TaskDataTypeEnum,CMS.Synchronization.IntegrationProcessTypeEnum,System.String,CMS.DataEngine.TranslationHelper,System.String)"> <summary> Logs the integration task for the given object. </summary> <param name="infoObj">Object to log</param> <param name="taskType">Task type</param> <param name="dataType">Type of data</param> <param name="result">What to do when processing fails</param> <param name="connectorName">Integration connector names for which to log the synchronization (nothing is logged when no connector is specified)</param> <param name="th">Translation helper</param> <param name="siteName">Site name of the target site (for site objects)</param> <returns>Returns new integration task</returns> </member> <member name="M:CMS.Synchronization.IntegrationTaskInfoProvider.FetchTask(System.Int32,System.Boolean,System.Int32)"> <summary> Fetches task for processing. </summary> <param name="connectorId">Connector identifier</param> <param name="internalTask">Whether to fetch internal or external task</param> <param name="minIntegrationTaskId">Task identifier to start from</param> <returns>Task to be processed</returns> </member> <member name="T:CMS.Synchronization.IntegrationTaskListInfo"> <summary> IntegrationTaskListInfo virtual object. </summary> </member> <member name="F:CMS.Synchronization.IntegrationTaskListInfo.OBJECT_TYPE"> <summary> Object type </summary> </member> <member name="F:CMS.Synchronization.IntegrationTaskListInfo.TYPEINFO"> <summary> Type information. </summary> </member> <member name="M:CMS.Synchronization.IntegrationTaskListInfo.#ctor"> <summary> Constructor - Creates an empty IntegrationTaskListInfo object. </summary> </member> <member name="M:CMS.Synchronization.IntegrationTaskListInfo.#ctor(System.Data.DataRow)"> <summary> Constructor - Creates a new IntegrationTaskListInfo object from the given DataRow. </summary> <param name="dr">DataRow with the object data</param> </member> <member name="M:CMS.Synchronization.IntegrationTaskListInfo.GetColumnNames"> <summary> Gets the default list of column names for this class </summary> </member> <member name="M:CMS.Synchronization.IntegrationTaskListInfo.GetDataQueryInternal"> <summary> Gets the data query for this object type </summary> </member> <member name="T:CMS.Synchronization.TaskDataTypeEnum"> <summary> Type of data contained in task to process. </summary> </member> <member name="F:CMS.Synchronization.TaskDataTypeEnum.Simple"> <summary> Just main object. </summary> </member> <member name="F:CMS.Synchronization.TaskDataTypeEnum.SimpleSnapshot"> <summary> Main object with translation information. </summary> </member> <member name="F:CMS.Synchronization.TaskDataTypeEnum.Snapshot"> <summary> Object with child objects and bindings. </summary> </member> <member name="T:CMS.Synchronization.TaskProcessTypeEnum"> <summary> Type of processing integration tasks. Determines whether the tasks are being processed asynchronously or synchronously with full or partial data. The types are ordered by priority (highest to lowest). </summary> </member> <member name="F:CMS.Synchronization.TaskProcessTypeEnum.SyncSnapshot"> <summary> Synchronous processing with complete object/document data (child objects etc.) Runs in context of the application allowing retrieving any additional data. This type is the first priority during processing. </summary> </member> <member name="F:CMS.Synchronization.TaskProcessTypeEnum.AsyncSnapshot"> <summary> Asynchronous processing with complete object/document data (child objects etc.) including all translations. This type is the second priority during processing. </summary> </member> <member name="F:CMS.Synchronization.TaskProcessTypeEnum.AsyncSimpleSnapshot"> <summary> Asynchronous processing with data of object/document itself (including its translations). This type is the third priority during processing. </summary> </member> <member name="F:CMS.Synchronization.TaskProcessTypeEnum.AsyncSimple"> <summary> Asynchronous processing with data of object/document itself (without any translations). This type is the fourth priority during processing. </summary> </member> <member name="T:CMS.Synchronization.AbstractSynchronizationSettingsExtensionMethods"> <summary> Extends <see cref="T:CMS.DataEngine.AbstractSynchronizationSettings"/> class. </summary> </member> <member name="M:CMS.Synchronization.AbstractSynchronizationSettingsExtensionMethods.InitUserAndTaskGroups(CMS.DataEngine.AbstractSynchronizationSettings)"> <summary> Sets <see cref="P:CMS.DataEngine.AbstractSynchronizationSettings.TaskGroups"/> and <see cref="P:CMS.DataEngine.AbstractSynchronizationSettings.User"/> for current instance of <see cref="T:CMS.DataEngine.AbstractSynchronizationSettings"/>, so the <see cref="T:CMS.Synchronization.StagingTaskInfo"/> is logged with <see cref="T:CMS.Base.IUserInfo"/> and grouped in <see cref="T:CMS.Synchronization.TaskGroupInfo"/>s. </summary> <remarks> Properties are set only in the main thread, they mustn't be set when processed by <see cref="T:CMS.Base.SimpleQueueWorker`1"/>. </remarks> <param name="settings">Current instance of <see cref="T:CMS.DataEngine.AbstractSynchronizationSettings"/></param> </member> <member name="T:CMS.Synchronization.SynchronizationQueueWorker"> <summary> Queue worker for processing of synchronization tasks </summary> </member> <member name="M:CMS.Synchronization.SynchronizationQueueWorker.ProcessItems(System.Collections.Generic.IEnumerable{CMS.Base.SimpleQueueItem})"> <summary> Processes the given list of items. Override this method to process queued items as a bulk. Returns the number of processed items. </summary> <param name="items">Worker queue.</param> </member> <member name="T:CMS.Synchronization.ISynchronizationTask"> <summary> Represents generic synchronization task. </summary> </member> <member name="P:CMS.Synchronization.ISynchronizationTask.TaskID"> <summary> Task identifier. </summary> </member> <member name="P:CMS.Synchronization.ISynchronizationTask.TaskTitle"> <summary> Caption of the task. </summary> </member> <member name="P:CMS.Synchronization.ISynchronizationTask.TaskData"> <summary> Data of the task. (Usually XML) </summary> </member> <member name="T:CMS.Synchronization.SynchronizationModuleMetadata"> <summary> Represents the Synchronization module metadata. </summary> </member> <member name="M:CMS.Synchronization.SynchronizationModuleMetadata.#ctor"> <summary> Default constructor </summary> </member> <member name="T:CMS.Synchronization.SynchronizationHandlers"> <summary> Synchronization handlers </summary> </member> <member name="M:CMS.Synchronization.SynchronizationHandlers.Init"> <summary> Initializes the synchronization handlers </summary> </member> <member name="M:CMS.Synchronization.SynchronizationHandlers.ProcessInternalTasksAsync_Execute(System.Object,System.EventArgs)"> <summary> Processes integration tasks asynchronously for all touched connectors. </summary> <remarks> Ideally integration tasks should be inserted and connectors touched asynchronously through <see cref="T:CMS.Synchronization.SynchronizationQueueWorker"/>. However if anyone would want to log integration tasks synchronously from request, touching connectors is done here. </remarks> </member> <member name="M:CMS.Synchronization.SynchronizationHandlers.Delete_Before(System.Object,CMS.DataEngine.ObjectEventArgs)"> <summary> Actions that execute before object deletion </summary> </member> <member name="M:CMS.Synchronization.SynchronizationHandlers.Delete_After(System.Object,CMS.DataEngine.ObjectEventArgs)"> <summary> Actions that execute after object deletion </summary> </member> <member name="M:CMS.Synchronization.SynchronizationHandlers.Insert_Before(System.Object,CMS.DataEngine.ObjectEventArgs)"> <summary> Actions that execute before object insert </summary> </member> <member name="M:CMS.Synchronization.SynchronizationHandlers.Insert_After(System.Object,CMS.DataEngine.ObjectEventArgs)"> <summary> Actions that execute after object insert </summary> </member> <member name="M:CMS.Synchronization.SynchronizationHandlers.Update_Before(System.Object,CMS.DataEngine.ObjectEventArgs)"> <summary> Actions that execute before object update </summary> </member> <member name="M:CMS.Synchronization.SynchronizationHandlers.StartSynchronizationHandler(CMS.DataEngine.ObjectEventArgs)"> <summary> Starts the synchronization handler (actions that are common for all handlers) </summary> <param name="e">Event arguments</param> </member> <member name="T:CMS.Synchronization.SynchronizationHelper"> <summary> Class providing management for the synchronization. </summary> </member> <member name="P:CMS.Synchronization.SynchronizationHelper.UseCheckinCheckout"> <summary> Indicates whether object locking is enabled within the system. </summary> </member> <member name="M:CMS.Synchronization.SynchronizationHelper.GetExcludedSettingKeys"> <summary> Returns set of excluded setting key names. Can return null if there are no excluded keys. </summary> </member> <member name="M:CMS.Synchronization.SynchronizationHelper.AddExcludedSettingKey(System.String[])"> <summary> Adds given setting key to the excluded keys. For excluded keys synchronization tasks are not logged. </summary> <param name="names">Names of the settings key</param> </member> <member name="M:CMS.Synchronization.SynchronizationHelper.RemoveExcludedSettingKey(System.String[])"> <summary> Removes given setting key from the excluded keys. For excluded keys synchronization tasks are not logged. </summary> <param name="names">Names of the settings key</param> </member> <member name="M:CMS.Synchronization.SynchronizationHelper.IsSettingKeyExcluded(System.String)"> <summary> Determines whether the given setting key is excluded from synchronization. </summary> <param name="name">Name of the settings key</param> </member> <member name="M:CMS.Synchronization.SynchronizationHelper.IsCheckedOutByOtherUser(CMS.DataEngine.BaseInfo)"> <summary> Returns true if the object is checked out by other user than a current user (and use checkin/out is used). </summary> </member> <member name="M:CMS.Synchronization.SynchronizationHelper.GetObjectXml(CMS.DataEngine.SynchronizationObjectSettings,CMS.DataEngine.GeneralizedInfo,CMS.DataEngine.TaskTypeEnum)"> <summary> Gets XML with data for specified object. </summary> <param name="settings">Object export settings (some settings are internally set according to task type)</param> <param name="infoObj">Object to get data for</param> <param name="taskType">Task type</param> </member> <member name="M:CMS.Synchronization.SynchronizationHelper.GetObjectKey(CMS.DataEngine.OperationTypeEnum,CMS.DataEngine.GeneralizedInfo,CMS.DataEngine.TaskTypeEnum)"> <summary> Gets object key for specified task type. </summary> <param name="operationType">Operation type</param> <param name="infoObj">Info object instance</param> <param name="taskType">Task type</param> </member> <member name="M:CMS.Synchronization.SynchronizationHelper.GetObjectsData(CMS.DataEngine.OperationTypeEnum,CMS.DataEngine.BaseInfo,System.String,System.String,System.Boolean,System.Boolean,CMS.DataEngine.TranslationHelper)"> <summary> Gets the DataSet of the objects data and their child objects. </summary> <param name="operationType">Operation type</param> <param name="infoObj">Main info object</param> <param name="whereCondition">Where condition</param> <param name="orderBy">Order by columns for the main objects</param> <param name="childData">If true, child objects data are included</param> <param name="binaryData">If true, binary data are included</param> <param name="th">Translation table to initialize with data bindings</param> </member> <member name="M:CMS.Synchronization.SynchronizationHelper.GetObjectData(CMS.DataEngine.OperationTypeEnum,CMS.DataEngine.GeneralizedInfo,System.Boolean,System.Boolean,CMS.DataEngine.TranslationHelper)"> <summary> Gets the object data for synchronization. </summary> <param name="operationType">Operation type</param> <param name="infoObj">Main info object</param> <param name="childData">If true, child objects data are included</param> <param name="binaryData">If true, binary data are included</param> <param name="th">Translation table to initialize with data bindings</param> </member> <member name="M:CMS.Synchronization.SynchronizationHelper.GetObjectBinaryXml(CMS.DataEngine.OperationTypeEnum,System.String,System.Int32,CMS.DataEngine.TaskTypeEnum)"> <summary> Gets binary XML data for given object. </summary> <param name="operationType">Operation type</param> <param name="objectType">Object type</param> <param name="objectId">Object ID</param> <param name="taskType">Task type</param> </member> <member name="M:CMS.Synchronization.SynchronizationHelper.GetObjectWhereCondition(System.String,System.Int32)"> <summary> Gets the where condition for specified type of object. </summary> <param name="objectType">Object type</param> <param name="siteId">Site ID for the site objects</param> </member> <member name="M:CMS.Synchronization.SynchronizationHelper.LogObjectChange(CMS.DataEngine.BaseInfo,CMS.DataEngine.TaskTypeEnum)"> <summary> Logs object change. </summary> <param name="infoObj">Object to log</param> <param name="taskType">Type of the task</param> </member> <member name="M:CMS.Synchronization.SynchronizationHelper.LogObjectChange(CMS.DataEngine.BaseInfo,CMS.DataEngine.TaskTypeEnum,System.Boolean)"> <summary> Logs object change. </summary> <param name="infoObj">Object to log</param> <param name="taskType">Type of the task</param> <param name="runAsync">If true, the change log should run asynchronously</param> </member> <member name="M:CMS.Synchronization.SynchronizationHelper.LogObjectChange(CMS.DataEngine.LogObjectChangeSettings)"> <summary> Logs object change for different type of synchronization. </summary> <param name="settings">Log object change settings</param> <returns>List of synchronization tasks</returns> </member> <member name="M:CMS.Synchronization.SynchronizationHelper.LogTasksWithUserAndTaskGroups(System.Collections.Generic.IEnumerable{CMS.Synchronization.ISynchronizationTask},System.Collections.Generic.IEnumerable{CMS.DataEngine.IStagingTaskGroup},CMS.Base.IUserInfo)"> <summary> Logs <see cref="T:CMS.Synchronization.StagingTaskInfo"/>s with <see cref="T:CMS.Base.IUserInfo"/> and <see cref="T:CMS.Synchronization.TaskGroupInfo"/>s. </summary> <param name="tasks">Staging tasks to log</param> <param name="taskGroups">Task groups in which staging tasks belong</param> <param name="user">User to log staging tasks with</param> </member> <member name="M:CMS.Synchronization.SynchronizationHelper.LogObjectChange(System.String,System.Int32,System.DateTime,CMS.DataEngine.TaskTypeEnum,System.Boolean,System.Boolean,System.Boolean,System.Boolean,System.Boolean,System.Int32,System.Int32)"> <summary> Logs the synchronization for specified group of objects. </summary> <param name="objectTypes">Object types (list of object type constants separated by semicolon)</param> <param name="objectsSiteId">Objects site ID</param> <param name="modifiedFrom">Time from which the objects were modified</param> <param name="taskType">Task type</param> <param name="logStaging">Indicates if the staging task should be logged</param> <param name="logIntegration">Indicates if the integration task should be logged</param> <param name="logExport">Indicates if the export task should be logged</param> <param name="createVersion">Indicates if the version should be created</param> <param name="runAsync">Indicates if the logging should be asynchronous</param> <param name="siteId">Site ID for synchronization</param> <param name="serverId">Server ID for synchronization</param> </member> <member name="M:CMS.Synchronization.SynchronizationHelper.ChangeSiteBindingObject(CMS.DataEngine.GeneralizedInfo@,System.Int32@,CMS.DataEngine.TaskTypeEnum@)"> <summary> Changes site binding object to the parent object. </summary> <param name="infoObj">Info object instance</param> <param name="siteId">Original site ID</param> <param name="taskType">Original task type</param> <returns>Returns TRUE if site binding object was changed.</returns> </member> <member name="M:CMS.Synchronization.SynchronizationHelper.LogObjectDelete(CMS.DataEngine.BaseInfo)"> <summary> Logs the object deletion. </summary> <param name="infoObj">Info object to log</param> </member> <member name="M:CMS.Synchronization.SynchronizationHelper.TouchParent(CMS.DataEngine.BaseInfo,CMS.DataEngine.TaskTypeEnum)"> <summary> Touch the parent. </summary> <param name="infoObj">Info object to log</param> <param name="taskType">Type of the task</param> </member> <member name="M:CMS.Synchronization.SynchronizationHelper.TouchParentInsert(CMS.DataEngine.BaseInfo)"> <summary> Touch the parent when inserting an object. </summary> <param name="infoObj">Info object to log</param> </member> <member name="M:CMS.Synchronization.SynchronizationHelper.TouchParentUpdate(CMS.DataEngine.BaseInfo)"> <summary> Touch the parent when updating an object. </summary> <param name="infoObj">Info object to log</param> </member> <member name="M:CMS.Synchronization.SynchronizationHelper.TouchParentDelete(CMS.DataEngine.BaseInfo)"> <summary> Touch the parent when deleting an object. </summary> <param name="infoObj">Info object to log</param> </member> <member name="M:CMS.Synchronization.SynchronizationHelper.GetTouchParentSettings(CMS.DataEngine.BaseInfo,CMS.DataEngine.TaskTypeEnum)"> <summary> Gets the object change settings for touch parent actions </summary> <param name="infoObj">Info object</param> <param name="taskType">Task type</param> </member> <member name="M:CMS.Synchronization.SynchronizationHelper.LogObjectUpdate(CMS.DataEngine.BaseInfo,System.Boolean,System.Boolean)"> <summary> Logs the object update. </summary> <param name="infoObj">Info object to log</param> <param name="runAsync">Indicates if the logging should run asynchronously</param> <param name="addToSite">If true, object is being assigned to the site</param> </member> <member name="M:CMS.Synchronization.SynchronizationHelper.LogObjectInsert(CMS.DataEngine.BaseInfo,System.Boolean,System.Boolean)"> <summary> Logs the object insert. </summary> <param name="infoObj">Info object to log</param> <param name="runAsync">Indicates if the logging should run asynchronously</param> <param name="addToSite">If true, object is being assigned to the site</param> </member> <member name="M:CMS.Synchronization.SynchronizationHelper.CheckStagingLogging(CMS.DataEngine.GeneralizedInfo)"> <summary> Indicates if the staging task should be logged. </summary> <param name="infoObj">Info object instance</param> </member> <member name="M:CMS.Synchronization.SynchronizationHelper.CheckIntegrationLogging(CMS.DataEngine.GeneralizedInfo)"> <summary> Indicates if the integration task should be logged. </summary> <param name="infoObj">Info object instance</param> </member> <member name="M:CMS.Synchronization.SynchronizationHelper.CheckCreateVersion(CMS.DataEngine.GeneralizedInfo,CMS.DataEngine.TaskTypeEnum)"> <summary> Indicates if the object version should be created. </summary> <param name="infoObj">Info object instance</param> <param name="taskType">Task type</param> </member> <member name="M:CMS.Synchronization.SynchronizationHelper.EnsureObjectVersion(CMS.DataEngine.BaseInfo)"> <summary> Ensure object version if not existing. </summary> <param name="infoObj">Object which version should be ensured</param> </member> <member name="M:CMS.Synchronization.SynchronizationHelper.RemoveObjectVersions(CMS.DataEngine.BaseInfo)"> <summary> Destroy object and child object versions </summary> <param name="infoObj">IInfo object which versions will be destroyed</param> </member> <member name="M:CMS.Synchronization.SynchronizationHelper.IsPostProcessingAllowedForFailedTranslation(CMS.DataEngine.ObjectTypeInfo,System.Collections.Generic.IEnumerable{System.String})"> <summary> Indicates whether object can be post-processed within the process of Import/Export or Staging because of potential reference to the object of the same object type which wasn't processed yet. </summary> <param name="typeInfo">Processed object type information.</param> <param name="failedTranslationColumnNames">Collection of column names whose values could not be translated.</param> <exception cref="T:System.ArgumentNullException">Thrown when <paramref name="typeInfo"/> is not defined.</exception> </member> <member name="M:CMS.Synchronization.SynchronizationHelper.GetSelfDependencyColumnNames(CMS.DataEngine.ObjectTypeInfo)"> <summary> Returns a collection of column names that reference to a dependency of the same object type as the given object type. </summary> <remarks>Dynamic object types are skipped.</remarks> <param name="typeInfo">Type info object.</param> </member> <member name="M:CMS.Synchronization.SynchronizationHelper.IsSelfDependencyObjectType(CMS.DataEngine.ObjectDependency,CMS.DataEngine.ObjectTypeInfo,System.Nullable{System.Boolean})"> <summary> Returns true if <paramref name="dependency"/> is referencing to the same object type as defined in <paramref name="typeInfo"/> or to the <see cref="P:CMS.DataEngine.ObjectTypeInfo.ParentObjectType"/> for binding object referencing to itself. </summary> <param name="dependency">Dependency to be examined.</param> <param name="typeInfo">Type information object holding the <paramref name="dependency"/>.</param> <param name="isSelfBinding">Optional parameter for performance optimization. If not provided self binding object is detected automatically.</param> </member> <member name="M:CMS.Synchronization.SynchronizationHelper.GetObject(System.Data.DataRow,System.String)"> <summary> Gets the object created from the given DataRow. </summary> <param name="objectRow">Object DataRow</param> <param name="objectType">Object type</param> </member> <member name="T:CMS.Synchronization.SynchronizationModule"> <summary> Represents the Synchronization module. </summary> </member> <member name="M:CMS.Synchronization.SynchronizationModule.#ctor"> <summary> Default constructor </summary> </member> <member name="M:CMS.Synchronization.SynchronizationModule.OnInit"> <summary> Initializes the module </summary> </member> <member name="T:CMS.Synchronization.ServerAuthenticationEnum"> <summary> Server authentication modes. </summary> </member> <member name="F:CMS.Synchronization.ServerAuthenticationEnum.UserName"> <summary> User name / password authentication. </summary> </member> <member name="F:CMS.Synchronization.ServerAuthenticationEnum.X509"> <summary> X509 authentication. </summary> </member> <member name="T:CMS.Synchronization.ServerInfo"> <summary> ServerInfo data container class. </summary> </member> <member name="F:CMS.Synchronization.ServerInfo.OBJECT_TYPE"> <summary> Object type </summary> </member> <member name="F:CMS.Synchronization.ServerInfo.TYPEINFO"> <summary> Type information. </summary> </member> <member name="P:CMS.Synchronization.ServerInfo.ServerSiteID"> <summary> Server site ID. </summary> </member> <member name="P:CMS.Synchronization.ServerInfo.ServerX509ServerKeyID"> <summary> Server X509 server key ID. </summary> </member> <member name="P:CMS.Synchronization.ServerInfo.ServerPassword"> <summary> Server password. </summary> </member> <member name="P:CMS.Synchronization.ServerInfo.ServerAuthentication"> <summary> Server authentication. </summary> </member> <member name="P:CMS.Synchronization.ServerInfo.ServerID"> <summary> Server ID. </summary> </member> <member name="P:CMS.Synchronization.ServerInfo.ServerDisplayName"> <summary> Server display name. </summary> </member> <member name="P:CMS.Synchronization.ServerInfo.ServerURL"> <summary> Server url. </summary> </member> <member name="P:CMS.Synchronization.ServerInfo.ServerX509ClientKeyID"> <summary> Server X509 client key ID. </summary> </member> <member name="P:CMS.Synchronization.ServerInfo.ServerName"> <summary> Server name. </summary> </member> <member name="P:CMS.Synchronization.ServerInfo.ServerUsername"> <summary> Server user name. </summary> </member> <member name="P:CMS.Synchronization.ServerInfo.ServerEnabled"> <summary> Server enabled. </summary> </member> <member name="P:CMS.Synchronization.ServerInfo.ServerGUID"> <summary> Server GUID. </summary> </member> <member name="P:CMS.Synchronization.ServerInfo.ServerLastModified"> <summary> Object last modified. </summary> </member> <member name="M:CMS.Synchronization.ServerInfo.DeleteObject"> <summary> Deletes the object using appropriate provider. </summary> </member> <member name="M:CMS.Synchronization.ServerInfo.SetObject"> <summary> Updates the object using appropriate provider. </summary> </member> <member name="M:CMS.Synchronization.ServerInfo.CheckPermissionsInternal(CMS.DataEngine.PermissionsEnum,System.String,CMS.Base.IUserInfo,System.Boolean)"> <summary> Checks the permissions of the object. </summary> <param name="permission">Permission type</param> <param name="siteName">Name of the site</param> <param name="userInfo">UserInfo object</param> <param name="exceptionOnFailure">If true, PermissionCheckException is thrown whenever a permission check fails</param> </member> <member name="M:CMS.Synchronization.ServerInfo.RemoveObjectDependencies(System.Boolean,System.Boolean)"> <summary> Removes object dependencies. First tries to execute removedependencies query, if not found, automatic process is executed. </summary> <param name="deleteAll">If false, only required dependencies are deleted, dependencies with default value are replaced with default value and nullable values are replaced with null</param> <param name="clearHashtables">If true, hashtables of all objecttypes which were potentionally modified are cleared</param> </member> <member name="M:CMS.Synchronization.ServerInfo.CheckLicense(CMS.DataEngine.ObjectActionEnum,System.String)"> <summary> Checks the object license. Returns true if the licensing conditions for this object were matched. </summary> <param name="action">Object action</param> <param name="domainName">Domain name, if not set, uses current domain</param> </member> <member name="M:CMS.Synchronization.ServerInfo.#ctor"> <summary> Constructor - Creates an empty ServerInfo object. </summary> </member> <member name="M:CMS.Synchronization.ServerInfo.#ctor(System.Data.DataRow)"> <summary> Constructor - Creates a new ServerInfo object from the given DataRow. </summary> </member> <member name="T:CMS.Synchronization.ServerInfoProvider"> <summary> Class providing ServerInfo management. </summary> </member> <member name="M:CMS.Synchronization.ServerInfoProvider.#ctor"> <summary> Constructor </summary> </member> <member name="M:CMS.Synchronization.ServerInfoProvider.GetServers"> <summary> Returns all servers. </summary> </member> <member name="M:CMS.Synchronization.ServerInfoProvider.GetServerInfoByGUID(System.Guid,System.Int32)"> <summary> Returns object with specified GUID. </summary> <param name="guid">Object GUID</param> <param name="siteId">Site ID</param> </member> <member name="M:CMS.Synchronization.ServerInfoProvider.GetServerInfo(System.Int32)"> <summary> Returns the ServerInfo structure for the specified server. </summary> <param name="serverId">Server id</param> </member> <member name="M:CMS.Synchronization.ServerInfoProvider.GetServerInfo(System.String,System.Int32)"> <summary> Returns the ServerInfo structure for the specified server. </summary> <param name="serverName">Server name</param> <param name="siteId">Site ID</param> </member> <member name="M:CMS.Synchronization.ServerInfoProvider.SetServerInfo(CMS.Synchronization.ServerInfo)"> <summary> Sets (updates or inserts) specified server. </summary> <param name="serverObj">Server to set</param> </member> <member name="M:CMS.Synchronization.ServerInfoProvider.DeleteServerInfo(CMS.Synchronization.ServerInfo)"> <summary> Deletes specified server. </summary> <param name="serverObj">Server object</param> </member> <member name="M:CMS.Synchronization.ServerInfoProvider.DeleteServerInfo(System.Int32)"> <summary> Deletes specified server. </summary> <param name="serverId">Server id</param> </member> <member name="M:CMS.Synchronization.ServerInfoProvider.IsEnabledServer(System.Int32)"> <summary> Indicates if there is at least one enabled staging server. </summary> <param name="siteId">Site ID</param> </member> <member name="M:CMS.Synchronization.ServerInfoProvider.FilterEnabledServers(System.Collections.Generic.List{System.Int32})"> <summary> Removes all site IDs that don't have any enabled server. </summary> <param name="siteIDs">Set of site ids to start with.</param> </member> <member name="T:CMS.Synchronization.SynchronizationInfo"> <summary> SynchronizationInfo data container class. </summary> </member> <member name="F:CMS.Synchronization.SynchronizationInfo.OBJECT_TYPE"> <summary> Object type </summary> </member> <member name="F:CMS.Synchronization.SynchronizationInfo.TYPEINFO"> <summary> Type information. </summary> </member> <member name="P:CMS.Synchronization.SynchronizationInfo.SynchronizationID"> <summary> Synchronization ID. </summary> </member> <member name="P:CMS.Synchronization.SynchronizationInfo.SynchronizationErrorMessage"> <summary> Synchronization error message. </summary> </member> <member name="P:CMS.Synchronization.SynchronizationInfo.SynchronizationLastRun"> <summary> Synchronization last run. </summary> </member> <member name="P:CMS.Synchronization.SynchronizationInfo.SynchronizationTaskID"> <summary> Synchronization task ID. </summary> </member> <member name="P:CMS.Synchronization.SynchronizationInfo.SynchronizationServerID"> <summary> Synchronization server ID. </summary> </member> <member name="M:CMS.Synchronization.SynchronizationInfo.DeleteObject"> <summary> Deletes the object using appropriate provider. </summary> </member> <member name="M:CMS.Synchronization.SynchronizationInfo.SetObject"> <summary> Updates the object using appropriate provider. </summary> </member> <member name="M:CMS.Synchronization.SynchronizationInfo.CheckPermissionsInternal(CMS.DataEngine.PermissionsEnum,System.String,CMS.Base.IUserInfo,System.Boolean)"> <summary> Checks the permissions of the object. </summary> <param name="permission">Permission type</param> <param name="siteName">Name of the site</param> <param name="userInfo">UserInfo object</param> <param name="exceptionOnFailure">If true, PermissionCheckException is thrown whenever a permission check fails</param> </member> <member name="M:CMS.Synchronization.SynchronizationInfo.#ctor"> <summary> Constructor - Creates an empty SynchronizationInfo object. </summary> </member> <member name="M:CMS.Synchronization.SynchronizationInfo.#ctor(System.Data.DataRow)"> <summary> Constructor - Creates a new SynchronizationInfo object from the given DataRow. </summary> </member> <member name="T:CMS.Synchronization.SynchronizationInfoProvider"> <summary> Class providing SynchronizationInfo management. </summary> </member> <member name="F:CMS.Synchronization.SynchronizationInfoProvider.ENABLED_SERVERS"> <summary> Constant used to specify all the enabled servers. </summary> </member> <member name="M:CMS.Synchronization.SynchronizationInfoProvider.GetSynchronizations"> <summary> Returns all synchronization records. </summary> </member> <member name="M:CMS.Synchronization.SynchronizationInfoProvider.GetSynchronizationInfo(System.Int32)"> <summary> Returns the SynchronizationInfo structure for the specified synchronization. </summary> <param name="synchronizationId">Synchronization id</param> </member> <member name="M:CMS.Synchronization.SynchronizationInfoProvider.GetTasksSynchronization(System.Collections.Generic.ICollection{System.Int32},System.Int32,System.Int32)"> <summary> Returns all the tasks synchronization info records based on given parameters. When serverId is specified, the siteId parameter is ignored. When siteId is specified and serverId is 0 method returns records that belongs to all servers that are assigned to given site. </summary> <param name="taskIds">Task IDs</param> <param name="serverId">Server ID</param> <param name="siteId">Site ID</param> </member> <member name="M:CMS.Synchronization.SynchronizationInfoProvider.SetSynchronizationInfo(CMS.Synchronization.SynchronizationInfo)"> <summary> Sets (updates or inserts) specified synchronization. </summary> <param name="synchronization">Synchronization to set</param> </member> <member name="M:CMS.Synchronization.SynchronizationInfoProvider.DeleteSynchronizationInfo(CMS.Synchronization.SynchronizationInfo,System.Boolean)"> <summary> Deletes specified synchronization. </summary> <param name="synchronizationObj">Synchronization object</param> <param name="deleteTask">When true and after delete there are no synchronization records with same task left, the task will be deleted as well.</param> </member> <member name="M:CMS.Synchronization.SynchronizationInfoProvider.DeleteSynchronizationInfo(System.Int32,System.Boolean)"> <summary> Deletes specified synchronization. </summary> <param name="synchronizationId">Synchronization id</param> <param name="deleteTask">When true and after delete there are no synchronization records with same task left, the task will be deleted as well.</param> </member> <member name="M:CMS.Synchronization.SynchronizationInfoProvider.DeleteSynchronizationInfos(System.Collections.Generic.ICollection{System.Int32},System.Int32,System.Int32)"> <summary> Deletes the synchronization info records. When serverId is specified, the siteId parameter is ignored. When siteId is specified and serverId is 0 method deletes records that belongs to all servers that are assigned to given site. </summary> <remarks>This site does not clean orphaned staging tasks. Call <see cref="M:CMS.Synchronization.StagingTaskInfoProvider.DeleteOrphanedTasks(System.Collections.Generic.ICollection{System.Int32})"/> if appropriate.</remarks> <param name="taskIds">Task IDs</param> <param name="serverId">Server ID</param> <param name="siteId">Site ID</param> </member> <member name="M:CMS.Synchronization.SynchronizationInfoProvider.DeleteSynchronizationInfo(System.Int32,System.Int32,System.Int32,System.Boolean)"> <summary> Deletes the synchronization info record. When serverId is specified, the siteId parameter is ignored. When siteId is specified and serverId is 0 method deletes records that belongs to all servers that are assigned to given site. </summary> <param name="taskId">Task ID</param> <param name="serverId">Server ID</param> <param name="siteId">Site ID</param> <param name="deleteTask">When true and after delete there are no synchronization records with same task left, the task will be deleted as well.</param> </member> <member name="M:CMS.Synchronization.SynchronizationInfoProvider.DeleteInstanceGlobalTasks(System.Collections.Generic.ICollection{System.Int32},CMS.Synchronization.ServerInfo)"> <summary> Deletes all synchronizations records for given server (instance) name except the given server. Global synchronization tasks are created for all servers. This method deletes records for all servers with given server name except one. </summary> <remarks>This site does not clean orphaned staging tasks. Call <see cref="M:CMS.Synchronization.StagingTaskInfoProvider.DeleteOrphanedTasks(System.Collections.Generic.ICollection{System.Int32})"/> if appropriate.</remarks> <param name="taskIds">Task identifier</param> <param name="server">Server on which the tasks were processed</param> </member> <member name="M:CMS.Synchronization.SynchronizationInfoProvider.CreateSynchronizationRecords(System.Int32,System.Collections.Generic.IEnumerable{System.Int32})"> <summary> Creates synchronization records for given task and servers. </summary> <param name="taskId">Task ID.</param> <param name="serverIds">Server IDs</param> </member> <member name="M:CMS.Synchronization.SynchronizationInfoProvider.GetTaskSynchronizationInternal(System.Int32,System.Int32,System.Int32)"> <summary> Returns all the tasks synchronization info records based on given parameters. When serverId is specified, the siteId parameter is ignored. When siteId is specified and serverId is 0 method returns records that belongs to all servers that are assigned to given site. </summary> <param name="taskId">Task ID</param> <param name="serverId">Server ID</param> <param name="siteId">Site ID</param> </member> <member name="M:CMS.Synchronization.SynchronizationInfoProvider.GetTasksSynchronizationInternal(System.Collections.Generic.ICollection{System.Int32},System.Int32,System.Int32)"> <summary> Returns all the tasks synchronization info records based on given parameters. When serverId is specified, the siteId parameter is ignored. When siteId is specified and serverId is 0 method returns records that belongs to all servers that are assigned to given site. </summary> <param name="taskIds">Task IDs</param> <param name="serverId">Server ID</param> <param name="siteId">Site ID</param> </member> <member name="M:CMS.Synchronization.SynchronizationInfoProvider.DeleteSynchronizationInfoInternal(CMS.Synchronization.SynchronizationInfo,System.Boolean)"> <summary> Deletes specified synchronization. </summary> <param name="synchronizationObj">Synchronization object</param> <param name="deleteTask">When true and after delete there are no synchronization records with same task left, the task will be deleted as well.</param> </member> <member name="M:CMS.Synchronization.SynchronizationInfoProvider.DeleteSynchronizationInfoInternal(System.Int32,System.Boolean)"> <summary> Deletes specified synchronization. </summary> <param name="synchronizationId">Synchronization id</param> <param name="deleteTask">When true and after delete there are no synchronization records with same task left, the task will be deleted as well.</param> </member> <member name="M:CMS.Synchronization.SynchronizationInfoProvider.DeleteSynchronizationInfoInternal(System.Collections.Generic.ICollection{System.Int32},System.Int32,System.Int32)"> <summary> Deletes the synchronization info record. When serverId is specified, the siteId parameter is ignored. When siteId is specified and serverId is 0 method deletes records that belongs to all servers that are assigned to given site. </summary> <remarks>This site does not clean orphaned staging tasks. Call <see cref="M:CMS.Synchronization.StagingTaskInfoProvider.DeleteOrphanedTasks(System.Collections.Generic.ICollection{System.Int32})"/> if appropriate.</remarks> <param name="taskIds">Task IDs</param> <param name="serverId">Server ID</param> <param name="siteId">Site ID</param> </member> <member name="M:CMS.Synchronization.SynchronizationInfoProvider.DeleteSynchronizationInfoInternal(System.Int32,System.Int32,System.Int32,System.Boolean)"> <summary> Deletes the synchronization info record. When serverId is specified, the siteId parameter is ignored. When siteId is specified and serverId is 0 method deletes records that belongs to all servers that are assigned to given site. </summary> <param name="taskId">Task ID</param> <param name="serverId">Server ID</param> <param name="siteId">Site ID</param> <param name="deleteTask">When true and after delete there are no synchronization records with same task left, the task will be deleted as well.</param> </member> <member name="M:CMS.Synchronization.SynchronizationInfoProvider.DeleteInstanceGlobalTasksInternal(System.Collections.Generic.ICollection{System.Int32},CMS.Synchronization.ServerInfo)"> <summary> Deletes all synchronizations records for given server (instance) name except the given server. Global synchronization tasks are created for all servers. This method deletes records for all servers with given server name except one. </summary> <remarks>This site does not clean orphaned staging tasks. Call <see cref="M:CMS.Synchronization.StagingTaskInfoProvider.DeleteOrphanedTasks(System.Collections.Generic.ICollection{System.Int32})"/> if appropriate.</remarks> <param name="taskIds">Task identifier</param> <param name="server">Server on which the tasks were processed</param> </member> <member name="T:CMS.Synchronization.StagingTaskInfo"> <summary> TaskInfo data container class. </summary> </member> <member name="F:CMS.Synchronization.StagingTaskInfo.PERMISSION_MANAGE_ALL_TASKS"> <summary> Permission name that allows user manage all kind of staging tasks. </summary> </member> <member name="F:CMS.Synchronization.StagingTaskInfo.PERMISSION_MANAGE_DOCUMENT_TASKS"> <summary> Permission name that allows user manage document staging tasks. </summary> </member> <member name="F:CMS.Synchronization.StagingTaskInfo.PERMISSION_MANAGE_OBJECT_TASKS"> <summary> Permission name that allows user manage object staging tasks. </summary> </member> <member name="F:CMS.Synchronization.StagingTaskInfo.PERMISSION_MANAGE_DATA_TASKS"> <summary> Permission name that allows user manage custom tables staging tasks. </summary> </member> <member name="F:CMS.Synchronization.StagingTaskInfo.OBJECT_TYPE"> <summary> Object type </summary> </member> <member name="F:CMS.Synchronization.StagingTaskInfo.TYPEINFO"> <summary> Type information. </summary> </member> <member name="P:CMS.Synchronization.StagingTaskInfo.TaskNodeAliasPath"> <summary> Task node alias path. </summary> </member> <member name="P:CMS.Synchronization.StagingTaskInfo.TaskType"> <summary> Task type. </summary> </member> <member name="P:CMS.Synchronization.StagingTaskInfo.TaskDocumentID"> <summary> Task document ID. </summary> </member> <member name="P:CMS.Synchronization.StagingTaskInfo.TaskNodeID"> <summary> Task node ID. </summary> </member> <member name="P:CMS.Synchronization.StagingTaskInfo.TaskTitle"> <summary> Task title. </summary> </member> <member name="P:CMS.Synchronization.StagingTaskInfo.TaskData"> <summary> Task data. </summary> </member> <member name="P:CMS.Synchronization.StagingTaskInfo.TaskTime"> <summary> Task time. </summary> </member> <member name="P:CMS.Synchronization.StagingTaskInfo.TaskID"> <summary> Task ID. </summary> </member> <member name="P:CMS.Synchronization.StagingTaskInfo.TaskSiteID"> <summary> Task Site ID. </summary> </member> <member name="P:CMS.Synchronization.StagingTaskInfo.TaskObjectType"> <summary> Task object type. </summary> </member> <member name="P:CMS.Synchronization.StagingTaskInfo.TaskObjectID"> <summary> Task object ID. </summary> </member> <member name="P:CMS.Synchronization.StagingTaskInfo.TaskRunning"> <summary> Task is running. </summary> </member> <member name="P:CMS.Synchronization.StagingTaskInfo.TaskServers"> <summary> List of tasks servers separated by ';', eg. ';server1;server2;server3;'. </summary> </member> <member name="M:CMS.Synchronization.StagingTaskInfo.DeleteObject"> <summary> Deletes the object using appropriate provider. </summary> </member> <member name="M:CMS.Synchronization.StagingTaskInfo.SetObject"> <summary> Updates the object using appropriate provider. </summary> </member> <member name="M:CMS.Synchronization.StagingTaskInfo.CheckPermissionsInternal(CMS.DataEngine.PermissionsEnum,System.String,CMS.Base.IUserInfo,System.Boolean)"> <summary> Checks the permissions of the object. </summary> <param name="permission">Permission type</param> <param name="siteName">Name of the site</param> <param name="userInfo">UserInfo object</param> <param name="exceptionOnFailure">If true, PermissionCheckException is thrown whenever a permission check fails</param> </member> <member name="M:CMS.Synchronization.StagingTaskInfo.#ctor"> <summary> Constructor - Creates an empty TaskInfo object. </summary> </member> <member name="M:CMS.Synchronization.StagingTaskInfo.#ctor(System.Data.DataRow)"> <summary> Constructor - Creates a new TaskInfo object from the given DataRow. </summary> </member> <member name="M:CMS.Synchronization.StagingTaskInfo.WasProcessed(System.String)"> <summary> Indicates if task was already processed by particular server. </summary> <param name="serverName">Server name to be checked</param> </member> <member name="T:CMS.Synchronization.StagingTaskInfoProvider"> <summary> Class providing TaskInfo management. </summary> </member> <member name="F:CMS.Synchronization.StagingTaskInfoProvider.LOGCONTEXT_SYNCHRONIZATION"> <summary> Context name for AsyncControl log filtering to synchronization API calls only. </summary> </member> <member name="F:CMS.Synchronization.StagingTaskInfoProvider.mObjectTree"> <summary> Object tree. </summary> </member> <member name="F:CMS.Synchronization.StagingTaskInfoProvider.KeepOlderTasks"> <summary> Indicates if older tasks should be kept. </summary> </member> <member name="F:CMS.Synchronization.StagingTaskInfoProvider.LogGlobalObjectsOnlyForAssignedSites"> <summary> If true, tasks for global objects are logged only for the sites assigned to the object. </summary> </member> <member name="F:CMS.Synchronization.StagingTaskInfoProvider.StagingEnabled"> <summary> Indicates whether staging is enabled globally based on AppSettings value. It is enabled by default. </summary> </member> <member name="F:CMS.Synchronization.StagingTaskInfoProvider.ServerName"> <summary> Current server name. </summary> </member> <member name="P:CMS.Synchronization.StagingTaskInfoProvider.ObjectTree"> <summary> Object tree. </summary> </member> <member name="P:CMS.Synchronization.StagingTaskInfoProvider.TaskServerList"> <summary> Task server list. </summary> </member> <member name="M:CMS.Synchronization.StagingTaskInfoProvider.LogObjectChanges(System.String)"> <summary> Indicates if logging object changes staging tasks is enabled. </summary> <param name="siteName">Site name</param> </member> <member name="M:CMS.Synchronization.StagingTaskInfoProvider.LogDataChanges"> <summary> Indicates if logging data changes is enabled. </summary> <returns>TRUE if logging data changes is enabled.</returns> </member> <member name="M:CMS.Synchronization.StagingTaskInfoProvider.LogContentChanges(System.String)"> <summary> Indicates if logging staging tasks for content is enabled. </summary> <param name="siteName">Site name</param> </member> <member name="M:CMS.Synchronization.StagingTaskInfoProvider.LoggingOfStagingTasksEnabled(System.String)"> <summary> Returns true if settings for logging staging task are enabled for given site. If site is String.Empty, then value is returned for global keys. </summary> </member> <member name="M:CMS.Synchronization.StagingTaskInfoProvider.GetTaskInfo(System.Int32)"> <summary> Returns the TaskInfo structure for the specified task. </summary> <param name="taskId">Task id</param> </member> <member name="M:CMS.Synchronization.StagingTaskInfoProvider.SetTaskInfo(CMS.Synchronization.StagingTaskInfo)"> <summary> Sets (updates or inserts) specified task. </summary> <param name="task">Task to set</param> </member> <member name="M:CMS.Synchronization.StagingTaskInfoProvider.DeleteTaskInfo(CMS.Synchronization.StagingTaskInfo)"> <summary> Deletes specified task. </summary> <param name="taskObj">Task object</param> </member> <member name="M:CMS.Synchronization.StagingTaskInfoProvider.DeleteRedundantTasks"> <summary> Deletes synchronization tasks without any binding to a server (i.e. there is no record in Staging_Synchronization table for such task). </summary> </member> <member name="M:CMS.Synchronization.StagingTaskInfoProvider.DeleteTaskInfo(System.Int32)"> <summary> Deletes specified task. </summary> <param name="taskId">Task id</param> </member> <member name="M:CMS.Synchronization.StagingTaskInfoProvider.SelectTaskList(System.Int32,System.Int32,System.String,System.String)"> <summary> Selects all the tasks within subtree of given alias path, with information on the count of the failed attempts and without the task data. </summary> <param name="siteId">Tasks site ID</param> <param name="serverId">Tasks server ID</param> <param name="where">Where condition</param> <param name="orderBy">Order by clause</param> </member> <member name="M:CMS.Synchronization.StagingTaskInfoProvider.SelectTaskList(System.Int32,System.Int32,System.String,System.String,System.Int32,System.String)"> <summary> Selects all the tasks within subtree of given alias path, with information on the count of the failed attempts and without the task data. </summary> <param name="siteId">Tasks site ID</param> <param name="serverId">Tasks server ID</param> <param name="where">Where condition</param> <param name="orderBy">Order by clause</param> <param name="topN">Select top N rows</param> <param name="columns">Select only specified columns</param> </member> <member name="M:CMS.Synchronization.StagingTaskInfoProvider.SelectTaskList(System.Int32,System.Int32,System.String,System.String,System.Int32,System.String,System.Int32,System.Int32,System.Int32@)"> <summary> Selects all the tasks with information on the count of the failed attempts and without the task data. </summary> <param name="siteId">Tasks site ID</param> <param name="serverId">Tasks server ID</param> <param name="where">Where condition</param> <param name="orderBy">Order by clause</param> <param name="topN">Select top N rows</param> <param name="columns">Select only specified columns</param> <param name="offset">Index of first record to get</param> <param name="maxRecords">Maximum number of records to get. If maxRecords is zero or less, all records are returned (no paging is used)</param> <param name="totalRecords">Returns total records</param> </member> <member name="M:CMS.Synchronization.StagingTaskInfoProvider.SelectDocumentTaskList(System.Int32,System.Int32,System.String,System.String,System.String)"> <summary> Selects all the tasks within subtree of given alias path, with information on the count of the failed attempts and without the task data. </summary> <param name="siteId">Tasks site ID</param> <param name="serverId">Tasks server ID</param> <param name="aliasPath">Tasks alias path</param> <param name="where">Where condition</param> <param name="orderBy">Order by</param> </member> <member name="M:CMS.Synchronization.StagingTaskInfoProvider.DeleteOrphanedTasks(System.Collections.Generic.ICollection{System.Int32})"> <summary> Deletes old orphaned tasks. </summary> <remarks>Orphaned task is task that does NOT have any <see cref="T:CMS.Synchronization.SynchronizationInfo"/> bindings.</remarks> <param name="taskIds">IDs from which the orphaned tasks should be removed.</param> </member> <member name="M:CMS.Synchronization.StagingTaskInfoProvider.SelectDocumentTaskList(System.Int32,System.Int32,System.String,System.String,System.String,System.Int32,System.String)"> <summary> Selects all the tasks within subtree of given alias path, with information on the count of the failed attempts and without the task data. </summary> <param name="siteId">Tasks site ID</param> <param name="serverId">Tasks server ID</param> <param name="aliasPath">Tasks alias path</param> <param name="where">Where condition</param> <param name="orderBy">Order by</param> <param name="topN">Select only top N rows</param> <param name="columns">Select only specified columns</param> </member> <member name="M:CMS.Synchronization.StagingTaskInfoProvider.SelectDocumentTaskList(System.Int32,System.Int32,System.String,System.String,System.String,System.Int32,System.String,System.Int32,System.Int32,System.Int32@)"> <summary> Selects all the tasks within subtree of given alias path, with information on the count of the failed attempts and without the task data. </summary> <param name="siteId">Tasks site ID</param> <param name="serverId">Tasks server ID</param> <param name="aliasPath">Tasks alias path</param> <param name="where">Where condition</param> <param name="orderBy">Order by</param> <param name="topN">Select only top N rows</param> <param name="columns">Select only specified columns</param> <param name="offset">Index of first record to get</param> <param name="maxRecords">Maximum number of records to get. If maxRecords is zero or less, all records are returned (no paging is used)</param> <param name="totalRecords">Returns total records</param> </member> <member name="M:CMS.Synchronization.StagingTaskInfoProvider.SelectObjectTaskList(System.Int32,System.Int32,System.String,System.String,System.String)"> <summary> Selects all the tasks within subtree of given alias path, with information on the count of the failed attempts and without the task data. </summary> <param name="siteId">Tasks site ID</param> <param name="serverId">Tasks server ID</param> <param name="objectTypes">Object types</param> <param name="where">Where condition</param> <param name="orderBy">Order by</param> </member> <member name="M:CMS.Synchronization.StagingTaskInfoProvider.SelectObjectTaskList(System.Int32,System.Int32,System.String,System.String,System.String,System.Int32,System.String)"> <summary> Selects all the tasks within subtree of given alias path, with information on the count of the failed attempts and without the task data. </summary> <param name="siteId">Tasks site ID</param> <param name="serverId">Tasks server ID</param> <param name="objectTypes">Object types</param> <param name="where">Where condition</param> <param name="orderBy">Order by</param> <param name="topN">Select top N rows</param> <param name="columns">Select only specified columns</param> </member> <member name="M:CMS.Synchronization.StagingTaskInfoProvider.SelectObjectTaskList(System.Int32,System.Int32,System.String,System.String,System.String,System.Int32,System.String,System.Int32,System.Int32,System.Int32@)"> <summary> Selects all the tasks within subtree of given alias path, with information on the count of the failed attempts and without the task data. </summary> <param name="siteId">Tasks site ID</param> <param name="serverId">Tasks server ID</param> <param name="objectTypes">Object types</param> <param name="where">Where condition</param> <param name="orderBy">Order by</param> <param name="topN">Select top N rows</param> <param name="columns">Select only specified columns</param> <param name="offset">Index of first record to get</param> <param name="maxRecords">Maximum number of records to get. If maxRecords is zero or less, all records are returned (no paging is used)</param> <param name="totalRecords">Returns total records</param> </member> <member name="M:CMS.Synchronization.StagingTaskInfoProvider.GetTasks(System.String,System.String,System.Boolean,System.Int32,System.String)"> <summary> Returns query with all tasks filtered by where condition. </summary> <param name="whereCondition">Where condition statement</param> <param name="orderBy">Order by statement</param> <param name="getAllData">If false, only limited set of columns is selected</param> <param name="topN">Top N tasks</param> <param name="columns">Selected columns</param> </member> <member name="M:CMS.Synchronization.StagingTaskInfoProvider.GetTasks"> <summary> Get all staging tasks. </summary> <returns>Returns all staging tasks, does not depends on server, site or type.</returns> </member> <member name="M:CMS.Synchronization.StagingTaskInfoProvider.DeleteOlderTasks(CMS.Synchronization.StagingTaskInfo)"> <summary> Deletes older synchronization tasks. </summary> <param name="taskObj">Current task object</param> </member> <member name="M:CMS.Synchronization.StagingTaskInfoProvider.GetTasksForSynchronization(System.Collections.Generic.IEnumerable{System.Int32},System.Int32)"> <summary> Returns all the tasks that need to be synchronized (including older tasks that needs to be processed before the tasks with given IDs). </summary> <param name="taskIDs">Current task object</param> <param name="serverId">Server ID</param> </member> <member name="M:CMS.Synchronization.StagingTaskInfoProvider.LogSynchronization(CMS.DataEngine.GeneralizedInfo,CMS.DataEngine.TaskTypeEnum,System.String,System.Int32,System.Int32)"> <summary> Logs the synchronization task for the given object. </summary> <param name="infoObj">Object to log</param> <param name="taskType">Task type</param> <param name="siteName">Object site name</param> <param name="siteId">Site ID of the servers to synchronize</param> <param name="serverId">Server ID to synchronize</param> <returns>Returns new synchronization task</returns> </member> <member name="M:CMS.Synchronization.StagingTaskInfoProvider.GetTaskTitle(CMS.DataEngine.TaskTypeEnum,CMS.DataEngine.GeneralizedInfo,CMS.DataEngine.TranslationHelper)"> <summary> Gets task title. </summary> <param name="taskType">Task type</param> <param name="infoObj">Info object</param> <param name="th">Translation helper</param> </member> <member name="M:CMS.Synchronization.StagingTaskInfoProvider.GetServerIdsToLogTaskTo(CMS.Synchronization.StagingTaskInfo,System.Int32,System.Int32)"> <summary> Gets the list of server IDs for which the staging task should be logged. </summary> <param name="task">Synchronization task.</param> <param name="siteId">Site ID.</param> <param name="serverId">Server ID.</param> </member> <member name="M:CMS.Synchronization.StagingTaskInfoProvider.DeleteOrphanedTasksInternal(System.Collections.Generic.ICollection{System.Int32})"> <summary> Deletes old orphaned tasks. </summary> <remarks>Orphaned task is task that does NOT have any <see cref="T:CMS.Synchronization.SynchronizationInfo"/> bindings.</remarks> <param name="taskIds">IDs from which the orphaned tasks should be removed.</param> </member> <member name="M:CMS.Synchronization.StagingTaskInfoProvider.DeleteRedundantTasksInternal"> <summary> Deletes synchronization tasks without any binding to a server (i.e. there is no record in Staging_Synchronization table for such task). </summary> </member> <member name="M:CMS.Synchronization.StagingTaskInfoProvider.SelectTaskListInternal(System.Int32,System.Int32,System.String,System.String,System.Int32,System.String,System.Int32,System.Int32,System.Int32@)"> <summary> Selects all the tasks with information on the count of the failed attempts and without the task data. </summary> <param name="siteId">Tasks site ID</param> <param name="serverId">Tasks server ID</param> <param name="where">Where condition</param> <param name="orderBy">Order by clause</param> <param name="topN">Select top N rows</param> <param name="columns">Select only specified columns</param> <param name="offset">Index of first record to get</param> <param name="maxRecords">Maximum number of records to get. If maxRecords is zero or less, all records are returned (no paging is used)</param> <param name="totalRecords">Returns total records</param> </member> <member name="M:CMS.Synchronization.StagingTaskInfoProvider.GetTasksInternal(System.String,System.String,System.Boolean,System.Int32,System.String)"> <summary> Returns dataset of all tasks filtered by where condition. </summary> <param name="whereCondition">Where condition statement</param> <param name="orderBy">Order by statement</param> <param name="getAllData">If false, only limited set of columns is selected</param> <param name="topN">Top N tasks</param> <param name="columns">Selected columns</param> </member> <member name="M:CMS.Synchronization.StagingTaskInfoProvider.DeleteOlderTasksInternal(CMS.Synchronization.StagingTaskInfo)"> <summary> Deletes older synchronization tasks of same object. </summary> <param name="taskObj">Current task object</param> </member> <member name="M:CMS.Synchronization.StagingTaskInfoProvider.DeleteOlderTasksInternal(CMS.Synchronization.StagingTaskInfo,CMS.DataEngine.WhereCondition)"> <summary> Deletes older synchronization tasks of same object. </summary> <param name="currentTask">Current task object</param> <param name="whereCondition">Where condition selecting old tasks</param> </member> <member name="M:CMS.Synchronization.StagingTaskInfoProvider.GetTasksForSynchronizationInternal(System.Collections.Generic.IEnumerable{System.Int32},System.Int32)"> <summary> Returns all the tasks that need to be synchronized (including older tasks that needs to be processed before the tasks with given IDs). </summary> <param name="taskIDs">Current task object</param> <param name="serverId">Server ID</param> </member> <member name="M:CMS.Synchronization.StagingTaskInfoProvider.LogSynchronizationInternal(CMS.DataEngine.GeneralizedInfo,CMS.DataEngine.TaskTypeEnum,System.String,System.Int32,System.Int32)"> <summary> Logs the synchronization task for the given object. </summary> <param name="infoObj">Object to log</param> <param name="taskType">Task type</param> <param name="siteName">Object site name</param> <param name="siteId">Site ID of the servers to synchronize</param> <param name="serverId">Server ID to synchronize</param> <returns>Returns new synchronization task</returns> </member> <member name="M:CMS.Synchronization.StagingTaskInfoProvider.UpdateTaskServers(CMS.Synchronization.StagingTaskInfo)"> <summary> Updates the task servers with the current server name </summary> <param name="ti">Task info</param> </member> <member name="M:CMS.Synchronization.StagingTaskInfoProvider.GetTaskTitleInternal(CMS.DataEngine.TaskTypeEnum,CMS.DataEngine.GeneralizedInfo,CMS.DataEngine.TranslationHelper)"> <summary> Gets task title. </summary> <param name="taskType">Task type</param> <param name="infoObj">Info object</param> <param name="th">Translation helper</param> </member> <member name="M:CMS.Synchronization.StagingTaskInfoProvider.GetServerIdsToLogTaskToInternal(CMS.Synchronization.StagingTaskInfo,System.Int32,System.Int32)"> <summary> Gets the list of server IDs for which the staging task should be logged. </summary> <param name="task">Synchronization task.</param> <param name="siteId">Site ID.</param> <param name="serverId">Server ID.</param> </member> <member name="M:CMS.Synchronization.StagingTaskInfoProvider.GetServerIdsToLogTaskTo(CMS.Synchronization.StagingTaskInfo,System.Collections.Generic.IList{System.Int32},System.Boolean)"> <summary> Gets the list of server IDs for which the staging task should be logged. </summary> <param name="task">Synchronization task.</param> <param name="siteIds">List of site IDs to limit the set of staging servers to.</param> <param name="enabledServers">Indicates if only enabled servers should be included.</param> </member> <member name="M:CMS.Synchronization.StagingTaskInfoProvider.AssociateOriginalTaskGroupsWithNewTask(CMS.Synchronization.StagingTaskInfo,CMS.DataEngine.WhereCondition)"> <summary> Updates <see cref="T:CMS.Synchronization.TaskGroupTaskInfo"/> binding, by switching old task ID to a newly created task that replaces the old one. </summary> <param name="taskObj">New staging task</param> <param name="oldTasksWhere">Where condition for old tasks that will be deleted, e.g. UpdateObj is deleted when DeleteObj task is created for same object</param> </member> <member name="M:CMS.Synchronization.StagingTaskInfoProvider.AssociateOriginalUsersWithNewTask(CMS.Synchronization.StagingTaskInfo,CMS.DataEngine.WhereCondition)"> <summary> Updates <see cref="T:CMS.Synchronization.StagingTaskUserInfo"/> binding, by switching old task ID to a newly created task that replaces the old one. </summary> <param name="taskObj">New staging task</param> <param name="oldTasksWhere">Where condition for old tasks that will be deleted, e.g. UpdateObj is deleted when DeleteObj task is created for same object</param> </member> <member name="T:CMS.Synchronization.TaskParameters"> <summary> Class to provide staging task parameters. </summary> </member> <member name="F:CMS.Synchronization.TaskParameters.mParametersTable"> <summary> Task paramaeters table. </summary> </member> <member name="F:CMS.Synchronization.TaskParameters.mReguestStockKey"> <summary> Key for request stock helper caching. </summary> </member> <member name="P:CMS.Synchronization.TaskParameters.ParametersTable"> <summary> Returns task parameter table. </summary> </member> <member name="P:CMS.Synchronization.TaskParameters.RequestStockKey"> <summary> Returns key for request stock helper caching. </summary> </member> <member name="M:CMS.Synchronization.TaskParameters.#ctor"> <summary> Default constructor. </summary> </member> <member name="M:CMS.Synchronization.TaskParameters.#ctor(System.Data.DataTable)"> <summary> Constructor with ParametersTable initialization. </summary> <param name="dt">DataTable used for task ParameterTable initialization</param> </member> <member name="M:CMS.Synchronization.TaskParameters.SetParameter(System.String,System.Object)"> <summary> Sets the parameter value under specified key for further use. </summary> <param name="key">Identification key</param> <param name="value">Value to be stored</param> </member> <member name="M:CMS.Synchronization.TaskParameters.GetParameter(System.String)"> <summary> Gets the parameter value with given key. </summary> <param name="key">Identification key</param> <returns>Stored value</returns> </member> <member name="M:CMS.Synchronization.TaskParameters.GetEmptyTable"> <summary> Returns empty translation table. </summary> </member> <member name="M:CMS.Synchronization.TaskParameters.EnsureColumns(System.Data.DataTable)"> <summary> Ensures the columns in the translation table. </summary> <param name="dt">Translation table</param> </member> <member name="M:CMS.Synchronization.TaskParameters.GetRecord(System.String)"> <summary> Gets the record by key. </summary> <param name="key">Identification key</param> <returns>Particular DataRow</returns> </member> <member name="T:CMS.Synchronization.TranslationXmlWriter"> <summary> Writes registered translations in XML format </summary> </member> <member name="P:CMS.Synchronization.TranslationXmlWriter.Translations"> <summary> Recorded translations to be included to the output </summary> </member> <member name="P:CMS.Synchronization.TranslationXmlWriter.TranslationHelper"> <summary> Translation helper instance </summary> </member> <member name="P:CMS.Synchronization.TranslationXmlWriter.Writer"> <summary> Output writer </summary> </member> <member name="M:CMS.Synchronization.TranslationXmlWriter.#ctor(CMS.IO.StreamWriter,CMS.DataEngine.TranslationHelper)"> <summary> Creates new instance of <see cref="T:CMS.Synchronization.TranslationXmlWriter"/>. </summary> <param name="writer">Output writer</param> <param name="translationHelper">Translation helper</param> </member> <member name="M:CMS.Synchronization.TranslationXmlWriter.WriteTranslations"> <summary> Writes the recorded translations to the output </summary> </member> <member name="M:CMS.Synchronization.TranslationXmlWriter.RegisterObjectTranslations(CMS.DataEngine.GeneralizedInfo)"> <summary> Registers required translations for the given object </summary> <param name="info">Info object</param> <exception cref="T:System.ArgumentNullException"><paramref name="info"/></exception> </member> <member name="M:CMS.Synchronization.TranslationXmlWriter.AddTranslation(System.String,System.Int32)"> <summary> Adds given ID into the translation table to correct list according to objectType </summary> <param name="objectType">Object type of the object</param> <param name="id">ID of the object</param> </member> <member name="M:CMS.Synchronization.TranslationXmlWriter.RegisterCollectedTranslations"> <summary> Registers requested translations to the translation helper of settings. Ensures the translation helper within settings if necessary. Clears the collected translations once they are registered. </summary> </member> <member name="M:CMS.Synchronization.TranslationXmlWriter.RegisterTranslation(CMS.DataEngine.GeneralizedInfo,System.String,System.String)"> <summary> Handles FK ID (can be used to fill translation helper for example). </summary> <param name="obj">Object (TreeNode / InfoObject) to export</param> <param name="columnName">Column name of the dependency</param> <param name="objectType">Object type of the dependency</param> </member> <member name="T:CMS.Synchronization.VersionHistorySettingsHelper"> <summary> Helper class providing general functionality used by version history. </summary> </member> <member name="M:CMS.Synchronization.VersionHistorySettingsHelper.GetSiteIDsWhereSettingsKeyIsOverridden(System.String)"> <summary> Returns a query allowing to select the IDs of sites that specify own value for given settings key. </summary> <param name="keyName">Settings key name to check.</param> </member> <member name="M:CMS.Synchronization.VersionHistorySettingsHelper.IsLimitDecreased(CMS.DataEngine.SettingsKeyInfo)"> <summary> Returns true if the original <paramref name="setting" /> value was greater than the current one. </summary> <remarks> Use when given <paramref name="setting"/> is being changed. When comparing the values, zero and less represent unlimited version history length. </remarks> <param name="setting">Settings key representing version history length limit.</param> </member> <member name="M:CMS.Synchronization.VersionHistorySettingsHelper.IsLimitLowerThanGlobal(CMS.DataEngine.SettingsKeyInfo)"> <summary> Returns true if the global setting value was greater than given <paramref name="setting"/>. </summary> <remarks> Use when given <paramref name="setting"/> is being created and thus the global setting will not apply anymore. When comparing the values, zero and less represent unlimited version history length. </remarks> <param name="setting">Settings key representing version history length limit.</param> </member> <member name="M:CMS.Synchronization.VersionHistorySettingsHelper.IsLimitHigherThanGlobal(CMS.DataEngine.SettingsKeyInfo)"> <summary> Returns true if given <paramref name="setting"/> was greater than the global setting value. </summary> <remarks> Use when given <paramref name="setting"/> is being removed and thus the global setting will apply from now on. When comparing the values, zero and less represent unlimited version history length. </remarks> <param name="setting">Settings key representing version history length limit.</param> </member> <member name="T:CMS.Synchronization.ObjectVersionHistoryInfo"> <summary> ObjectVersionHistoryInfo data container class. </summary> </member> <member name="F:CMS.Synchronization.ObjectVersionHistoryInfo.OBJECT_TYPE"> <summary> Object type </summary> </member> <member name="F:CMS.Synchronization.ObjectVersionHistoryInfo.TYPEINFO"> <summary> Type information. </summary> </member> <member name="P:CMS.Synchronization.ObjectVersionHistoryInfo.VersionObjectSiteID"> <summary> Site ID of the object to distinguish site objects vs. global objects. </summary> </member> <member name="P:CMS.Synchronization.ObjectVersionHistoryInfo.VersionObjectID"> <summary> ID of the object. </summary> </member> <member name="P:CMS.Synchronization.ObjectVersionHistoryInfo.VersionObjectDisplayName"> <summary> Display name of the object for listings. </summary> </member> <member name="P:CMS.Synchronization.ObjectVersionHistoryInfo.VersionID"> <summary> ID of the version. </summary> </member> <member name="P:CMS.Synchronization.ObjectVersionHistoryInfo.VersionObjectType"> <summary> Object type of the object. </summary> </member> <member name="P:CMS.Synchronization.ObjectVersionHistoryInfo.VersionXML"> <summary> Object version data. </summary> </member> <member name="P:CMS.Synchronization.ObjectVersionHistoryInfo.VersionDeletedByUserID"> <summary> ID of the user who deleted the object. </summary> </member> <member name="P:CMS.Synchronization.ObjectVersionHistoryInfo.VersionNumber"> <summary> Version number. </summary> </member> <member name="P:CMS.Synchronization.ObjectVersionHistoryInfo.VersionComment"> <summary> Version comment </summary> </member> <member name="P:CMS.Synchronization.ObjectVersionHistoryInfo.VersionBinaryDataXML"> <summary> Object version binary data. </summary> </member> <member name="P:CMS.Synchronization.ObjectVersionHistoryInfo.VersionSiteBindingIDs"> <summary> Version site binding for deleted global objects with site bindings. Contains list of site GUIDs separated by ; to identify to which sites should be the object assigned during the restore opearation. </summary> </member> <member name="P:CMS.Synchronization.ObjectVersionHistoryInfo.VersionModifiedWhen"> <summary> DateTime when the version was created. </summary> </member> <member name="P:CMS.Synchronization.ObjectVersionHistoryInfo.VersionDeletedWhen"> <summary> DateTime when the object was deleted. </summary> </member> <member name="P:CMS.Synchronization.ObjectVersionHistoryInfo.VersionModifiedByUserID"> <summary> ID of the user who created the version. </summary> </member> <member name="M:CMS.Synchronization.ObjectVersionHistoryInfo.DeleteObject"> <summary> Deletes the object using appropriate provider. </summary> </member> <member name="M:CMS.Synchronization.ObjectVersionHistoryInfo.SetObject"> <summary> Updates the object using appropriate provider. </summary> </member> <member name="M:CMS.Synchronization.ObjectVersionHistoryInfo.#ctor"> <summary> Constructor - Creates an empty ObjectVersionHistoryInfo object. </summary> </member> <member name="M:CMS.Synchronization.ObjectVersionHistoryInfo.#ctor(System.Data.DataRow)"> <summary> Constructor - Creates a new ObjectVersionHistoryInfo object from the given DataRow. </summary> <param name="dr">DataRow with the object data</param> </member> <member name="M:CMS.Synchronization.ObjectVersionHistoryInfo.CheckLicense(CMS.DataEngine.ObjectActionEnum,System.String)"> <summary> Checks the object license. Returns true if the licensing conditions for this object were matched </summary> <param name="action">Object action</param> <param name="domainName">Domain name, if not set, uses current domain</param> </member> <member name="T:CMS.Synchronization.ObjectVersionHistoryInfoProvider"> <summary> Class providing ObjectVersionHistoryInfo management. </summary> </member> <member name="M:CMS.Synchronization.ObjectVersionHistoryInfoProvider.GetVersionHistories"> <summary> Returns all object version histories. </summary> </member> <member name="M:CMS.Synchronization.ObjectVersionHistoryInfoProvider.GetVersionHistories(System.String,System.String,System.Int32,System.String)"> <summary> Returns dataset of all object version histories matching the specified parameters. </summary> <param name="where">Where condition</param> <param name="orderBy">Order by expression</param> <param name="topN">Number of records to be selected</param> <param name="columns">Columns to be selected</param> </member> <member name="M:CMS.Synchronization.ObjectVersionHistoryInfoProvider.GetVersionHistoryInfo(System.Int32)"> <summary> Returns object version history with specified ID. </summary> <param name="historyId">Object version history ID</param> </member> <member name="M:CMS.Synchronization.ObjectVersionHistoryInfoProvider.SetVersionHistoryInfo(CMS.Synchronization.ObjectVersionHistoryInfo)"> <summary> Sets (updates or inserts) specified object version history. </summary> <param name="historyObj">Object version history to be set</param> </member> <member name="M:CMS.Synchronization.ObjectVersionHistoryInfoProvider.DeleteVersionHistoryInfo(CMS.Synchronization.ObjectVersionHistoryInfo)"> <summary> Deletes specified object version history. </summary> <param name="historyObj">Object version history to be deleted</param> </member> <member name="M:CMS.Synchronization.ObjectVersionHistoryInfoProvider.DeleteVersionHistoryInfo(System.Int32)"> <summary> Deletes object version history with specified ID. </summary> <param name="historyId">Object version history ID</param> </member> <member name="M:CMS.Synchronization.ObjectVersionHistoryInfoProvider.DeleteVersionHistories(System.String)"> <summary> Delete version histories matching the specified where condition. </summary> <param name="where">Where condition</param> </member> <member name="M:CMS.Synchronization.ObjectVersionHistoryInfoProvider.GetRecycleBin(System.String,System.String,System.Int32,System.String)"> <summary> Gets recycle bin. </summary> <param name="where">Where condition</param> <param name="orderBy">Order by clause</param> <param name="topN">Select only top N rows</param> <param name="columns">Select only specified columns</param> <returns>Recycle bin </returns> </member> <member name="M:CMS.Synchronization.ObjectVersionHistoryInfoProvider.GetRecycleBin(System.Int32,System.String,System.String,System.Int32,System.String)"> <summary> Gets recycle bin for specified user. </summary> <param name="userId">ID of user</param> <param name="where">Where condition</param> <param name="orderBy">Order by clause</param> <param name="topN">Select only top N rows</param> <param name="columns">Select only specified columns</param> <returns>Recycle bin for specified user</returns> </member> <member name="M:CMS.Synchronization.ObjectVersionHistoryInfoProvider.GetVersionHistoriesInternal(System.String,System.String,System.Int32,System.String)"> <summary> Returns dataset of all object version histories matching the specified parameters. </summary> <param name="where">Where condition</param> <param name="orderBy">Order by expression</param> <param name="topN">Number of records to be selected</param> <param name="columns">Columns to be selected</param> </member> <member name="M:CMS.Synchronization.ObjectVersionHistoryInfoProvider.DeleteVersionHistoriesInternal(System.String)"> <summary> Delete version histories matching the specified where condition. </summary> <param name="where">Where condition</param> </member> <member name="M:CMS.Synchronization.ObjectVersionHistoryInfoProvider.CheckLicense(System.String)"> <summary> Check license limitation </summary> <param name="domainName">Domain name</param> </member> <member name="T:CMS.Synchronization.ObjectVersionHistoryListInfo"> <summary> ObjectVersionHistoryListInfo virtual object. </summary> </member> <member name="F:CMS.Synchronization.ObjectVersionHistoryListInfo.OBJECT_TYPE"> <summary> Object type </summary> </member> <member name="F:CMS.Synchronization.ObjectVersionHistoryListInfo.TYPEINFO"> <summary> Type information. </summary> </member> <member name="M:CMS.Synchronization.ObjectVersionHistoryListInfo.#ctor"> <summary> Constructor - Creates an empty ObjectVersionHistoryListInfo object. </summary> </member> <member name="M:CMS.Synchronization.ObjectVersionHistoryListInfo.#ctor(System.Data.DataRow)"> <summary> Constructor - Creates a new ObjectVersionHistoryListInfo object from the given DataRow. </summary> <param name="dr">DataRow with the object data</param> </member> <member name="M:CMS.Synchronization.ObjectVersionHistoryListInfo.GetColumnNames"> <summary> Gets the default list of column names for this class </summary> </member> <member name="M:CMS.Synchronization.ObjectVersionHistoryListInfo.GetDataQueryInternal"> <summary> Gets the data query for this object type </summary> </member> <member name="T:CMS.Synchronization.ObjectVersionManager"> <summary> Class providing object versions management. </summary> </member> <member name="F:CMS.Synchronization.ObjectVersionManager.RESTORE_NONE"> <summary> Object versioning restore mode determining that objects will be deleted permanently. </summary> </member> <member name="F:CMS.Synchronization.ObjectVersionManager.RESTORE_VERSIONEDOBJECTS"> <summary> Object versioning restore mode determining that versioned objects will be deleted to recycle bin. </summary> </member> <member name="F:CMS.Synchronization.ObjectVersionManager.RESTORE_ALL"> <summary> Object versioning restore mode determining that all objects supported in staging will be deleted to recycle bin. </summary> </member> <member name="F:CMS.Synchronization.ObjectVersionManager.CREATE_VERSION_STORAGE"> <summary> Storage key to determine whether a version of particular was created or not </summary> </member> <member name="M:CMS.Synchronization.ObjectVersionManager.GetLatestVersion(System.String,System.Int32)"> <summary> Gets latest version history for given object. </summary> <param name="objectType">Object type</param> <param name="objectId">Object ID</param> </member> <member name="M:CMS.Synchronization.ObjectVersionManager.DeleteOlderVersions(System.String,System.Int32,System.String)"> <summary> Deletes older object versions. </summary> <param name="objectType">Object type</param> <param name="objectId">Object ID</param> <param name="siteName">Object site name</param> </member> <member name="M:CMS.Synchronization.ObjectVersionManager.DestroyObjectHistory(System.String,System.Int32)"> <summary> Destroys complete object history. </summary> <param name="objectType">Object type</param> <param name="objectId">Object ID</param> </member> <member name="M:CMS.Synchronization.ObjectVersionManager.GetObjectHistory(System.String,System.Int32,System.String,System.String,System.Int32,System.String)"> <summary> Gets object version histories. </summary> <param name="objectType">Object type</param> <param name="objectId">Object ID</param> <param name="where">Where condition</param> <param name="orderBy">Order by expression</param> <param name="topN">Number of records to be selected</param> <param name="columns">Columns to be selected</param> </member> <member name="M:CMS.Synchronization.ObjectVersionManager.DestroyObjectVersion(System.Int32)"> <summary> Destroys object version. </summary> <param name="versionId">Version ID</param> </member> <member name="M:CMS.Synchronization.ObjectVersionManager.RollbackVersion(System.Int32,System.Boolean,System.Boolean)"> <summary> Rollbacks object to specified version. </summary> <param name="versionId">Version ID</param> <param name="processChilds">Indicates if child data should be roll-backed</param> <param name="createNewVersion">If true, new version after rollback is created</param> </member> <member name="M:CMS.Synchronization.ObjectVersionManager.RestoreObject(System.Int32,System.Int32)"> <summary> Restores object to specified site ID. </summary> <param name="versionId">Version ID</param> <param name="siteId">Site ID to which object should be restored</param> </member> <member name="M:CMS.Synchronization.ObjectVersionManager.RestoreObject(System.Int32,System.Boolean)"> <summary> Restores object, optionally with its children. </summary> <param name="versionId">Version ID</param> <param name="procesChilds">Indicates if also child object should be restored</param> </member> <member name="M:CMS.Synchronization.ObjectVersionManager.CreateVersion(CMS.DataEngine.GeneralizedInfo,System.Int32,System.Boolean)"> <summary> Creates object version. </summary> <param name="infoObj">IInfo object instance</param> <param name="userId">User that caused creation of object version</param> <param name="forceVersion">Indicates if new version should be created instead of storing to existing one if possible</param> </member> <member name="M:CMS.Synchronization.ObjectVersionManager.EnsureVersion(CMS.DataEngine.GeneralizedInfo,System.Boolean)"> <summary> Creates object version for deleted object. </summary> <param name="infoObj">IInfo object instance</param> <param name="getOriginalData">Indicates if original object data should be obtained from database</param> </member> <member name="M:CMS.Synchronization.ObjectVersionManager.EnsureDeletedVersion(CMS.DataEngine.GeneralizedInfo)"> <summary> Ensures object version. </summary> <param name="infoObj">IInfo object instance</param> </member> <member name="M:CMS.Synchronization.ObjectVersionManager.IsObjectExtensionVersioned(System.String,System.String,System.String)"> <summary> Determines whether the file with the specified extension (case insensitive) is versioned on site specified by name. </summary> <param name="objectType">Object type to check versioned extensions for</param> <param name="extension">File extension to check.</param> <param name="siteName">Site name on which is media file located</param> </member> <member name="M:CMS.Synchronization.ObjectVersionManager.GetObjectVersionedExtensions(System.String,System.String)"> <summary> Returns allowed extensions list from settings. </summary> <param name="objectType">Object type to check versioned extensions for</param> <param name="siteName">Name of the site</param> </member> <member name="M:CMS.Synchronization.ObjectVersionManager.AllowObjectVersioning(CMS.DataEngine.GeneralizedInfo)"> <summary> Indicates if the object versioning is allowed for specified object under particular site. </summary> <param name="infoObj">IInfo object instance</param> </member> <member name="M:CMS.Synchronization.ObjectVersionManager.AllowObjectRestore(CMS.DataEngine.GeneralizedInfo)"> <summary> Indicates if the object under specified site can be restored from recycle bin. </summary> <param name="infoObj">IInfo object instance</param> </member> <member name="M:CMS.Synchronization.ObjectVersionManager.ObjectHasVersions(System.String,System.Int32)"> <summary> Indicates if object has at least one version. </summary> <param name="objectType">Object type</param> <param name="objectId">Object ID</param> <returns>True if specified object has at least one version,False otherwise</returns> </member> <member name="M:CMS.Synchronization.ObjectVersionManager.GetNewVersionNumber(System.String,System.Boolean)"> <summary> Gets new version number according to previous version number. </summary> <param name="oldVersionNumber">Old version number</param> <param name="isMajorVersion">If true, the version number is considered major</param> <returns>New version number</returns> </member> <member name="M:CMS.Synchronization.ObjectVersionManager.GetMinorVersionHistoryLength(System.String)"> <summary> Gets object version history length. </summary> <param name="siteName">Site name</param> </member> <member name="M:CMS.Synchronization.ObjectVersionManager.GetMajorVersionHistoryLength(System.String)"> <summary> Gets object major version history length. </summary> <param name="siteName">Site name</param> </member> <member name="M:CMS.Synchronization.ObjectVersionManager.GetUseLastVersionInterval(System.String)"> <summary> Gets time interval for which last version will be used to store version data </summary> <param name="siteName">Site name</param> </member> <member name="M:CMS.Synchronization.ObjectVersionManager.GetPromoteToMajorInterval(System.String)"> <summary> Gets time interval between 2 modifications of object for which last version will be promoted to major version </summary> <param name="siteName">Site name</param> </member> <member name="M:CMS.Synchronization.ObjectVersionManager.MakeVersionMajor(CMS.Synchronization.ObjectVersionHistoryInfo)"> <summary> Make major version from specified version </summary> <param name="version">Version to be changed to major</param> <returns>Returns true if new version is created</returns> </member> <member name="M:CMS.Synchronization.ObjectVersionManager.IsVersionMajor(CMS.Synchronization.ObjectVersionHistoryInfo)"> <summary> Indicates if specified version is major version </summary> <param name="version">Version to be checked</param> </member> <member name="M:CMS.Synchronization.ObjectVersionManager.DisplayVersionsTab(CMS.DataEngine.GeneralizedInfo)"> <summary> Indicates if versions tab should be displayed for specified object type </summary> <param name="infoObj">Object to display versions tab for</param> </member> <member name="M:CMS.Synchronization.ObjectVersionManager.GetLatestVersionInternal(System.String,System.Int32)"> <summary> Gets latest version history for given object. </summary> <param name="objectType">Object type</param> <param name="objectId">Object ID</param> </member> <member name="M:CMS.Synchronization.ObjectVersionManager.DeleteOlderVersionsInternal(System.String,System.Int32,System.Int32,System.Int32)"> <summary> Deletes older object versions. </summary> <param name="objectType">Object type</param> <param name="objectId">Object ID</param> <param name="minorVersionHistoryLength">Minor versions history length to ensure</param> <param name="majorVersionHistoryLength">Major versions history length to ensure</param> </member> <member name="M:CMS.Synchronization.ObjectVersionManager.GetObjectHistoryInternal(System.String,System.Int32,System.String,System.String,System.Int32,System.String)"> <summary> Gets object version histories. </summary> <param name="objectType">Object type</param> <param name="objectId">Object ID</param> <param name="where">Where condition</param> <param name="orderBy">Order by expression</param> <param name="topN">Number of records to be selected</param> <param name="columns">Columns to be selected</param> </member> <member name="M:CMS.Synchronization.ObjectVersionManager.ChangePreviousVersionsObjectIDInternal(System.String,System.Int32,System.Int32)"> <summary> Changes object ID for the previous object versions during object restore. </summary> <param name="objectType">Object type</param> <param name="originalVersionId">Original object version ID</param> <param name="newVersionId">New object version ID</param> </member> <member name="M:CMS.Synchronization.ObjectVersionManager.GetNewVersionNumberInternal(System.String,System.Boolean)"> <summary> Gets new version number according to previous version number. </summary> <param name="oldVersionNumber">Old version number</param> <param name="isMajorVersion">If true, the version number is considered major</param> <returns>New version number</returns> </member> <member name="M:CMS.Synchronization.ObjectVersionManager.ProcessVersioningSynchronizationTask(System.String,System.String,System.String,System.Boolean,System.Int32)"> <summary> Process versioning synchronization task of object with given parameters. </summary> <param name="objectType">Type of object associated with task</param> <param name="data">Data of object associated with this task</param> <param name="binaryData">Binary data of object associated with this task</param> <param name="processChilds">Whether to process childs of object associated with this task</param> <param name="siteId">Site ID of object associated with this task</param> <returns>Resulting <see cref="T:CMS.Base.ICMSObject"/>.></returns> </member> <member name="M:CMS.Synchronization.ObjectVersionManager.FixVersionXML(CMS.Synchronization.ObjectVersionHistoryInfo)"> <summary> Corrects object ID in the version's object data. If the object was restored from recycle bin before and has new ID, this method ensures that VersionXML will contain current VersionObjectID. </summary> <param name="versionHistory">Object version history</param> </member> <member name="M:CMS.Synchronization.ObjectVersionManager.GetWhereCondition(System.String,System.Int32)"> <summary> Gets object where condition used in queries for object history. </summary> <param name="objectType">Object type</param> <param name="objectId">Object ID</param> <returns>Object where condition</returns> </member> <member name="M:CMS.Synchronization.ObjectVersionManager.RestoreObjectVersion(CMS.Synchronization.ObjectVersionHistoryInfo,System.Boolean,System.Int32)"> <summary> Restores object specified by its history, optionally it restores also object children. </summary> <param name="versionHistory">Object version history info object</param> <param name="processChilds">Indicates if also object children should be restored</param> <param name="siteId">ID of the site to which object should be restored</param> <returns>Restored object IInfo object</returns> </member> <member name="M:CMS.Synchronization.ObjectVersionManager.UpdateVersionHistoryData(CMS.Synchronization.ObjectVersionHistoryInfo,CMS.DataEngine.BaseInfo)"> <summary> Ensure object actual data in version history </summary> <param name="versionHistory">Version history object to update</param> <param name="infoObj">Object with actual data</param> </member> <member name="M:CMS.Synchronization.ObjectVersionManager.CheckOut(CMS.DataEngine.BaseInfo,CMS.Base.IUserInfo)"> <summary> Checks out the object to particular user </summary> <param name="infoObj">Object to check out</param> <param name="user">User who is checking out the object</param> </member> <member name="M:CMS.Synchronization.ObjectVersionManager.UndoCheckOut(CMS.DataEngine.BaseInfo)"> <summary> Cancels the object checkout. </summary> <param name="infoObj">Object to check out</param> </member> <member name="M:CMS.Synchronization.ObjectVersionManager.CheckIn(CMS.DataEngine.BaseInfo,System.String,System.String)"> <summary> Checks in the object. </summary> <param name="infoObj">Object to check in</param> <param name="versionNumber">Version number, optional. Is assigned automatically when not specified.</param> <param name="comment">Version comment, optional</param> <exception cref="T:CMS.Synchronization.ObjectVersioningException">Throws an exception if it is not possible to check in the object.</exception> </member> <member name="T:CMS.Synchronization.SynchronizationAction"> <summary> Synchronization action implementation </summary> </member> <member name="P:CMS.Synchronization.SynchronizationAction.Condition"> <summary> Condition which must be met in order to execute action </summary> </member> <member name="P:CMS.Synchronization.SynchronizationAction.Execute"> <summary> Action which should be executed </summary> </member> <member name="M:CMS.Synchronization.SynchronizationAction.#ctor(System.Func{CMS.DataEngine.LogObjectChangeSettings,System.Collections.Generic.IEnumerable{CMS.Synchronization.ISynchronizationTask}},System.Func{CMS.DataEngine.LogObjectChangeSettings,System.Boolean})"> <summary> Constructor </summary> <param name="execute">Method executed to perform the action</param> <param name="condition">Condition under which the action is executed</param> </member> <member name="M:CMS.Synchronization.SynchronizationAction.ExecuteAction(CMS.DataEngine.LogObjectChangeSettings)"> <summary> Executes the given action </summary> <param name="settings">Action settings</param> </member> <member name="M:CMS.Synchronization.SynchronizationAction.CanBeExecuted(CMS.DataEngine.LogObjectChangeSettings)"> <summary> Returns true if the action should be executed </summary> <param name="settings">Action settings</param> </member> <member name="T:CMS.Synchronization.TaskGroupInfo"> <summary> TaskGroupInfo data container class. </summary> </member> <member name="F:CMS.Synchronization.TaskGroupInfo.PERMISSION_MANAGE_TASK_GROUPS"> <summary> Permission name that allows user to manage task groups(create, edit, delete). </summary> </member> <member name="F:CMS.Synchronization.TaskGroupInfo.OBJECT_TYPE"> <summary> Object type </summary> </member> <member name="F:CMS.Synchronization.TaskGroupInfo.TYPEINFO"> <summary> Type information. </summary> </member> <member name="P:CMS.Synchronization.TaskGroupInfo.TaskGroupID"> <summary> Task group ID </summary> </member> <member name="P:CMS.Synchronization.TaskGroupInfo.TaskGroupDescription"> <summary> Task group description </summary> </member> <member name="P:CMS.Synchronization.TaskGroupInfo.TaskGroupCodeName"> <summary> Task group code name </summary> </member> <member name="P:CMS.Synchronization.TaskGroupInfo.TaskGroupGuid"> <summary> Task group guid </summary> </member> <member name="M:CMS.Synchronization.TaskGroupInfo.CheckPermissionsInternal(CMS.DataEngine.PermissionsEnum,System.String,CMS.Base.IUserInfo,System.Boolean)"> <summary> Checks the permissions of the object. </summary> <param name="permission">Permission type</param> <param name="siteName">Name of the site</param> <param name="userInfo">UserInfo object</param> <param name="exceptionOnFailure">If true, PermissionCheckException is thrown whenever a permission check fails</param> </member> <member name="M:CMS.Synchronization.TaskGroupInfo.DeleteObject"> <summary> Deletes the object using appropriate provider. </summary> </member> <member name="M:CMS.Synchronization.TaskGroupInfo.SetObject"> <summary> Updates the object using appropriate provider. </summary> </member> <member name="M:CMS.Synchronization.TaskGroupInfo.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Constructor for de-serialization. </summary> <param name="info">Serialization info</param> <param name="context">Streaming context</param> </member> <member name="M:CMS.Synchronization.TaskGroupInfo.#ctor"> <summary> Constructor - Creates an empty TaskGroupInfo object. </summary> </member> <member name="M:CMS.Synchronization.TaskGroupInfo.#ctor(System.Data.DataRow)"> <summary> Constructor - Creates a new TaskGroupInfo object from the given DataRow. </summary> <param name="dr">DataRow with the object data</param> </member> <member name="T:CMS.Synchronization.TaskGroupInfoProvider"> <summary> Class providing TaskGroupInfo management. </summary> </member> <member name="M:CMS.Synchronization.TaskGroupInfoProvider.#ctor"> <summary> Constructor </summary> </member> <member name="M:CMS.Synchronization.TaskGroupInfoProvider.GetTaskGroups"> <summary> Returns a query for all the TaskGroupInfo objects. </summary> </member> <member name="M:CMS.Synchronization.TaskGroupInfoProvider.GetTaskGroupInfo(System.Int32)"> <summary> Returns TaskGroupInfo with specified ID. </summary> <param name="id">TaskGroupInfo ID</param> </member> <member name="M:CMS.Synchronization.TaskGroupInfoProvider.GetTaskGroupInfo(System.String)"> <summary> Returns TaskGroupInfo with specified name. </summary> <param name="name">TaskGroupInfo name</param> </member> <member name="M:CMS.Synchronization.TaskGroupInfoProvider.GetTaskGroupInfo(System.Guid)"> <summary> Returns TaskGroupInfo with specified GUID. </summary> <param name="guid">TaskGroupInfo GUID</param> </member> <member name="M:CMS.Synchronization.TaskGroupInfoProvider.SetTaskGroupInfo(CMS.Synchronization.TaskGroupInfo)"> <summary> Sets (updates or inserts) specified TaskGroupInfo. </summary> <param name="infoObj">TaskGroupInfo to be set</param> </member> <member name="M:CMS.Synchronization.TaskGroupInfoProvider.DeleteTaskGroupInfo(CMS.Synchronization.TaskGroupInfo)"> <summary> Deletes specified TaskGroupInfo. </summary> <param name="infoObj">TaskGroupInfo to be deleted</param> </member> <member name="M:CMS.Synchronization.TaskGroupInfoProvider.DeleteTaskGroupInfo(System.Int32)"> <summary> Deletes TaskGroupInfo with specified ID. </summary> <param name="id">TaskGroupInfo ID</param> </member> <member name="M:CMS.Synchronization.TaskGroupInfoProvider.GetUserTaskGroupInfo(System.Int32)"> <summary> Get TaskGroupInfo for user or null. </summary> <param name="userID">User for whom to return his current task group ID</param> </member> <member name="M:CMS.Synchronization.TaskGroupInfoProvider.SetTaskGroupForUser(System.Int32,System.Int32)"> <summary> Sets task group info for user. </summary> <param name="taskGroupID"> Task group ID to be bound with user. If <paramref name="taskGroupID"/> is 0, user won't be assigned to any task group. </param> <param name="userID">User to whom set task group.</param> <remarks> It's not recommend to set the task group for users without their knowledge. For example, a suitable way to call the method is in the logic of a custom interface that allows users to set their task group. </remarks> </member> <member name="M:CMS.Synchronization.TaskGroupInfoProvider.GetUserTaskGroupInfoInternal(System.Int32)"> <summary> Get TaskGroupInfo for user or null. </summary> <param name="userID">User for whom to return his current task group ID</param> </member> <member name="M:CMS.Synchronization.TaskGroupInfoProvider.SetTaskGroupForUserInternal(System.Int32,System.Int32)"> <summary> Sets task group info for user. </summary> <param name="taskGroupID"> Task group ID to be bound with user. If <paramref name="taskGroupID"/> is 0, user won't be assigned to any task group.. </param> <param name="userID">User to whom set task group</param> <remarks> It's not recommend to set the task group for users without their knowledge. For example, a suitable way to call the method is in the logic of a custom interface that allows users to set their task group. </remarks> </member> <member name="T:CMS.Synchronization.TaskGroupTaskInfo"> <summary> TaskGroupTaskInfo data container class. </summary> </member> <member name="F:CMS.Synchronization.TaskGroupTaskInfo.OBJECT_TYPE"> <summary> Object type </summary> </member> <member name="F:CMS.Synchronization.TaskGroupTaskInfo.TYPEINFO"> <summary> Type information. </summary> </member> <member name="P:CMS.Synchronization.TaskGroupTaskInfo.TaskGroupTaskID"> <summary> Task group task ID </summary> </member> <member name="P:CMS.Synchronization.TaskGroupTaskInfo.TaskGroupID"> <summary> Task group ID </summary> </member> <member name="P:CMS.Synchronization.TaskGroupTaskInfo.TaskID"> <summary> Task ID </summary> </member> <member name="M:CMS.Synchronization.TaskGroupTaskInfo.DeleteObject"> <summary> Deletes the object using appropriate provider. </summary> </member> <member name="M:CMS.Synchronization.TaskGroupTaskInfo.SetObject"> <summary> Updates the object using appropriate provider. </summary> </member> <member name="M:CMS.Synchronization.TaskGroupTaskInfo.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Constructor for de-serialization. </summary> <param name="info">Serialization info</param> <param name="context">Streaming context</param> </member> <member name="M:CMS.Synchronization.TaskGroupTaskInfo.#ctor"> <summary> Constructor - Creates an empty TaskGroupTaskInfo object. </summary> </member> <member name="M:CMS.Synchronization.TaskGroupTaskInfo.#ctor(System.Data.DataRow)"> <summary> Constructor - Creates a new TaskGroupTaskInfo object from the given DataRow. </summary> <param name="dr">DataRow with the object data</param> </member> <member name="T:CMS.Synchronization.TaskGroupTaskInfoProvider"> <summary> Class providing <see cref="T:CMS.Synchronization.TaskGroupTaskInfo"/> management. </summary> </member> <member name="M:CMS.Synchronization.TaskGroupTaskInfoProvider.GetTaskGroupTasks"> <summary> Returns all <see cref="T:CMS.Synchronization.TaskGroupTaskInfo"/> bindings. </summary> </member> <member name="M:CMS.Synchronization.TaskGroupTaskInfoProvider.GetTaskGroupTask(System.Int32,System.Int32)"> <summary> Returns <see cref="T:CMS.Synchronization.TaskGroupTaskInfo"/> binding structure. </summary> <param name="taskGroupId">Task group ID</param> <param name="taskId">Staging task ID</param> </member> <member name="M:CMS.Synchronization.TaskGroupTaskInfoProvider.SetTaskGroupTask(CMS.Synchronization.TaskGroupTaskInfo)"> <summary> Sets specified <see cref="T:CMS.Synchronization.TaskGroupTaskInfo"/>. </summary> <param name="infoObj">TaskGroupTask to set</param> </member> <member name="M:CMS.Synchronization.TaskGroupTaskInfoProvider.DeleteTaskGroupTask(CMS.Synchronization.TaskGroupTaskInfo)"> <summary> Deletes specified <see cref="T:CMS.Synchronization.TaskGroupTaskInfo"/> binding. </summary> <param name="infoObj"><see cref="T:CMS.Synchronization.TaskGroupTaskInfo"/> object</param> </member> <member name="M:CMS.Synchronization.TaskGroupTaskInfoProvider.RemoveTaskGroupFromTask(System.Int32,System.Int32)"> <summary> Deletes <see cref="T:CMS.Synchronization.TaskGroupTaskInfo"/> binding. </summary> <param name="taskGroupId">Task group ID</param> <param name="taskId">Staging task ID</param> </member> <member name="M:CMS.Synchronization.TaskGroupTaskInfoProvider.AddTaskGroupToTask(System.Int32,System.Int32)"> <summary> Creates <see cref="T:CMS.Synchronization.TaskGroupTaskInfo"/> binding. </summary> <param name="taskGroupId">Task group ID</param> <param name="taskId">Staging task ID</param> </member> <member name="M:CMS.Synchronization.TaskGroupTaskInfoProvider.UpdateTaskGroupTask(CMS.DataEngine.IWhereCondition,System.Collections.Generic.IEnumerable{System.Collections.Generic.KeyValuePair{System.String,System.Object}})"> <summary> Updates <see cref="T:CMS.Synchronization.TaskGroupTaskInfo"/> bindings for given where condition with values. </summary> <param name="where">Staging tasks group bindings to be updated</param> <param name="values">Values to be updated in columns</param> </member> <member name="M:CMS.Synchronization.TaskGroupTaskInfoProvider.GetTaskGroupTaskInternal(System.Int32,System.Int32)"> <summary> Returns the <see cref="T:CMS.Synchronization.TaskGroupTaskInfo"/> structure. Null if binding doesn't exist. </summary> <param name="taskGroupId">Task group ID</param> <param name="taskId">Staging task ID</param> </member> <member name="M:CMS.Synchronization.TaskGroupTaskInfoProvider.RemovetaskGroupFromTaskInternal(System.Int32,System.Int32)"> <summary> Deletes <see cref="T:CMS.Synchronization.TaskGroupTaskInfo"/> binding. </summary> <param name="taskGroupId">Task group ID</param> <param name="taskId">Staging task ID</param> </member> <member name="M:CMS.Synchronization.TaskGroupTaskInfoProvider.AddtaskGroupToTaskInternal(System.Int32,System.Int32)"> <summary> Creates <see cref="T:CMS.Synchronization.TaskGroupTaskInfo"/> binding. </summary> <param name="taskGroupId">Task group ID</param> <param name="taskId">Staging task ID</param> </member> <member name="M:CMS.Synchronization.TaskGroupTaskInfoProvider.DeleteTaskGroupTaskInfos(CMS.DataEngine.IWhereCondition)"> <summary> Deletes all <see cref="T:CMS.Synchronization.TaskGroupTaskInfo"/> bindings that satisfy where condition. </summary> <param name="where">Where condition to which <see cref="T:CMS.Synchronization.TaskGroupTaskInfo"/> bindings to delete</param> </member> <member name="T:CMS.Base.TaskHelper"> <summary> Task management methods. </summary> </member> <member name="F:CMS.Base.TaskHelper.TASK_TYPE_CATEGORY_CONTENT"> <summary> Enum category in TaskTypeEnum to select content related task types. </summary> </member> <member name="F:CMS.Base.TaskHelper.TASK_TYPE_CATEGORY_OBJECTS"> <summary> Enum category in TaskTypeEnum to select objects and data related task types. </summary> </member> <member name="F:CMS.Base.TaskHelper.TASK_TYPE_CATEGORY_DATA"> <summary> Enum category in TaskTypeEnum to select general task types. </summary> </member> <member name="F:CMS.Base.TaskHelper.TASK_TYPE_CATEGORY_GENERAL"> <summary> Enum category in TaskTypeEnum to select general task types. </summary> </member> <member name="F:CMS.Base.TaskHelper.TASK_TYPE_RESOURCE_STRING_PREFIX"> <summary> Prefix for resource strings that localize TaskTypeEnum </summary> </member> <member name="M:CMS.Base.TaskHelper.GetTaskTypeString(CMS.DataEngine.TaskTypeEnum)"> <summary> Returns the task type string. </summary> <param name="taskType">Task type</param> </member> <member name="M:CMS.Base.TaskHelper.GetTaskTypeEnum(System.String)"> <summary> Returns the task type enumeration value. </summary> <param name="taskType">String task type representation</param> </member> <member name="M:CMS.Base.TaskHelper.IsExcludedAsyncTask(CMS.DataEngine.TaskTypeEnum)"> <summary> Indicates if the task type shouldn't be processed asynchronously. </summary> <param name="taskType">Task type</param> </member> </members> </doc> |