ICustomHooks Interface

Represents custom hooks, applicable to any entity. The purpose of the hooks is for custom integration to be called on state changes within the CMS.

Namespace: Ingeniux.CMS.Models.Hooks
Assembly: Ingeniux.CMS.CSAPI (in Ingeniux.CMS.CSAPI.dll) Version: 10.6.308

Syntax

C++

Copy

public interface ICustomHooks : IPageHooks, 
	IContentItemHooks<IPage>, IAssetHooks, ITaxonomyHooks, IUserGroupHooks, 
	IWorkflowHooks, IAssetWorkflowHooks, IPublishHooks, IPublishContentProcessorHooks

Public Interface ICustomHooks
	Inherits IPageHooks, IContentItemHooks(Of IPage), IAssetHooks, 
	ITaxonomyHooks, IUserGroupHooks, IWorkflowHooks, IAssetWorkflowHooks, IPublishHooks, 
	IPublishContentProcessorHooks

public interface class ICustomHooks : IPageHooks, 
	IContentItemHooks<IPage^>, IAssetHooks, ITaxonomyHooks, IUserGroupHooks, 
	IWorkflowHooks, IAssetWorkflowHooks, IPublishHooks, IPublishContentProcessorHooks

type ICustomHooks =  
    interface
        interface IPageHooks
        interface IContentItemHooks<IPage>
        interface IAssetHooks
        interface ITaxonomyHooks
        interface IUserGroupHooks
        interface IWorkflowHooks
        interface IAssetWorkflowHooks
        interface IPublishHooks
        interface IPublishContentProcessorHooks
    end

The ICustomHooks type exposes the following members.

Methods

	Name	Description
	OnAfterAddToWorkflow	This method is invoked after a Page is added to a workflow. (Inherited from IPageHooks.)
	OnAfterAddToWorkflowAsset	This method is invoked after an Asset is added to a workflow. (Inherited from IAssetHooks.)
	OnAfterAssign	Custom hook that fires after a Content Item is assigned (Inherited from IContentItemHooksT.)
	OnAfterAssignAsset	This method is invoked after an Asset was assigned to a User. DO NOT call contentItem.AssignUser or contentItem.AssignGroup inside this method, otherwise it will cause infinite loop (Inherited from IAssetHooks.)
	OnAfterCategoryDelete	This method is invoked after a Category Node was deleted (Inherited from ITaxonomyHooks.)
	OnAfterCheckIn	Custom hook that fires after a Content Item is checked in. (Inherited from IContentItemHooksT.)
	OnAfterCheckInAsset	This method is invoked after an Asset was checked in. (Inherited from IAssetHooks.)
	OnAfterCheckOut	Custom hook that fires after a Content Item is checked out. (Inherited from IContentItemHooksT.)
	OnAfterCheckOutAsset	This method is invoked after an Asset was checked out. (Inherited from IAssetHooks.)
	OnAfterCopy	Custom hook that fires after a Page is copied. (Inherited from IPageHooks.)
	OnAfterCopyAsset	This method is invoked after an Asset was copied. (Inherited from IAssetHooks.)
	OnAfterCrossLocaleCopy	Custom hook that fires after a Page is lingually copied. (Inherited from IPageHooks.)
	OnAfterCrossLocaleCopyAsset	This method is invoked after a non-Region-Root Asset was pasted under another Region Root. (Inherited from IAssetHooks.)
	OnAfterDelete	Custom hook that fires after a Content Item is deleted. (Inherited from IContentItemHooksT.)
	OnAfterDeleteAsset	This method is invoked after an Asset was moved to recycle folder or removed permanently. (Inherited from IAssetHooks.)
	OnAfterEmptyAssetRecycleFolder	This method is invoked after all Assets under the Recycle Folder were permanently removed. (Inherited from IAssetHooks.)
	OnAfterEmptyRecycleFolder	Custom hook that fires after the Recycle Folder is emptied (Inherited from IPageHooks.)
	OnAfterEntitySave	This method is invoked after any type of Ingeniux CMS CSAPI Entity object was saved.
	OnAfterLogout	This method is invoked after a User logged out.
	OnAfterMarkForPublish	Custom hook that fires after a Content Item has its marking changed. (Inherited from IContentItemHooksT.)
	OnAfterMarkForPublishAsset	This method is invoked after an Asset was marked/unmarked for publish. (Inherited from IAssetHooks.)
	OnAfterMove	Custom hook that fires after a Page is moved. (Inherited from IPageHooks.)
	OnAfterMoveAsset	This method is invoked after an Asset was moved to another location. (Inherited from IAssetHooks.)
	OnAfterMoveTaxonomy	This method is invoked after a Taxonomy Category Node was moved to another location. (Inherited from ITaxonomyHooks.)
	OnAfterPasteSpecial	Custom hook that fires after a copied Page is pasted. (Inherited from IPageHooks.)
	OnAfterPublishContentProcessing	This method is invoked after Publishing Content Processing completes (Inherited from IPublishContentProcessorHooks.)
	OnAfterRegionRootCopy	Custom hook that fires after a Region Root is lingually copied. (Inherited from IPageHooks.)
	OnAfterRegionRootCopyAsset	This method is invoked after a Region Root Asset was cloned into another Region Root Asset, with lingual maps established between the two Regions. (Inherited from IAssetHooks.)
	OnAfterRemoveFromWorkflow	This method is invoked after a Page is removed from a workflow. (Inherited from IPageHooks.)
	OnAfterRemoveFromWorkflowAsset	This method is invoked after an Asset is removed from a workflow. (Inherited from IAssetHooks.)
	OnAfterRollback	Custom hook that fires after a Content Item is rolled back to a previous version. (Inherited from IContentItemHooksT.)
	OnAfterRollbackAsset	This method is invoked after an Asset was rolled back to its previous version. (Inherited from IAssetHooks.)
	OnAfterUndoCheckOut	Custom hook that fires after a Content Item is reverted to its checked in state. (Inherited from IContentItemHooksT.)
	OnAfterUndoCheckOutAsset	This method is invoked before a non-Region-Root Asset is copied to under another Region Root. (Inherited from IAssetHooks.)
	OnAfterUpload	This method is invoke after a File Upload got processed by Ingeniux CMS Site Instance server.
	OnAfterUserDelete	This method is invoked after a User was deleted (Inherited from IUserGroupHooks.)
	OnAfterUserGroupDelete	This method is invoked after a UserGroup was deleted (Inherited from IUserGroupHooks.)
	OnAfterWorkflowAdvance	This method is invoked after a Workflow advanced through a Transition (Inherited from IWorkflowHooks.)
	OnAfterWorkflowAdvanceAsset	This method is invoked after a content item was advanced in workflow. (Inherited from IAssetWorkflowHooks.)
	OnAssetCategorizationChange	This method is invoked association or disassociation between a Category Node and an Asset. (Inherited from ITaxonomyHooks.)
	OnAssetCheckedInContentUpdated	This method is invoked after the Asset file content is updated on the checked in version of the Asset. (Inherited from IAssetHooks.)
	OnBeforeAddToWorkflow	This method is invoked before a Page is added to a workflow. (Inherited from IPageHooks.)
	OnBeforeAddToWorkflowAsset	This method is invoked before an Asset is added to a workflow. (Inherited from IAssetHooks.)
	OnBeforeAssign	Custom hook that fires before a Content Item is assigned. (Inherited from IContentItemHooksT.)
	OnBeforeAssignAsset	This method is invoked before an Asset is assigned to a User. DO NOT call contentItem.AssignUser or contentItem.AssignGroup inside this method, otherwise it will cause an infinite loop. (Inherited from IAssetHooks.)
	OnBeforeCategoryDelete	This method is invoked before a Category Node is deleted (Inherited from ITaxonomyHooks.)
	OnBeforeCheckIn	Custom hook that fires before a Content Item is checked in. (Inherited from IContentItemHooksT.)
	OnBeforeCheckInAsset	This method is invoked before an Asset is checked in. (Inherited from IAssetHooks.)
	OnBeforeCheckOut	Custom hook that fires before a Content Item is checked out. (Inherited from IContentItemHooksT.)
	OnBeforeCheckOutAsset	This method is invoked before an Asset is checked out. (Inherited from IAssetHooks.)
	OnBeforeCopy	Custom hook that fires before a Page is copied. (Inherited from IPageHooks.)
	OnBeforeCopyAsset	This method is invoked before an Asset is copied. (Inherited from IAssetHooks.)
	OnBeforeCrossLocaleCopy	Custom hook that fires before a Page is lingually copied. (Inherited from IPageHooks.)
	OnBeforeCrossLocaleCopyAsset	This method is invoked before a non-Region-Root Asset is copied to under another Region Root. (Inherited from IAssetHooks.)
	OnBeforeDelete	Custom hook that fires before a Content Item is deleted. (Inherited from IContentItemHooksT.)
	OnBeforeDeleteAsset	This method is invoked before an Asset moved to recycle folder to removed permanently. (Inherited from IAssetHooks.)
	OnBeforeEmptyAssetRecycleFolder	This method is invoked before all Assets under the Recycle Folder are permanently removed. (Inherited from IAssetHooks.)
	OnBeforeEmptyRecycleFolder	Custom hook that fires before the Recycle Folder is emptied (Inherited from IPageHooks.)
	OnBeforeEntitySave	This method is invoked before any type of Ingeniux CMS CSAPI Entity object is saved
	OnBeforeLogout	This method is invoked before a User attempt to log out.
	OnBeforeMarkForPublish	Custom hook that fires before a Content Item has its marking changed. (Inherited from IContentItemHooksT.)
	OnBeforeMarkForPublishAsset	This method is invoked before an Asset is marked/unmarked for publish. (Inherited from IAssetHooks.)
	OnBeforeMove	Custom hook that fires before a Page is moved. (Inherited from IPageHooks.)
	OnBeforeMoveAsset	This method is invoked before an Asset is moved to another location. (Inherited from IAssetHooks.)
	OnBeforeMoveTaxonomy	This method is invoked before a Taxonomy Category Node is moved to another location. (Inherited from ITaxonomyHooks.)
	OnBeforePasteSpecial	Custom hook that fires before a copied Page is pasted. (Inherited from IPageHooks.)
	OnBeforePublish	This method is invoked before a Publishing Task is submitted (Inherited from IPublishHooks.)
	OnBeforePublishContentProcessing	This method is invoked before Publishing Content Processing begins (Inherited from IPublishContentProcessorHooks.)
	OnBeforeRegionRootCopy	Custom hook that fires before a Region Root is lingually copied. (Inherited from IPageHooks.)
	OnBeforeRegionRootCopyAsset	This method is invoked before a Region Root Asset is cloned into another Region Root Asset, with lingual maps established between the two Regions. (Inherited from IAssetHooks.)
	OnBeforeRemoveFromWorkflow	This method is invoked before a Page is removed from a workflow. (Inherited from IPageHooks.)
	OnBeforeRemoveFromWorkflowAsset	This method is invoked before an Asset is removed from a workflow. (Inherited from IAssetHooks.)
	OnBeforeRollback	Custom hook that fires before a Content Item is rolled back to a previous version. (Inherited from IContentItemHooksT.)
	OnBeforeRollbackAsset	This method is invoked before an Asset is rolled back to its previous version. (Inherited from IAssetHooks.)
	OnBeforeUndoCheckOut	Custom hook that fires before a Content Item is reverted to its checked in state. (Inherited from IContentItemHooksT.)
	OnBeforeUndoCheckOutAsset	This method is invoked before an Asset abandons its checked out version and reverts back to its last checked in version. (Inherited from IAssetHooks.)
	OnBeforeUpload	This method is invoke before a File Upload gets processed by Ingeniux CMS Site Instance server.
	OnBeforeUserDelete	This method is invoked before a User is deleted (Inherited from IUserGroupHooks.)
	OnBeforeUserGroupDelete	This method is invoked before a UserGroup is deleted (Inherited from IUserGroupHooks.)
	OnBeforeWorkflowAdvance	This method is invoked before a Workflow advances through a Transition (Inherited from IWorkflowHooks.)
	OnBeforeWorkflowAdvanceAsset	This method is invoked before a content item is advanced in workflow. (Inherited from IAssetWorkflowHooks.)
	OnCategoryCreated	This method is invoked after a Category Node was created (Inherited from ITaxonomyHooks.)
	OnCategoryRenamed	This method is invoked after a Category Node was created. DO NOT assign to CategoryNode.Name in third method; otherwise, it will cause infinite loop (Inherited from ITaxonomyHooks.)
	OnNew	Custom hook that fires when a new Page is created. (Inherited from IPageHooks.)
	OnNewAsset	This method is invoked after a new Asset is created. (Inherited from IAssetHooks.)
	OnPageCategorizationChange	This method is invoked association or disassociation between a Category Node and an Page. (Inherited from ITaxonomyHooks.)
	OnPublishComplete	This method is invoked after a Publishing Task was completed (Inherited from IPublishHooks.)
	OnRename	Custom hook that fires when a Content Item is renamed. (Inherited from IContentItemHooksT.)
	OnRenameAsset	This method is invoked after an Asset is renamed. DO NOT call contentItem.Name inside this method, otherwise it will cause an infinite loop. (Inherited from IAssetHooks.)
	OnUpdateAsset	This method is invoked after an edit to an Asset File is saved. (Inherited from IAssetHooks.)
	OnUserCreated	This method is invoked after a User was created (Inherited from IUserGroupHooks.)
	OnUserGroupCreated	This method is invoked after a UserGroup was created (Inherited from IUserGroupHooks.)

Top

Reference

Ingeniux.CMS.Models.Hooks Namespace