CreateValue

public struct CreateValue : Codable, Equatable

CreateValue.

  • Specifies the type of entity value.

    See more

    Declaration

    Swift

    public enum TypeEnum : String

  • The text of the entity value. This string must conform to the following restrictions:

    • It cannot contain carriage return, newline, or tab characters.
    • It cannot consist of only whitespace characters.

    Declaration

    Swift

    public var value: String

  • Any metadata related to the entity value.

    Declaration

    Swift

    public var metadata: [String : JSON]?

  • Specifies the type of entity value.

    Declaration

    Swift

    public var type: String?

  • An array of synonyms for the entity value. A value can specify either synonyms or patterns (depending on the value type), but not both. A synonym must conform to the following resrictions:

    • It cannot contain carriage return, newline, or tab characters.
    • It cannot consist of only whitespace characters.

    Declaration

    Swift

    public var synonyms: [String]?

  • An array of patterns for the entity value. A value can specify either synonyms or patterns (depending on the value type), but not both. A pattern is a regular expression; for more information about how to specify a pattern, see the documentation.

    Declaration

    Swift

    public var patterns: [String]?

  • The timestamp for creation of the object.

    Declaration

    Swift

    public var created: Date?

  • The timestamp for the most recent update to the object.

    Declaration

    Swift

    public var updated: Date?

  • Initialize a CreateValue with member variables.

    Declaration

    Swift

    public init(
    value: String,
    metadata: [String: JSON]? = nil,
    type: String? = nil,
    synonyms: [String]? = nil,
    patterns: [String]? = nil
)

    Parameters

    value

    The text of the entity value. This string must conform to the following restrictions:

    • It cannot contain carriage return, newline, or tab characters.
    • It cannot consist of only whitespace characters.
    metadata

    Any metadata related to the entity value.
    type

    Specifies the type of entity value.
    synonyms

    An array of synonyms for the entity value. A value can specify either synonyms or patterns (depending on the value type), but not both. A synonym must conform to the following resrictions:

    • It cannot contain carriage return, newline, or tab characters.
    • It cannot consist of only whitespace characters.
    patterns

    An array of patterns for the entity value. A value can specify either synonyms or patterns (depending on the value type), but not both. A pattern is a regular expression; for more information about how to specify a pattern, see the documentation.

    Return Value

    An initialized CreateValue.