Structures

The following structures are available globally.

  • CodingKey for converting a decoding container to a dictionary where any key in the dictionary is accessible.

    See more

    Declaration

    Swift

    public struct AnyCodingKey : CodingKey
  • Wrapper for any codable array.

    See more

    Declaration

    Swift

    public struct AnyCodableArray : Codable
  • Wrapper for any codable dictionary.

    See more

    Declaration

    Swift

    public struct AnyCodableDictionary : Codable
  • RSDAnswerResultObject is a concrete implementation of a result that can be described using a single value.

    See more

    Declaration

    Swift

    public struct RSDAnswerResultObject : RSDAnswerResult, Codable
  • RSDAnswerResultType is a Codable struct that can be used to describe how to encode and decode an RSDAnswerResult. It carries information about the type of the value and how to encode it. This struct serves a different purpose from the RSDFormDataType because it only carries information required to store a result and not additional information about presentation style.

    See more

    Declaration

    Swift

    public struct RSDAnswerResultType : Codable, Hashable, Equatable
  • RSDChoiceObject is a concrete implementation of RSDChoice that can be used to track a multiple choice, single choice, or multiple component input field where each choice in the input field maps to a specific value.

    See more

    Declaration

    Swift

    public struct RSDChoiceObject<T> : RSDChoice, RSDComparable, RSDEmbeddedIconVendor, Codable where T : Decodable, T : Encodable
  • RSDColorPlacementThemeElementObject tells the UI what the background color and foreground color are for a given view as well as whether or not the foreground elements should use light style.

    The mapping is handled using a dictionary of color placements to the color style for that placement.

    See more

    Declaration

    Swift

    public struct RSDColorPlacementThemeElementObject : RSDColorMappingThemeElement, RSDDecodableBundleInfo
  • RSDSingleColorThemeElementObject tells the UI what the background color and foreground color are for a given view as well as whether or not the foreground elements should use light style.

    The mapping is handled using a single style for the entire view.

    See more

    Declaration

    Swift

    public struct RSDSingleColorThemeElementObject : RSDColorMappingThemeElement, RSDDecodableBundleInfo
  • The type of the color mapping theme element. This is used to decode a RSDColorMappingThemeElement using a RSDFactory. It can also be used to customize the UI.

    See more

    Declaration

    Swift

    public struct RSDColorMappingThemeElementType : RSDFactoryTypeRepresentable, Codable, Equatable, Hashable
  • A color library is a versioned collection of color swatches.

    See more

    Declaration

    Swift

    public struct RSDColorLibrary : Codable, Equatable, Hashable, Comparable
  • The color palette struct is used to describe the color palette for a given application. This is intended for applications that use the Sage Design System.

    See more

    Declaration

    Swift

    public struct RSDColorPalette : Codable, Equatable, Hashable
  • The color key is a model object that contains the information needed by the color design system to describe the colors associated with a given set of components.

    See more

    Declaration

    Swift

    public struct RSDColorKey : Codable, Equatable, Hashable, RSDColorMapping
  • A color swatch refers to a series of color tiles within the same family.

    See more

    Declaration

    Swift

    public struct RSDColorSwatch : Codable, Equatable, Hashable, RSDColorFamily
  • A special-case color swatch for gray scale components.

    See more

    Declaration

    Swift

    public struct RSDGrayScale : Codable, Equatable, Hashable, RSDColorFamily
  • A color tile is a single color and whether or not that color uses light style.

    See more

    Declaration

    Swift

    public struct RSDColorTile : Codable, Equatable, Hashable
  • RSDComparableSurveyRuleObject is a survey rule that matches an expected result to the answer and vends a skip identifier if the match is evaluated to true.

    See more

    Declaration

    Swift

    public struct RSDComparableSurveyRuleObject<T> : RSDComparableSurveyRule, Codable where T : Decodable, T : Encodable
  • RSDDateCoderObject provides a concrete implementation of a RSDDateCoder. The date coder is used by the RSDDateRangeObject to encode and decode the minDate and maxDate properties as well as to get which components of a date should be stored in the answer for a given RSDInputField.

    This coder uses ISO 8601 format to determine which calendar components to request from the user and to store from the input result. The calendar is ISO8601 and the resultFormatter is determined from the calendarComponents using the shared RSDFactory or the factory associated with the decoder if instantiated using a Decoder. The locale for the date formatters is en_US_POSIX by default.

    See more

    Declaration

    Swift

    public struct RSDDateCoderObject : RSDDateCoder, RawRepresentable
  • RSDDeviceType describes various devices. It can be used by a task to vend different steps or async actions based upon what is supported by a given device type.

    Note

    This is not currently used and may be deprecated.
    See more

    Declaration

    Swift

    public struct RSDDeviceType : RSDFactoryTypeRepresentable, Codable, Hashable
  • The default configuration to use for a RSDDistanceRecorder.

    • example:
        // Example json for a codable configuration.
           let json = """
                {
                   "identifier": "foo",
                   "type": "distance",
                   "motionStepIdentifier": "run"
                   "startStepIdentifier": "countdown",
                   "stopStepIdentifier": "rest",
               }
               """.data(using: .utf8)! // our data in native (JSON) format
    
    See more

    Declaration

    Swift

    @available(iOS 10.0, *)
    public struct RSDDistanceRecorderConfiguration : RSDRecorderConfiguration, Codable
  • A manifest for a given file that includes the filename, content type, and creation timestamp.

    See more

    Declaration

    Swift

    public struct RSDFileManifest : Codable, Hashable, Equatable
  • RSDFileResultObject is a concrete implementation of a result that holds a pointer to a file url.

    See more

    Declaration

    Swift

    public struct RSDFileResultObject : RSDFileResult, Codable
  • The RSDFormUIHint enum is a key word that can be used to describe the preferred UI for a form input field. This is intended as a hint that the designers and developers can use to indicate the preferred input style for an input field. Not all ui hints are applicable to all data types or devices, and therefore the ui hint may be ignored by the application displaying the input field to the user.

    See more

    Declaration

    Swift

    public struct RSDFormUIHint : RawRepresentable, Codable, Hashable
  • RSDGenericStepObject is a step with key/value pairs decoded from a dictionary. This is the default step returned by RSDFactory for an unrecoginized type.

    This step is intended for use as a placeholder step for decoding a step that may be defined using a customized subtype or for replacing properties on an RSDMutableStep.

    See more

    Declaration

    Swift

    public struct RSDGenericStepObject : RSDGenericStep, Decodable
  • The icon info is a simple image holder that also contains a title and subtitle for the image.

    See more

    Declaration

    Swift

    public struct RSDIconInfo : Codable
  • RSDIdentifier is intended to allow a developer to define constants for the identifiers that are used to define the tasks, steps, input fields, and async actions associated with a given task or task group.

    See more

    Declaration

    Swift

    public struct RSDIdentifier : RawRepresentable, Codable, Hashable
  • A hint as to where the UI should place an image.

    See more

    Declaration

    Swift

    public struct RSDImagePlacementType : RawRepresentable, Codable, Hashable, Equatable
  • RSDImageWrapper vends an image. It does not handle image caching. If your app using a custom image caching, then you will need to use the shared delegate to implement this. The image wrapper is designed to allow coding of images using an imageName property as a key for accessing the image.

    See more

    Declaration

    Swift

    public struct RSDImageWrapper
  • The default configuration to use for a RSDMotionRecorder.

    • example:
        // Example json for a codable configuration.
           let json = """
                {
                   "identifier": "foo",
                   "type": "motion",
                   "startStepIdentifier": "start",
                   "stopStepIdentifier": "stop",
                   "requiresBackgroundAudio": true,
                   "recorderTypes": ["accelerometer", "gyro", "magnetometer"],
                   "frequency": 50
               }
               """.data(using: .utf8)! // our data in native (JSON) format
    
    See more

    Declaration

    Swift

    @available(iOS 10.0, *)
    public struct RSDMotionRecorderConfiguration : RSDRestartableRecorderConfiguration, Codable
  • The RSDRegExValidatorObject is a concrete implementation of the RSDCodableRegExMatchValidator that can be used to create a regex validation of an input string using a regex pattern.

    See more

    Declaration

    Swift

    public struct RSDRegExValidatorObject : RSDCodableRegExMatchValidator
  • RSDResourceType is an extendable struct for describing the type of a resource. By default, these values will map to the file extension.

    See more

    Declaration

    Swift

    public struct RSDResourceType : RawRepresentable, Equatable, Hashable, Codable
  • RSDResultObject is a concrete implementation of the base result associated with a task, step, or asynchronous action.

    See more

    Declaration

    Swift

    public struct RSDResultObject : RSDNavigationResult, Codable
  • RSDResultType is an extendable string enum used by RSDFactory to create the appropriate result type.

    See more

    Declaration

    Swift

    public struct RSDResultType : RSDFactoryTypeRepresentable, Codable, Hashable
  • Default implementation for building a task scoring.

    See more

    Declaration

    Swift

    public struct RSDDefaultScoreBuilder : RSDScoreBuilder
  • The type of the step. This is used to decode the step using a RSDFactory. It can also be used to customize the UI.

    See more

    Declaration

    Swift

    public struct RSDStepNavigatorType : RSDFactoryTypeRepresentable, Codable, Hashable
  • RSDStepTransformerObject is used in decoding a step with replacement properties for some or all of the steps in a section that is defined using a different resource. The factory will convert this step into an appropriate RSDSectionStep from the decoded object.

    See more

    Declaration

    Swift

    public struct RSDStepTransformerObject : RSDStepTransformer, Decodable
  • The type of the step. This is used to decode the step using a RSDFactory. It can also be used to customize the UI.

    See more

    Declaration

    Swift

    public struct RSDStepType : RSDFactoryTypeRepresentable, Codable, Hashable
  • The metadata for a task result archive that can be zipped using the app developer’s choice of third-party archival tools.

    See more

    Declaration

    Swift

    public struct RSDTaskMetadata : Codable
  • RSDTaskResultObject is a result associated with a task. This object includes a step history, task run UUID, schema identifier, and asynchronous results.

    See more

    Declaration

    Swift

    public struct RSDTaskResultObject : RSDTaskRunResult, Codable
  • The type of the ui action. This is used to decode a RSDUIAction using a RSDFactory. It can also be used to customize the UI.

    See more

    Declaration

    Swift

    public struct RSDUIActionObjectType : RSDFactoryTypeRepresentable, Codable, Hashable
  • The type of transition style to use for displaying a UI component.

    See more

    Declaration

    Swift

    public struct RSDTransitionStyle : RawRepresentable, Codable, Hashable
  • RSDUnitConverter is a static struct for defined unit converters for converting between US English (imperial) to metric units. This is used to allow for displaying a person’s height or weight in imperial units, while storing the value in standardized metric units.

    See more

    Declaration

    Swift

    public struct RSDUnitConverter
  • A weekly schedule item is a light-weight codable struct that can be used to store and track events that happen at regularily scheduled intervals. This schedule assumes a ISO8601 7-day calendar.

    • example: Codable protocol schema. let json = """ { "daysOfWeek": [1, 3, 5], "timeOfDay": "08:00" } """.data(using: .utf8)! // our data in native (JSON) format
    See more

    Declaration

    Swift

    public struct RSDWeeklyScheduleObject : Codable, RSDSchedule