Structures

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

Wrapper for any codable array.

Wrapper for any codable dictionary.

RSDActiveUIStepCommand is an OptionSet for certain commonly used commands that are used at the beginning and end of an active step.

RSDAnswerResultObject is a concrete implementation of a result that can be described using a single value.

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.

The type of the async action configuration. This is used to decode async action configurations using an instance of RSDFactory.

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.

A simple struct that can be used to implement the RSDChoiceOptions protocol.

Concrete implementation of the RSDCohortNavigationRule.

RSDCollectionResultObject is used include multiple results associated with a single step or async action that may have more that one result.

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.

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.

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.

A color library is a versioned collection of color swatches.

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.

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.

A color swatch refers to a series of color tiles within the same family.

A special-case color swatch for gray scale components.

A color tile is a single color and whether or not that color uses light style.

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.

RSDConditionalStepNavigatorObject is a concrete implementation of the RSDConditionalStepNavigator protocol.

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.

A simple struct that can be used to implement the RSDDatePickerDataSource protocol.

RSDDateRangeObject is a concrete implementation of a RSDDateRange that defines the range of values appropriate for a date data type.

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.

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

RSDDurationPickerDataSourceObject is a concrete implementation of a RSDMultipleComponentChoiceOptions that can be used to select a duration using duration units for each component of the duration.

RSDDurationRangeObject extends the properties of an RSDInputField for a .duration data type.

RSDErrorResult is a result that holds information about an error.

A manifest for a given file that includes the filename, content type, and creation timestamp.

RSDFileResultObject is a concrete implementation of a result that holds a pointer to a file url.

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.

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.

The icon info is a simple image holder that also contains a title and subtitle for the image.

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.

A concrete implementation for a RSDImagePickerStep.

A hint as to where the UI should place an image.

The type of the image theme. This is used to decode a RSDImageThemeElement using a RSDFactory. It can also be used to customize the UI.

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.

RSDFetchableImageThemeElementObject is a Codable concrete implementation of RSDFetchableImageThemeElement.

RSDAnimatedImageThemeElementObject is a Codable concrete implementation of RSDAnimatedImageThemeElement.

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

A simple struct that can be used to implement the RSDMultipleComponentOptions protocol.

A simple struct that can be used to implement the RSDNumberPickerDataSource protocol.

RSDNumberRangeObject extends the properties of an RSDInputField for a decimal or integer data type.

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.

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

RSDResultObject is a concrete implementation of the base result associated with a task, step, or asynchronous action.

RSDResultType is an extendable string enum used by RSDFactory to create the appropriate result type.

RSDRecordMarker is a concrete implementation of RSDSampleRecord that can be used to mark the step transitions for a recording.

Implementation of the RSDStringSeparatedEncodingFormat protocol that wraps a comma separated encodable.

RSDSchemaInfoObject is a concrete implementation of the RSDSchemaInfo protocol.

Default implementation for building a task scoring.

RSDSectionStepObject is used to define a logical subgrouping of steps such as a section in a longer survey or an active step that includes an instruction step, countdown step, and activity step.

RSDStandardAsyncActionConfiguration is a concrete implementation of RSDRecorderConfiguration that can be used to decode an async configuration for a recorder.

The type of the step. This is used to decode the step using a RSDFactory. It can also be used to customize the UI.

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.

The type of the step. This is used to decode the step using a RSDFactory. It can also be used to customize the UI.

RSDTaskGroupObject is a concrete implementation of the RSDTaskGroup protocol.

RSDTaskInfoStepObject is a concrete implementation of the RSDTaskInfoStep protocol.

The metadata for a task result archive that can be zipped using the app developer’s choice of third-party archival tools.

RSDTaskResultObject is a result associated with a task. This object includes a step history, task run UUID, schema identifier, and asynchronous results.

RSDTextFieldOptionsObject defines the options for a text field.

RSDUIActionObject is a concrete implementation of RSDUIAction that can be used to customize the title and image displayed for a given action of the UI.

RSDNavigationUIActionObject implements an action for navigating to another step in a task.

RSDReminderUIActionObject implements an action for setting up a local notification to remind the participant about doing a particular task later.

RSDWebViewUIActionObject implements an action that includes a pointer to a url that can display in a webview. The url can either be fully qualified or optionally point to an embedded resource.

RSDVideoViewUIActionObject implements an action that includes a pointer to a url that can display in a AVPlayerViewController. The url can either be fully qualified or optionally point to an embedded resource.

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.

The type of transition style to use for displaying a UI component.

RSDUSHeightPickerDataSourceObject is a custom height picker for use when the Locale uses US Customary units (not metric system).

RSDUSInfantMassPickerDataSource is a custom weight picker for use when the Locale uses US Customary units (not metric system) and the mass is for an infant in lb, oz.

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.

RSDViewThemeElementObject tells the UI where to find the view controller to use when instantiating the RSDStepController.

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