Protocols

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.

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

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.

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

RSDAsyncActionDelegate is the delegate protocol for RSDAsyncAction.

A controller for an async action configuration.

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.

An authorization adapter is a class that can manage requesting authorization for a given permission.

A background task is an extension of a task that can run a task without visual steps. This is intended for use in an active task where the user may need to set down their phone or put it in their pocket but still have the steps continue to transition if the screen has been locked or the phone has gone to sleep.

Custom audio session controller.

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

A data source for selecting a date.

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.

A picker data source for picking a number.

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

A picker data source for selecting choices.

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

Extend the choice options protocol to allow setting a default value.

A cohort navigation step is a step that carries information about navigation rules to apply either before or after displaying this step based on the currently applied cohorts.

RSDCohortAssignmentStep evaluates a task result and returns the cohorts to apply for a given result.

A cohort navigation rule is used by the RSDCohortTrackingRule to determine whether to skip a step, and if so where to skip to, based on the currently applied cohorts.

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

A color mapping holds a reference to a given index within a set of color tiles.

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.

Extension of the RSDOrderedStepNavigator to implement a shared navigation.

Protocol to describe a task that should be copied for each run of the task rather than simply passed. This is used to allow an architecture where the task model uses a pointer to an in-memory object that is used during navigation.

A light-weight protocol for copying objects with a new identifier.

A data archive is a class object that can be used to add multiple files to a zipped archive for upload as a package. The data archive could also be a service that implements the logic for uploading results where the results are sent individually. It is the responsibility of the developer who implements this protocol for their services to ensure that the data is cached (if offline) and to re-attempt upload of the encrypted results.

An archivable result is an object wrapper for results that allows them to be transformed into data for a zipped archive or service.

The data archive manager controls vending a new archive (as appropriate) and handling state. It is a composite protocol of the methods defined using Swift, which are required but can include Swift objects and methods that conform to Objective-C protocols which allows for optional implementation of the included methods.

The data storage manager controls storing of user data that is stored across task runs. It is a composite protocol of the methods defined using Swift, which are required but can include Swift objects and methods that conform to Objective-C protocols which allows for optional implementation of the included methods.

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.

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.

A light-weight protocol for replacing the mutable properties on a class with values from a decoder.

A special-case encodable that can be encoded to a comma-delimited string.

A csv-formatted file is a smaller format that might be suitable for saving data to a file that will be parsed into a table, but the elements must all conform to single value container encoding and they may not include any strings in the encoded value.

A task that implements this module is expected to include a pointer to the design system UI/UX rules to use that are specific to the tasks within this module.

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

RSDStringEnumSet is a protocol for defining the set of all string values included in an enum.

RSDIntEnumSet is a protocol for defining the set of all int values included in an enum.

RSDErrorResult is a result that holds information about an error.

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.

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

RSDFormUIStep implements additional properties used in creating a form input.

The image picker step protocol implements a step that is

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.

An image stored in an asset catalog.

RSDImageVendor is a protocol for defining an abstract method for fetching an image.

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.

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

RSDPopoverInputField wraps the input field in a form step. This allows the data source used to display the input field to show a form step in a modal view controller.

RSDDetailInputField is an input field that can be presented as a step using the given transition style.

Extend the input field to a mutable type.

Extend the input field to allow copying the field with a new identifier.

This is a custom type of UI step that is used to show instructions, permissions, and/or a countdown for a task.

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

Casting for any a JSON type object. Elements may be any one of the JSON types (NSNull, NSNumber, String, Array, Dictionary).

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.

RSDModalStepDataSource extends RSDTableDataSource for a data source that includes entering information using a modal step.

A result that can be used to track a custom navigation as a result of user action.

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.

RSDNavigationUIAction implements an extension of the base protocol where the action includes an identifier for a step to navigate to if this action is called. This is used by the RSDConditionalStepNavigator to navigate based on the presence of a result with the given resultIdentifier.

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

RSDOverviewStep extends the RSDUIStep to include general overview information about an activity including what permissions are required by this task. Without these preconditions, the task cannot measure or collect the data needed for this task.

A path component holds state for navigating and displaying a task with a UX that is appropriate to a given platform.

A node path component always has an associated step, which the step navigator can use to recover the step path.

A step view path component is used to present a step.

A history path component defines a method for returning the previous result from a step.

A task path component is a navigational path component that, depending upon the UI/UX, may not have an associated view controller.

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.

An RSDPermission can carry additional information about the permission

A model object that defines a configuration for permissions to be requested either as a part of a step or an async action.

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

Extends RSDRecorderConfiguration for a recorder that might be restarted.

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

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

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

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

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

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 Encodable protocol to allow the app to store and upload results in a standardized way.

A result summary step is used to display a result that is calculated or measured earlier in the task.

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.

A protocol that can be used to define the keys and header to use in a string-separated file.

The RSDSchedule protocol can be used to describe a local notification schedule. This provides a shared interface for getting and setting the time of day and for setting up notifications.

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.

An RSDScoringResult is an archivable result that can also save a json data scoring object for display in a user’s history or to influence future results.

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.

RSDPermissionsStep extends the RSDUIStep to include information about an activity including what permissions are required by this step or task. Without these preconditions, the task cannot measure or collect the data needed for this task.

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.

RSDCopyStep is a step that supports creating a copy of itself that has specified properties mutated to return a new instance and/or includes mutated properties.

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

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

RSDStepNavigator is used by the RSDTaskController to determine the order of presentation of the steps in a task. The navigator should include navigation that is based on the input model and the results rather that depending upon the available real estate.

An extension of the step navigator to allow inserting a section into the work-flow of this step navigator.

When using a step navigator that was developed by a third-party, it can be desirable to insert into that task flow steps related to the timing of the task. For example, a tapping task may also include asking about medication or a 12 minute run may prompt a clinic participant to put on their Fitbit before running. These additional questions or instructions need to be inserted into the task flow at a logical point after showing one or more initial screens.

RSDStepTransformer is used in decoding a step with replacement properties for some or all of the properties that is defined using a different resource.

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

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

RSDSubtaskStep is a step that contains a task reference.

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.

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.

Delegate for the data source.

RSDTableDataSource is the model for a table view controller. It provides the UITableViewDataSource, manages and stores answers provided through 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 view controller.

The tableView data source is comprised of 2 objects:

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

2. RSDTableItem: An object representing a specific table cell. There will be one RSDTableItem for each indexPath in the tableView.

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

RSDTableStep is a UI step that can be displayed using a UITableView.

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.

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 a base-level implementation for running a task. This object is expected to be an appropriate instance of a view controller, depending upon the operating system.

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

A compact object for storing information about a task run that can be used by a task to influence subsequent task runs.

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.

RSDTaskInfo includes information to display about a task before the task is fetched. This can be used to display a collection of tasks and only load the task when selected by the participant.

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.

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.

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

The RSDTaskRunResult is a task result where the task run UUID can be set to allow for nested results that all use the same run UUID.

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.

RSDTextFieldOptions defines the options for a text field.

A tracking rule is used to track changes that are applied during a task that should be saved at the end of the the overall task. By definition, these rules can mutate and should be handled using pointers rather than using structs.

The tracking task protocol is intended for tasks that use scoring data from a previous task run to inform subsequent runs of the same task by a given participant. RSDTaskViewModel will check a task for conformance to this method when the view model is initialized.

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

RSDUIActionHandler implements the custom actions of the step.

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

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.

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

RSDVideoViewUIAction implements an extension of the base protocol where the action includes a pointer to a url that can display a video in an AVPlayerViewController. 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.

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

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.

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