ActionParameter

public struct ActionParameter
extension ActionParameter: Codable
extension ActionParameter: JSONDecodable
extension ActionParameter: DictionaryConvertible

Parameter of Action

  • Id of the parameter

    Declaration

    Swift

    public let name: String

  • Type of this parameter

    Declaration

    Swift

    public let type: ActionParameterType

  • Localized name to display

    Declaration

    Swift

    public let label: String?

  • Short localized name to display

    Declaration

    Swift

    public let shortLabel: String?

  • Information about icon

    Declaration

    Swift

    public let icon: String?

  • Action parameter format.

    Declaration

    Swift

    public let format: ActionParameterFormat?

  • Default value

    Declaration

    Swift

    public let `default`: AnyCodable?

  • Bind default value to a field.

    Declaration

    Swift

    public let defaultField: String?

  • Placeholder

    Declaration

    Swift

    public let placeholder: String?

  • Undocumented

    Declaration

    Swift

    public let choiceList: AnyCodable?

  • Undocumented

    Declaration

    Swift

    public let rules: [ActionParameterRule]?

  • shortcut to known if there is a .mandatory rule

    Declaration

    Swift

    public var mandatory: Bool { get }

  • Return label if any, otherwise short label if any, otherwise the name

    Declaration

    Swift

    public var preferredLongLabel: String { get }

  • Return short label if any, otherwise label if any, otherwise the name

    Declaration

    Swift

    public var preferredShortLabel: String { get }

Codable

  • Declaration

    Swift

    public init(from decoder: Decoder) throws

JSON