CustomMetadataValue Class

Represents custom metadata values for a custom metadata component.

Namespace

Metadata

Usage

Use Metadata.CustomMetadataValue to access values for custom fields of custom metadata records.

Supported Apex primitive types are:
  • Boolean
  • Date
  • DateTime
  • Decimal
  • Double
  • Integer
  • Long
  • String

Example

// Set a custom field value for a custom metadata record
Metadata.CustomMetadataValue customField = new Metadata.CustomMetadataValue();
customField.field = 'CustomField1__c';
customField.value = 'New Value';
customMetadata.values.add(customField);

CustomMetadataValue Properties

The following are properties for CustomMetadataValue.

  • field
    The field name for the custom metadata value.
  • value
    The field value for the custom metadata value.

field

The field name for the custom metadata value.

Signature

public String field {get; set;}

Property Value

Type: String

value

The field value for the custom metadata value.

Signature

public Object value {get; set;}

Property Value

Type: Object

Supported Apex primitive types are:
  • Boolean
  • Date
  • DateTime
  • Decimal
  • Double
  • Integer
  • Long
  • String

When setting the value for relationship fields, use the qualified API name of the related metadata, not the ID.

For more information, see Primitive Data Types.

CustomMetadataValue Methods

The following are methods for CustomMetadataValue.

  • clone()
    Makes a duplicate copy of the Metadata.CustomMetadataValue.

clone()

Makes a duplicate copy of the Metadata.CustomMetadataValue.

Signature

public Object clone()

Return Value

Type: Object