Enumerations

The following enumerations are available globally.

  • List of the rules to apply when navigating based on the currently applied cohorts.

    See more

    Declaration

    Swift

    public enum RSDCohortRuleOperator : String, Codable
  • An enum for part of the view to which a given color style should be applied.

    See more

    Declaration

    Swift

    public enum RSDColorPlacement : String, Codable
  • A listing of the color names that are already assigned by the base framework using ColorMatrix.json as the source file.

    See more

    Declaration

    Swift

    public enum RSDReservedColorName : RawRepresentable, Equatable, Hashable, Codable
  • A list of reserved filenames for data added to an archive that is keyed to a custom-built data file.

    See more

    Declaration

    Swift

    public enum RSDReservedFilename : String
  • RSDFormDataType is used to describe the data type for a form input. This is different from the RSDAnswerResultType which is a struct that can be used to encode and decode the input field answer value. This describes the type of information required by the input field.

    See more

    Declaration

    Swift

    public enum RSDFormDataType
  • The frequency type can be used to indicate the frequency with which to do something within the app.

    See more

    Declaration

    Swift

    public enum RSDFrequencyType : String, CaseIterable
  • What source should be used for the image selection?

    Note

    The app is required to include the appropriate permission strings in its Info.plist file.
    See more

    Declaration

    Swift

    public enum RSDImagePickerSourceType : String, Codable
  • The capture mode sets whether to capture video or a photo.

    Declaration

    Swift

    public enum RSDImagePickerMediaType : String, Codable
  • RSDInputFieldError is used by the RSDFormStepDataSource when validating a user-entered answer for a given input field.

    Seealso

    RSDInputField and RSDFormStepDataSource
    See more

    Declaration

    Swift

    public enum RSDInputFieldError : Error
  • RSDMotionRecorderType is used to enumerate the sensors and calculated measurements that can be recorded by the RSDMotionRecorder.

    RSDMotionRecorder records each sample from either the raw CoreMotion sensors (accelerometer, gyro, and magnetometer) or the calculated vectors returned when requesting CMDeviceMotion data updates. The CMDeviceMotion data is split into the components enumerated by this enum into a single vector (sensor or calculated) per type.

    By default, the requested types are are saved to a single logging file as instances of RSDMotionRecord structs.

    Spliting the device motion into components in this manner stores the data in using a consistent JSON schema that can represent the sensor data returned by both iOS and Android devices. Thus, allowing research studies to target a broader audience. Additionally, this schema allows for a single table to be used to store the data which can then be filtered by type to perform calculations and DSP on the input sources.

    See more

    Declaration

    Swift

    public enum RSDMotionRecorderType : String, Codable, RSDStringEnumSet
  • RSDResourceTransformerError is used to support throwing errors when attempting to transform a resource.

    See more

    Declaration

    Swift

    public enum RSDResourceTransformerError : Error, CustomNSError
  • Standard permission types.

    Note

    This framework intentionally does not include any direct reference to Health Kit. First, including Health Kit in applications that do not use that SDK makes it confusing and difficult for researchers to set up the app. Second, the goal of this framework is to include a model that is platform-agnostic and can be used independently of the device. (syoung 11/1/7/2017)
    See more

    Declaration

    Swift

    public enum RSDStandardPermissionType : String, RSDPermissionType, Codable, CaseIterable
  • RSDPermissionError errors are thrown when a task, step, or async action does not have a permission that is required to run the action.

    See more

    Declaration

    Swift

    public enum RSDPermissionError : Error
  • The direction of navigation for the steps.

    See more

    Declaration

    Swift

    public enum RSDStepDirection : Int, Codable
  • The possible errors thrown when fetching a task.

    See more

    Declaration

    Swift

    public enum RSDTaskFetchError : Error
  • Codable enum for the auto-capitalization type for an input text field.

    • keywords: [none, words, sentences, allCharacters]

    Declaration

    Swift

    public enum RSDTextAutocapitalizationType : String, Codable, RSDStringEnumSet
  • Codable enum for the auto-capitalization type for an input text field.

    • keywords: [default, no, yes"]

    Declaration

    Swift

    public enum RSDTextAutocorrectionType : String, Codable, RSDStringEnumSet
  • Codable enum for the spell checking type for an input text field.

    • keywords: [default, no, yes"]

    Declaration

    Swift

    public enum RSDTextSpellCheckingType : String, Codable, RSDStringEnumSet
  • Codable enum for the spell checking type for an input text field.

    • keywords: [ default, asciiCapable, numbersAndPunctuation, URL, numberPad, phonePad, namePhonePad, emailAddress, decimalPad, twitter, webSearch, asciiCapableNumberPad]

    Declaration

    Swift

    public enum RSDKeyboardType : String, Codable, RSDStringEnumSet
  • The RSDUIActionType enum describes standard navigation actions that are common to a given UI step. It is extendable using the custom field.

    See more

    Declaration

    Swift

    public enum RSDUIActionType
  • RSDValidationError errors are thrown during validation of a task, step, etc. Usually this happens during the decoding of the task or when the task is first started.

    See more

    Declaration

    Swift

    public enum RSDValidationError : Error
  • The weekday enum assigns an enum value to each day of the week and implements Comparable to allow for sorting the weekdays by the order appropriate for the participant’s current Locale.

    See more

    Declaration

    Swift

    public enum RSDWeekday : Int, Codable, RSDIntEnumSet