Get Involved
Edit on GitHub

ControlType

ControlType

Represents a ControlType defined within a Mod.

For more information, please see Controls.

actionTypesActionTypesReturns any recommended actionTypes for this ControlType that you have permission to get, subject to the optional filter and paging arguments.
categoryControlCategoryThe category information for this ControlType.
categoryUriString!Unique identifier for the category.
childrenControlTypesThe immediate children for this ControlType.
controlsControlsReturns any controls for this ControlType that you have permission to get, subject to the optional filter and paging arguments.
descendantsControlTypesThe descendants of this ControlType.
descriptionStringShort human-friendly description.
events[String!]events that trigger a run of instances of this ControlType.
iconStringFontAwesome icon reference, used for display in the product and documentation. Will be in the format fal-<icon>, far-<icon> or fas-<icon> for light, regular and solid icon classes respectively.
modUriString!Unique identifier for the defining mod.
policySettingsPolicySettingsReturns any policySettings for this ControlType that you have permission to get, subject to the optional filter and paging arguments.
relatedControls[String]Related control type URIs.
resourcesResourcesThe resources of this ControlType, subject to the optional filter and paging arguments.
targets[String!]Target resource interface / type URIs.
titleString!Display title.
trunkTrunkItemsThe trunk for this ControlType, subject to the optional filter and paging arguments. This will show the resource type hierarchy from the root down to this ControlType.
turbotTurbotControlTypeMetadata!Turbot metadata for this ControlType.
uriString!Mod-specific unique identifier.