Workflow Component Type

The following is a breakdown of the workflow components

Swift implementation

The following is the implementation of the workflow component which is available to component developers in the swift SDK

The following are generated from an openAPI standard and are made accessible publicly in the SDK.

Component

public struct DeployedWorkflowSchemaComponentsInner: Codable, JSONEncodable, Hashable {
    public var id: String
    public var availableToAllCompanies: Bool
    public var availableDevices: [String]
    public var builderCompatibility: String
    public var componentId: String
    public var componentType: String
    public var revision: Double
    public var title: String
    public var type: String
    public var userCustomizedTitle: String?
    public var userCustomizedInstructions: String?
    public var dynamicComponentId: String
    public var additionalProperties: [String: AnyCodable]?
    public var nextButtonInBar: Bool?
    public var nextButtonInBarText: String?
    public var iosHwRequirements: [String]?
    public var customizableParameters: [DeployedWorkflowSchemaComponentsInnerCustomizableParametersInner]
    public var componentDescription: String
    public var dynamicComponentRenderer: Bool
    public var useCustomViewForParams: Bool?
    public var implementationUrl: String
    public var inputs: [DeployedWorkflowSchemaComponentsInnerInputsInner]
    public var outputs: [DeployedWorkflowSchemaComponentsInnerOutputsInner]
}

Inputs

public struct DeployedWorkflowSchemaComponentsInnerInputsInner: Codable, JSONEncodable, Hashable {
    public var dynamicInputId: String
    public var inputClassification: String?
    public var group: String?
    public var inputDataType: String
    public var inputDescription: String?
    public var inputId: String
    public var inputName: String
    public var _required: Bool?
    public var acceptsArray: Bool?
    public var trigger: Bool?
    public var additionalProperties: [String: AnyCodable]
}

Outputs

public struct DeployedWorkflowSchemaComponentsInnerOutputsInner: Codable, JSONEncodable, Hashable {
    public var dynamicOutputId: String
    public var group: String?
    public var outputImmediately: Bool?
    public var outputClassification: String?
    public var outputDataType: String
    public var outputDescription: String?
    public var outputId: String
    public var outputName: String
    public var _required: Bool?
    public var outputsArray: Bool?
    public var outputImmediatelyUserDefinable: Bool?
    public var additionalProperties: [String: AnyCodable]
    public var outputConnections: [DeployedWorkflowSchemaComponentsInnerOutputsInnerOutputConnectionsInner]?
}

Customizable Parameters

Allows for the user to customize the implementation of the component within the app builder.

public struct DeployedWorkflowSchemaComponentsInnerCustomizableParametersInner: Codable, JSONEncodable, Hashable {
    public var paramDataType: String
    public var paramDescription: String
    public var paramId: String
    public var paramGroup: String?
    public var paramInputType: String?
    public var paramName: String
    public var selectedValue: AnyCodable?
    public var userCustomizable: Bool?
    public var relatedInputDynamicId: String?
    public var relatedOutputDynamicId: String?
    public var selectedValueIsArray: Bool?
    public var selectedValueArray: [AnyCodable]?
}