Structures

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

RSDTaskGroupObject is a concrete implementation of the RSDTaskGroup protocol.

RSDErrorResult is a result that holds information about an error.

RSDTextFieldOptionsObject defines the options for a text field.

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.

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.

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

RSDResourceTransformerObject is a concrete implementation of a codable resource transformer. The transformer can be used to create an object decoded from an embedded resource.

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

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.

RSDColorThemeElementObject 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.

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

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

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.

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.

RSDSkipToUIActionObject implements an action that includes an identifier for a step to skip to if this action is called. This is used by the RSDConditionalStepNavigator to navigate based on a nil result.

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. The resource bundle is assumed to be the main bundle if the bundleIdentifier property is nil.

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

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.

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

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.

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

RSDConditionalStepNavigatorObject is a concrete implementation of the RSDConditionalStepNavigator protocol.

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.

RSDTaskInfoStepObject is a concrete implementation of the RSDTaskInfoStep protocol.

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.

RSDSchemaInfoObject is a concrete implementation of the RSDSchemaInfo protocol.

Undocumented

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

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

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

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.

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

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

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

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.

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

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

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

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.

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

Undocumented

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 Gregorian 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.

RSDTransformerStepObject 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.