Protocols

RSDSurveyNavigationStep evaluates RSDSurveyRule objects that are associated with each input field to determine if the step navigation should skip to another step.

RSDSurveyInputField extends the RSDInputField protocol to also support an array of RSDSurveyRule objects. These rules are evaluated on the RSDAnswerResult given for this input field and if they evaluate to true then they are used to return the next identifier.

Delegate for the data source.

RSDFormStepDataSource: the internal model for a table view controller. It provides the UITableViewDataSource, manages and stores answers provided thru user input, and provides an RSDResult with those answers upon request.

It also provides several convenience methods for saving or selecting answers, checking if all answers are valid, and retrieving specific model objects that may be needed by the ViewController.

The tableView data source is comprised of 3 objects:

1. RSDTableSection: An object representing a section in the tableView. It has one or more RSDTableItemGroup objects.

2. RSDTableItemGroup: An object representing a specific question supplied by RSDStep as an input field. Upon init(), the ItemGroup will create one or more RSDTableItem objects representing the answer options for the RSDInputField. The ItemGroup is responsible for storing/computing the answers for its RSDInputField.

3. RSDTableItem: An object representing a specific answer option from the ItemGroup (RSDInputField), such as a Yes or No choice in a boolean question or a string or number that’s entered thru a text field. There will be one TableItem for each indexPath in the tableView.

RSDTaskControllerDelegate is responsible for processing the results of the task, providing some input into how the controller behaves, and providing additional content as needed. It’s primary purpose is to handle processing the results of running the task.

RSDTaskController handles default implementations for running a task.

To start a task, create an instance of a view controller that conforms to this protocol and set either the topLevelTask or the topLevelTaskInfo.

RSDSchemaInfo is a lightweight interface for schema information used to upload the results of a task. The schema info is intended to allow for reproducing a previously presented survey where the survey may have changed and requires revisioning to know what version of the survey task was run.

RSDEmbeddedIconVendor is a convenience protocol for fetching an codable image using an optional RSDImageWrapper. This protocol implements an extension method to fetch the icon.

The RSDImageWrapperDelegate is a singleton delegate that can be used to customize the rules for fetching an image using the RSDImageWrapper. If defined and attached to the RSDImageWrapper using the static property sharedDelegate then the image wrapper will ask the delegate for the appropriate image.

RSDPickerDataSource includes information that can be used to build a picker UI element.

A data source for selecting a date.

A picker data source for selecting choices.

A picker data source for picking a number.

Undocumented

RSDMultipleComponentOptions is a data source protocol that can be used to set up a picker.

RSDMultipleComponentOptions is a data source protocol that can be used to set up a picker.

RSDChoiceOptions is a data source protocol that can be used to set up a picker or list of choices.

RSDTextFieldOptions defines the options for a text field.

Undocumented

Undocumented

Undocumented

RSDSectionStepTransformer is a lightweight protocol for vending the steps in a section. This object is used to allow accessing an RSDSectionStep for use in multiple tasks or multiple times within a task.

For example, for a task where the user is going to run for 12 minutes, the researchers may wish to record the user’s heart rate both before and after the run. The heart rate can be defined in a seperate file or model object and the transformer is used as a placeholder that can fetch and replace itself with a section of steps that are used to capture the user’s heartrate.

RSDSectionStepResourceTransformer is an implementation of a RSDSectionStepTransformer that uses a RSDResourceTransformer to support transforming the section from one resource for inclusion in another task defined using a different resource.

RSDStringLiteralOptionSet extends OptionSet to allow mapping any OptionSet that uses a BinaryInteger as its RawValue to a set of string keys.

RSDTaskTransformer The task transformer is a lightweight protocol for vending a task. This can be used by an RSDTaskInfoStep to fetch a task or depending upon the design of the application, it could be used to fetch a task that is loaded from a table or collection view before presenting the task.

RSDTaskResourceTransformer is an implementation of a RSDTaskTransformer that uses a RSDResourceTransformer to support transforming a resource either using an online URL or an embedded file.

RSDPermissionType is a generic configuration object with information about a given permission. The permission type can be used by the app to handle gracefully requesting authorization from the user for access to sensors and hardware required by the app.

RSDAsyncActionConfiguration defines general configuration for an asynchronous background action that should be run in the background. Depending upon the parameters and how the action is set up, this could be something that is run continuously or else is paused or reset based on a timeout interval.

The configuration is intended to be a serializable object and does not call services, record data, or anything else. It does include a step identifier that can be used to let the RSDTaskController know when to trigger the async action.

RSDAsyncActionControllerVendor is an extension of the configuration protocol for configurations that know how to vend a new controller.

RSDRecorderConfiguration is used to configure a recorder. For example, recording accelerometer data or video.

RSDJSONRecorderConfigureation is used to configure a recorder to record JSON samples.

RSDRequestConfiguration is used to start an asynchronous service such as a url request or fetching from core data.

RSDAsyncActionControllerDelegate is the delegate protocol for RSDAsyncActionController.

A controller for an async action configuration.

RSDEmbeddedResourceUIAction is a convenience protocol for returning an image using an encodable strings for the name and bundle identifier.

Undocumented

RSDTaskInfoStep is a reference interface for information about the task. This includes information that can be displayed in a table or collection view before starting the task as well as information that is displayed while the task is being fetched in the case where the task is not fetched using an embedded resource or via a hardcoded task.

RSDStepController handles default implementations for running a step in a task.

RSDDateRange defines the range of values appropriate for a date data type.

RSDRange defines range constraints that are appropriate for a given data type.

RSDRangeWithFormatter is an optional extension of the range that can be used to extend the range to include a formatter appropriate to the UI. For example, this could be used to describe a number range that displays currency.

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

Define the navigation rule as a protocol to allow for protocol-oriented extension (multiple inheritance). Currently defined usage is to allow the RSDConditionalStepNavigator to check if a step has a navigation rule and apply as necessary.

A navigation skip rule applies to this step to allow the step to be skipped.

A navigation back rule applies to this step to block backward navigation.

A conditional rule is appended to the navigable task to check a secondary source for whether or not the step should be displayed.

Implementation of a step navigator that will apply conditions and navigation based on the steps, navigation rules, and conditional rules associated with this navigator.

RSDUSMeasurementPickerDataSource is a generic protocol for converting US Customary units (multiple component) to metric units.

The RSDUIAction protocol can be used to customize the title and image displayed for a given action of the UI.

RSDWebViewUIAction implements an extension of the base protocol where the action 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.

RSDSkipToUIAction implements an extension of the base protocol where the action 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.

RSDUIActionHandler implements the custom actions of the step.

RSDResult is the base implementation for a result associated with a task, step, or asynchronous action.

When running a task, there will be a result of some variety used to mark each step in the task. This is the base protocol. All the RSDResult objects are required to conform to the Codable protocol to allow the app to store and upload results in a standardized way.

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

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

RSDFileResult is a result that holds a pointer to a file url.

RSDErrorResult is a result that holds information about an error.

RSDAnswerResultFinder is a convenience protocol used to retrieve an answer result. It is used in survey navigation to find the result for a given input field.

RSDAnswerResult is a result that can be described using a single value.

RSDTask is the interface for running a task. It includes information about how to calculate progress, validation, and the order of display for the steps.

RSDTaskDataSource is a data source that can be used by the factory to get info that should be included with a task result or used to display subgroups of a task.

JSONDecoder and PropertyListDecoder do not share a common protocol so extend them to be able to create the appropriate decoder and set the userInfo keys as needed.

JSONEncoder and PropertyListEncoder do not share a common protocol so extend them to be able to create the appropriate decoder and set the userInfo keys as needed.

RSDTaskGroup defines a subgrouping of tasks. This is used in UI presentations where the researchers wish to tie a group of activities and surveys together but allow the user to perform them non-sequentially or with a break between the activities.

Light-weight protocol for handling generic equality without requiring a class or struct to implement all of the NSObjectProtocol.

The RSDSampleRecord defines the properties that are included with all JSON logging samples. By defining a protocol, the logger can include markers for step transitions and the records are defined as Codable but the actual CodingKey implementation can be changed to match the requirements of the research study.

RSDSurveyRule defines an evaluation rule and returns a step identifier if appropriate.

RSDComparableSurveyRule is a survey rule that matches an expected result to the answer and vends a skip identifier if the match is evaluated to true.

RSDComparable can be used to compare a stored result to a matching value.

RSDDecimalComparable can be used to compare a stored result to a matching value where the values are decimals.

RSDInputField is used to describe a form input and includes the data type and a possible hint to how the UI should be displayed. The ResearchSuite framework uses RSDFormUIStep to represent questions to ask the user. Each question must have at least one associated input field. An input field is validated when its owning step is validated.

RSDChoice is used to describe a choice item for use with a multiple choice or multiple component input field.

RSDChoiceInputField extends the properties of RSDInputField with information required to create a multiple or single choice question.

RSDMultipleComponentInputField extends the properties of RSDInputField with information required to create a multiple component input field.

RSDStep is the base protocol for the steps that can compose a task for presentation using a controller appropriate to the device and application. Each RSDStep object represents one logical piece of data entry, information, or activity in a larger task.

Implementations included in this SDK include:

1. RSDGenericStep is used by RSDFactory to create a step that does not include a recognized subtype.
2. RSDSectionStep is used to define a logical subgroup of steps.
3. RSDUIStep is used to define a display step.
4. RSDTaskInfoStep is used to combine tasks into a single flow. For example, if the researcher wishes to ask for survey responses before an activity.

A step can be a question, an active test, or a simple instruction. An RSDStep subclass is usually paired with an RSDStepController that controls the actions of the step.

RSDGenericStep is a step with key/value pairs decoded from a dictionary. This is the default step returned by RSDFactory for an unrecoginized type.

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

RSDUIStep is used to define a single display unit. Depending upon the available real-estate, more than one ui step may be displayed at a time. For example, on an iPad, you may choose to group a set of questions using a RSDSectionStep.

RSDMutableStep is a step that supports copying information from a dictionary into this step. Because this step can be mutated, it must be implemented as a class.

RSDThemedUIStep is a UI step that supports theme customization of the color and/or images used.

RSDFormUIStep implements additional properties used in creating a form input.

RSDActiveUIStep extends the RSDUIStep to include a duration and commands. This is used for the case where an RSDUIStep has an action such as start walking or stop walking; the step may also implement the RSDActiveUIStep protocol to allow for spoken instruction.

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

RSDResourceTransformer is a protocol for getting either embedded resources or online resources.

RSDStepNavigator is the model object used by the RSDTaskController to determine the order of presentation of the steps in a task.

RSDJSONNumber implements converting a Swift number to an Objective-C NSNumber.

Undocumented

RSDUIThemeElement is used to tell the application UI view controllers how to style a given step.

RSDDecodableBundleInfo is a convenience protocol for getting a bundle from a bundle identifier.

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

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

RSDImageThemeElement extends the UI step to include an image.

RSDFetchableImageThemeElement defines an image that can be fetched asynchronously.

RSDAnimatedImageThemeElement defines a series of images that can be animated.

RSDStepValidator is a convenience protocol for validating the steps in a list as unique.

RSDDateCoder is used to handle specifying date encoding/decoding. If the calendar components supported by this formatter only include a subset of all the components then only those components should be displayed in the UI.

Protocol for converting an object to a dictionary representation. This is included for reverse-compatiblility to older implementations that are not Swift 4 Codable and instead use a dictionary representation.

Protocol for converting objects to JSON serializable objects