Documentation

DealCategory

DealCategory class handles Deal pipelines (categories).


Method Description Available from version
add Adds new entry.
applyMaximumLimitRestrictions Limits number of active Pipelines and blocks the rest of pipelines.
checkReadPermission Checks, if user has access permissions for reading Deal Pipelines.
convertFromStatusEntityID Converts entity status ID into Deal Pipeline entry ID.
convertToPermissionEntityType Allows getting access permission type ID for specified Pipeline.
convertToStatusEntityID Converts Deal pipeline ID into entity status ID.
createDefaultStages Creates standard set of Deal stages for specified Deal pipeline entry.
delete Deletes entry by ID.
erasePermissions Deletes all permissions, related to specified Deal pipeline.
eraseStages Deletes all Deal stages, belonging to specified Deal pipeline.
exists Checks, if pipeline exists.
get Gets Deal pipeline by ID.
getAll Gets all entries.
getAllIDs Gets all entry IDs.
getCount Gets total pipeline count.
getFieldsInfo Gets metadata fields.
getJavaScriptInfos Prepares JavaScript information.
getList Gets list of entries.
getName Gets pipeline name.
getSelectListItems Gets elements for options selection.
getStageFilterInfo Prepares data for filter by stages, grouped by pipelines.
getStageInfos Gets data on stages for specified Deal pipeline.
getStageList Gets list of stages for specified Deal pipeline.
hasDependencies Checks for available Deal for this pipeline.
hasStatusEntity Checks, if specified entity status belongs to Deal pipeline.
isEnabled Checks if pipeline exists and is not blocked.
issueStageID Issues new stage ID.
prepareFormID Prepares form ID from specified pipeline.
prepareStageID Prepares namespace unique ID.
prepareStageNamespaceID Prepares namespace ID for Deal stage.
prepareStatusEntityInfos Adds information on entity type status to receiving array for all registered Deal pipelines.
resolveFromStageID Deletes color scheme, belonging to specified Deal pipeline.
resolveByName Searches Pipeline entry ID by name.
resolveFromStageID Searches Pipeline ID by stage ID.
update Updates entry fields.


© «Bitrix24», 2001-2024
Up