DTO_PickList

Class · Group: Data Transfer Objects

global inherited sharing class DTO_PickList

A Data Transfer Object (DTO) representing a single picklist and all associated values. This class is typically used to retrieve and manage picklist values dynamically, often for use in invocable actions.

Since: 1.0

Example:

DTO_PickList picklist = new DTO_PickList();
picklist.picklistName = 'Status__c';
picklist.values = new List<DTO_PicklistValue>();

See Also: FLOW_GetPicklistValues

---

Fields

Field	Description
global DTO_PicklistValue defaultValue	The default value for the picklist, represented as a DTO_PicklistValue object.
global String picklistName	The API name of the picklist field.
global List values	A list of all available values for this picklist.

---

Field Details

defaultValue

@AuraEnabled @InvocableVariable(required=false description='The default value for the picklist, or null if there isn't one' label='Default Value') global DTO_PicklistValue defaultValue

Type: DTO_PicklistValue

The default value for the picklist, represented as a DTO_PicklistValue object. If there is no default value, this field will be null.

Since: 1.0

Example:

DTO_PicklistValue value = instance.defaultValue;

picklistName

@AuraEnabled @InvocableVariable(required=true description='The API Name for the picklist' label='Api Name') global String picklistName

Type: String

The API name of the picklist field. This name is used for programmatic references and is case-sensitive.

Since: 1.0

Example:

String value = instance.picklistName;

values

@AuraEnabled @InvocableVariable(required=true description='A list of values for PickList field' label='Values') global List<DTO_PicklistValue> values

Type: List

A list of all available values for this picklist. Each entry is represented as a DTO_PicklistValue object, which includes both the label and API name of the value. This list corresponds to the field's available options and respects any record-type-specific or object-specific restrictions.

Since: 1.0

Example:

List<DTO_PicklistValue> value = instance.values;