MetadataField

public struct MetadataField : BoxInnerModel

A field in a metadata template.

Properties

  • id

    Identfier

    Declaration

    Swift

    public let id: String?

  • The data type of the field’s value.

    Declaration

    Swift

    public let type: String?
  • key

    A unique identifier for the field. The identifier must be unique within the template to which it belongs.

    Declaration

    Swift

    public let key: String?

  • The display name of the field.

    Declaration

    Swift

    public let displayName: String?

  • A description of the field.

    Declaration

    Swift

    public let description: String?

  • For type enum, a list of all possible value

    Declaration

    Swift

    public let options: [[String : String]]?

  • Whether this template is hidden in the UI

    Declaration

    Swift

    public let hidden: Bool?

  • Initializer.

    Declaration

    Swift

    public init(
    id: String? = nil,
    type: String? = nil,
    key: String? = nil,
    displayName: String? = nil,
    description: String? = nil,
    options: [[String: String]]? = nil,
    hidden: Bool? = nil
)

    Parameters

    id

    Identfier
    type

    The data type of the field’s value.
    key

    A unique identifier for the field. The identifier must be unique within the template to which it belongs.
    displayName

    The display name of the field. All characters are allowed.
    description

    A description of the field. The recommended character limit is 4096. All characters are allowed.
    options

    For type enum, a list of all possible values.
    hidden

    Whether this template is hidden in the UI.