Classes
The following classes are available globally.
-
See moreRSDTaskObject
is the interface for running a task. It includes information about how to calculate progress, validation, and the order of display for the steps.Declaration
Swift
public class RSDTaskObject : RSDUIActionHandlerObject, RSDTask, Decodable
-
See moreRSDChoiceInputFieldObject
is a concrete implementation ofRSDChoiceInputField
that subclassesRSDInputFieldObject
to include a list of choices for a multiple choice or single choice input field.Declaration
Swift
open class RSDChoiceInputFieldObject : RSDInputFieldObject, RSDChoiceInputField
-
See moreRSDUIStepObject
is the base class implementation for all UI display steps defined in this framework. 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 aRSDSectionStep
.Declaration
Swift
open class RSDUIStepObject : RSDUIActionHandlerObject, RSDThemedUIStep, RSDNavigationRule, Decodable, RSDMutableStep
-
See moreRSDInputFieldTableItemGroup
is used to represent a single input field.Declaration
Swift
open class RSDInputFieldTableItemGroup : RSDTableItemGroup
-
See moreRSDActiveUIStepObject
extends theRSDUIStepObject
to include a duration and commands. This is used for the case where anRSDUIStep
has an action such asstart walking
orstop walking
; the step may also implement theRSDActiveUIStep
protocol to allow for spoken instruction.Declaration
Swift
open class RSDActiveUIStepObject : RSDUIStepObject, RSDActiveUIStep
-
See moreRSDTableItem
can be used to represent the type of the row to display.Declaration
Swift
open class RSDTableItem
-
See moreRSDTextTableItem
is used to represent a item row that has static text.Declaration
Swift
public final class RSDTextTableItem : RSDTableItem
-
See moreRSDImageTableItem
is used to represent a item row that has a static image.Declaration
Swift
public final class RSDImageTableItem : RSDTableItem
-
See moreRSDInputFieldTableItem
is an abstract base class implementation for representing an answer, or part of an answer for a givenRSDInputField
.Declaration
Swift
open class RSDInputFieldTableItem : RSDTableItem
-
See moreRSDMultipleComponentInputFieldObject
extends the properties ofRSDInputFieldObject
with information required to create a multiple component input field.Declaration
Swift
open class RSDMultipleComponentInputFieldObject : RSDInputFieldObject, RSDMultipleComponentInputField
-
RSDTaskPath
is used to keep track of the current state of a running task.Seealso
RSDTaskController
Declaration
Swift
public final class RSDTaskPath : NSObject, NSCopying
-
See moreRSDTableItemGroup
is a generic table item group object that can be used to display information in a tableview that does not have an associated input field.Declaration
Swift
open class RSDTableItemGroup
-
See moreRSDChoiceTableItem
is used to represent a single row in a table where the user picks from a list of choices.Declaration
Swift
open class RSDChoiceTableItem : RSDInputFieldTableItem
-
RSDDataLogger
is used to write data samples using a custom encoding to a logging file.Note
This class does not use a serial queue to process the samples. It is assumed that the recorder that is using this file will handle that implementation.Declaration
Swift
open class RSDDataLogger
-
See moreRSDFileResultUtility
is a utility for naming temporary files used to save task results.Declaration
Swift
public class RSDFileResultUtility
-
See moreRSDTextInputTableItem
is used to represent a single row in a table that holds a text entry input field. Typically, this would be used to represent a singleRSDInputField
value, but it can also be used to represent a single component in a multiple-component field.Declaration
Swift
open class RSDTextInputTableItem : RSDInputFieldTableItem
-
See moreRSDFormUIStepObject
is a concrete implementation of theRSDFormUIStep
andRSDSurveyNavigationStep
protocols. It is a subclass ofRSDUIStepObject
and can be used to display a navigable survey.Declaration
Swift
open class RSDFormUIStepObject : RSDUIStepObject, RSDFormUIStep, RSDSurveyNavigationStep
-
See moreRSDFactory
handles customization of decoding the elements of a task. Applications should override this factory to add custom elements required to run their task modules.Declaration
Swift
open class RSDFactory
-
Defines a section in a table. A table is made up of sections, groups and items. For most group types, there is one cell per group. The exception would be where the ui hint is for a list where each value is displayed in a selectable list.
See moreDeclaration
Swift
open class RSDTableSection
-
RSDSampleRecorder
is a base-class implementation of a controller that is used to record samples.While it isn’t prohibited to instatiate this class directly, this is intended as an abstract implementation for recording sample data from GPS location, accelerometers, etc.
Using this base implementation allows for a consistent logging of shared sample data key words for the step path and the uptime. It implements the logic for writing to a file, tracking the uptime and start date, and provides a consistent implementation for error handling.
See moreDeclaration
Swift
open class RSDSampleRecorder : NSObject, RSDAsyncActionController
-
See moreRSDRecordSampleLogger
is used to write samples encoded as json dictionary objects to a logging file.Declaration
Swift
public class RSDRecordSampleLogger : RSDDataLogger
-
See moreRSDFormStepDataSourceObject
is a concrete implementation of theRSDFormStepDataSource
protocol.Declaration
Swift
open class RSDFormStepDataSourceObject : RSDFormStepDataSource
-
See moreRSDChoicePickerTableItemGroup
subclassesRSDInputFieldTableItemGroup
to implement a single or multiple choice question where the choices are presented as a list.Declaration
Swift
open class RSDChoicePickerTableItemGroup : RSDInputFieldTableItemGroup
-
See moreRSDResourceConfig
is designed as an overridable resource configuration manager. The functions and properties are intended to be overridable in the app by implementing a custom extension of the function with the same name. This is designed to use app-wins namespace conflict resolution that is typical of obj-c architecture.Declaration
Swift
open class RSDResourceConfig : NSObject
-
See moreRSDUIActionHandlerObject
is intended as an abstract implementation of the action handler that implements theCodable
protocol.Declaration
Swift
open class RSDUIActionHandlerObject : RSDUIActionHandler
-
See moreLocalizationBundle
is a wrapper for returning a bundle along with a table name and target suffixes. This is used by theLocalization
class to return localized strings that are defined in a strings file embedded in the given bundle.Declaration
Swift
open class LocalizationBundle
-
See moreLocalization
is a wrapper class for getting a localized string that allows overriding the bundles to search for a given string. To use this class, call one of the localization methods. To override the value returned by one of the bundles, add the string to a bundle higher up in the list order of theallBundles
property.Declaration
Swift
open class Localization: NSObject
-
An item group for entering data that is a human-measurement in localized units appropriate to the size-range of a human (adult, child, infant).
See moreDeclaration
Swift
open class RSDHumanMeasurementTableItemGroup : RSDInputFieldTableItemGroup
-
See moreRSDInputFieldObject
is aDecodable
implementation of theRSDSurveyInputField
protocol. This is implemented as an open class so that the decoding strategy can be used to support subclasses.Declaration
Swift
open class RSDInputFieldObject : RSDSurveyInputField, Codable