Serialized Form (backbone 1.1.1 API)

Package org.researchstack.backbone.answerformat
- Class org.researchstack.backbone.answerformat.AnswerFormat extends java.lang.Object implements Serializable
- Class org.researchstack.backbone.answerformat.BirthDateAnswerFormat extends DateAnswerFormat implements Serializable
  - Serialized Fields
    - minAge
```
int minAge
```
    - maxAge
```
int maxAge
```
- Class org.researchstack.backbone.answerformat.BooleanAnswerFormat extends ChoiceAnswerFormat implements Serializable
- Class org.researchstack.backbone.answerformat.ChoiceAnswerFormat extends AnswerFormat implements Serializable
  - Serialized Fields
    - answerStyle
```
AnswerFormat.ChoiceAnswerStyle answerStyle
```
    - choices
```
Choice<T>[] choices
```
- Class org.researchstack.backbone.answerformat.DateAnswerFormat extends AnswerFormat implements Serializable
  - Serialized Fields
    - style
```
AnswerFormat.DateAnswerStyle style
```
    - defaultDate
```
java.util.Date defaultDate
```
    - minimumDate
```
java.util.Date minimumDate
```
    - maximumDate
```
java.util.Date maximumDate
```
- Class org.researchstack.backbone.answerformat.DecimalAnswerFormat extends AnswerFormat implements Serializable
  - Serialized Fields
    - minValue
```
float minValue
```
    - maxValue
```
float maxValue
```
- Class org.researchstack.backbone.answerformat.DurationAnswerFormat extends AnswerFormat implements Serializable
  - Serialized Fields
    - unit
```
java.lang.String unit
```
    - step
```
int step
```
- Class org.researchstack.backbone.answerformat.EmailAnswerFormat extends TextAnswerFormat implements Serializable
- Class org.researchstack.backbone.answerformat.FormAnswerFormat extends AnswerFormat implements Serializable
- Class org.researchstack.backbone.answerformat.IntegerAnswerFormat extends AnswerFormat implements Serializable
  - Serialized Fields
    - maxValue
```
int maxValue
```
    - minValue
```
int minValue
```
- Class org.researchstack.backbone.answerformat.TextAnswerFormat extends AnswerFormat implements Serializable
  - Serialized Fields
    - maximumLength
```
int maximumLength
```
    - isMultipleLines
```
boolean isMultipleLines
```
- Class org.researchstack.backbone.answerformat.UnknownAnswerFormat extends AnswerFormat implements Serializable
Package org.researchstack.backbone.model
- Class org.researchstack.backbone.model.Choice extends java.lang.Object implements Serializable
  - Serialized Fields
    - text
```
java.lang.String text
```
    - value
```
java.lang.Object value
```
    - detailText
```
java.lang.String detailText
```
- Class org.researchstack.backbone.model.ConsentDocument extends java.lang.Object implements Serializable
  - Serialized Fields
    - title
```
java.lang.String title
```
      The document's title in a localized string.
      The title appears only in the generated PDF for review; it is not used in the visual consent process.
    - sections
```
java.util.List<E> sections
```
      The sections to be in printed in the PDF file and or presented in the visual consent sequence.
      If the htmlReviewContent property is not set, this content is also used to populate the document for review in the consent review step.
      The PDF file contains all sections.
    - signaturePageTitle
```
int signaturePageTitle
```
      The title to be rendered on the signature page of the generated PDF in a localized string.
      The title is ignored for visual consent. The title is also ignored if you supply a value for the htmlReviewContent property.
    - signaturePageContent
```
java.lang.String signaturePageContent
```
      Deprecated.
      
      The content to be rendered below the title on the signature page of the generated PDF in a localized string.
      The content is ignored for visual consent. The content is also ignored if you supply a value for the htmlReviewContent property.
    - signatures
```
java.util.List<E> signatures
```
      The set of signatures that are required or prepopulated in the document.
      To add a signature to the document after consent review, the signatures array needs to be modified to incorporate the new signature content prior to PDF generation. For more information, see `[ORKConsentSignatureResult applyToDocument:]`.
    - htmlReviewContent
```
java.lang.String htmlReviewContent
```
      Override HTML content for review.
      Typically, the review content is generated from the values of the sections and signatures properties.
      When this property is set, the review content is reproduced exactly as provided in the property in the consent review step, and the sections and signatures properties are ignored.
- Class org.researchstack.backbone.model.ConsentSection extends java.lang.Object implements Serializable
  - Serialized Fields
    - type
```
ConsentSection.Type type
```
      The type of section. (read-only)
      The value of this property indicates whether a predefined image, title, and animation are present.
    - title
```
java.lang.String title
```
      The title of the consent section in a localized string.
      The title is displayed as a step title in the animated consent sequence and is also included in the PDF file, but it can be overridden by setting formalTitle.
    - formalTitle
```
java.lang.String formalTitle
```
      The formal title of the section in a localized string, for use in the legal document.
      If the value of this property is null, the value of title is used in the legal document instead.
    - summary
```
java.lang.String summary
```
      A short summary of the content in a localized string.
      The summary is displayed as description text in the animated consent sequence. The summary should be limited in length, so that the consent can be reliably displayed on smaller screens.
    - content
```
java.lang.String content
```
      The content of the section in a localized string.
      In a consent review step or in PDF file generation, the string is printed as the section's content. The string is also displayed as Learn More content in a visual consent step.
      This property is never prepopulated based on the value of type. If both content and htmlContent are non-nil, the value of the htmlContent property is used.
    - escapedContent
```
java.lang.String escapedContent
```
    - htmlContent
```
java.lang.String htmlContent
```
      The HTML content used to override the content property if additional formatting is needed. The content should be localized.
      In cases where plain text content is not sufficient to convey important details during the consent process, you can provide HTML content in this property. When you do this, the htmlContent property takes precedence over the content property.
      In a consent review step or in PDF file generation, the value of this property is printed as the section's content; in a visual consent step, the content is displayed as Learn More content.
    - customImageName
```
java.lang.String customImageName
```
      A custom illustration for the consent.
      The custom image can override the image associated with any of the predefined section types for an ConsentVisualStep object. It is ignored for a consent review step and for PDF generation.
      The image is used in template rendering mode, and is tinted using the tint color.
    - customLearnMoreButtonTitle
```
java.lang.String customLearnMoreButtonTitle
```
      A custom Learn More button title in a localized string.
      The predefined section types have localized descriptive Learn More button titles for a visual consent step. When this property is not null, it overrides that default text.
    - customAnimationURL
```
java.lang.String customAnimationURL
```
      A file URL that specifies a custom transition animation video.
      Animations of the illustration between one screen and the next are provided by default for transitions between consecutive section type codes. Custom sections and out-of-order transitions may require custom animations.
      The animation loaded from the file URL is played aspect fill in the illustration area for forward transitions only. The video is rendered in template mode, with white treated as if it were transparent.
- Class org.researchstack.backbone.model.ConsentSignature extends java.lang.Object implements Serializable
  - Serialized Fields
    - requiresName
```
boolean requiresName
```
      A Boolean value indicating whether the user needs to enter their name during consent review.
      The default value of this property is true. In a consent review step, the name entry screen is not displayed when the value of this property is false.
    - requiresSignatureImage
```
boolean requiresSignatureImage
```
      A Boolean value indicating whether the user needs to draw a signature during consent review.
      The default value of this property is true. In a consent review step, the signature entry screen is not shown when this property is false.
    - requiresBirthDate
```
boolean requiresBirthDate
```
      A Boolean value indicating whether the user needs to enter their birth date during consent review.
      The default value of this property is true. In a consent review step, the name entry screen is not displayed when the value of this property is false.
    - identifier
```
java.lang.String identifier
```
      The identifier for this signature.
      The identifier should be unique in the document. It can be used to find or replace a specific signature in an ConsentDocument object.
    - title
```
java.lang.String title
```
      The title of the signatory.
    - fullName
```
java.lang.String fullName
```
      Full name
    - signatureImage
```
java.lang.String signatureImage
```
      The base64-encoded image of the signature, if any.
    - signatureDate
```
java.lang.String signatureDate
```
      The date associated with the signature.
    - signatureDateFormatString
```
java.lang.String signatureDateFormatString
```
      The date format string to be used when producing a date string for the PDF or consent review.
      For example, @"yyyy-MM-dd 'at' HH:mm". When the value of this property is `nil`, the current date and time for the current locale is used.
Package org.researchstack.backbone.result
- Class org.researchstack.backbone.result.Result extends java.lang.Object implements Serializable
  - Serialized Fields
    - identifier
```
java.lang.String identifier
```
    - startDate
```
java.util.Date startDate
```
    - endDate
```
java.util.Date endDate
```
    - saveable
```
boolean saveable
```
- Class org.researchstack.backbone.result.StepResult extends Result implements Serializable
  - Serialized Fields
    - results
```
java.util.Map<K,V> results
```
    - answerFormat
```
AnswerFormat answerFormat
```
- Class org.researchstack.backbone.result.TaskResult extends Result implements Serializable
  - Serialized Fields
    - results
```
java.util.Map<K,V> results
```
    - uuidTask
```
java.util.UUID uuidTask
```
    - outputDirectory
```
android.net.Uri outputDirectory
```
Package org.researchstack.backbone.step
- Class org.researchstack.backbone.step.ConsentDocumentStep extends Step implements Serializable
  - Serialized Fields
    - html
```
java.lang.String html
```
    - confirmMessage
```
java.lang.String confirmMessage
```
- Class org.researchstack.backbone.step.ConsentSharingStep extends QuestionStep implements Serializable
- Class org.researchstack.backbone.step.ConsentSignatureStep extends Step implements Serializable
  - Serialized Fields
    - signatureDateFormat
```
java.lang.String signatureDateFormat
```
- Class org.researchstack.backbone.step.ConsentVisualStep extends Step implements Serializable
  - Serialized Fields
    - section
```
ConsentSection section
```
    - nextButtonString
```
java.lang.String nextButtonString
```
      Deprecated.
- Class org.researchstack.backbone.step.FormStep extends QuestionStep implements Serializable
  - Serialized Fields
    - formSteps
```
java.util.List<E> formSteps
```
- Class org.researchstack.backbone.step.InstructionStep extends Step implements Serializable
- Class org.researchstack.backbone.step.QuestionStep extends Step implements Serializable
  - Serialized Fields
    - answerFormat
```
AnswerFormat answerFormat
```
    - placeholder
```
java.lang.String placeholder
```
- Class org.researchstack.backbone.step.Step extends java.lang.Object implements Serializable
  - Serialized Fields
    - identifier
```
java.lang.String identifier
```
    - stepLayoutClass
```
java.lang.Class<T> stepLayoutClass
```
    - stepTitle
```
int stepTitle
```
    - optional
```
boolean optional
```
    - title
```
java.lang.String title
```
    - text
```
java.lang.String text
```
    - restorable
```
boolean restorable
```
    - task
```
Task task
```
    - shouldTintImages
```
boolean shouldTintImages
```
    - showsProgress
```
boolean showsProgress
```
    - allowsBackNavigation
```
boolean allowsBackNavigation
```
    - useSurveyMode
```
boolean useSurveyMode
```
Package org.researchstack.backbone.storage.database
- Class org.researchstack.backbone.storage.database.TaskNotification extends java.lang.Object implements Serializable
  - Serialized Fields
    - id
```
int id
```
    - endDate
```
java.util.Date endDate
```
    - chronTime
```
java.lang.String chronTime
```
Package org.researchstack.backbone.storage.file
- Class org.researchstack.backbone.storage.file.StorageAccessException extends java.lang.RuntimeException implements Serializable
Package org.researchstack.backbone.task
- Class org.researchstack.backbone.task.OrderedTask extends Task implements Serializable
  - Serialized Fields
    - steps
```
java.util.List<E> steps
```
- Class org.researchstack.backbone.task.Task extends java.lang.Object implements Serializable
  - Serialized Fields
    - identifier
```
java.lang.String identifier
```
- Class org.researchstack.backbone.task.Task.InvalidTaskException extends java.lang.RuntimeException implements Serializable

Serialized Form

Package org.researchstack.backbone.answerformat

Class org.researchstack.backbone.answerformat.AnswerFormat extends java.lang.Object implements Serializable

Class org.researchstack.backbone.answerformat.BirthDateAnswerFormat extends DateAnswerFormat implements Serializable

Serialized Fields

minAge

maxAge

Class org.researchstack.backbone.answerformat.BooleanAnswerFormat extends ChoiceAnswerFormat implements Serializable

Class org.researchstack.backbone.answerformat.ChoiceAnswerFormat extends AnswerFormat implements Serializable

Serialized Fields

answerStyle

choices

Class org.researchstack.backbone.answerformat.DateAnswerFormat extends AnswerFormat implements Serializable

Serialized Fields

style

defaultDate

minimumDate

maximumDate

Class org.researchstack.backbone.answerformat.DecimalAnswerFormat extends AnswerFormat implements Serializable

Serialized Fields

minValue

maxValue

Class org.researchstack.backbone.answerformat.DurationAnswerFormat extends AnswerFormat implements Serializable

Serialized Fields

unit

step

Class org.researchstack.backbone.answerformat.EmailAnswerFormat extends TextAnswerFormat implements Serializable

Class org.researchstack.backbone.answerformat.FormAnswerFormat extends AnswerFormat implements Serializable

Class org.researchstack.backbone.answerformat.IntegerAnswerFormat extends AnswerFormat implements Serializable

Serialized Fields

maxValue

minValue

Class org.researchstack.backbone.answerformat.TextAnswerFormat extends AnswerFormat implements Serializable

Serialized Fields

maximumLength

isMultipleLines

Class org.researchstack.backbone.answerformat.UnknownAnswerFormat extends AnswerFormat implements Serializable

Package org.researchstack.backbone.model

Class org.researchstack.backbone.model.Choice extends java.lang.Object implements Serializable

Serialized Fields

text

value

detailText

Class org.researchstack.backbone.model.ConsentDocument extends java.lang.Object implements Serializable

Serialized Fields

title

sections

signaturePageTitle

signaturePageContent

signatures

htmlReviewContent

Class org.researchstack.backbone.model.ConsentSection extends java.lang.Object implements Serializable

Serialized Fields

type

title

formalTitle

summary

content

escapedContent

htmlContent

customImageName

customLearnMoreButtonTitle

customAnimationURL

Class org.researchstack.backbone.model.ConsentSignature extends java.lang.Object implements Serializable

Serialized Fields

requiresName

requiresSignatureImage

requiresBirthDate

identifier

title

fullName

signatureImage

signatureDate

signatureDateFormatString

Package org.researchstack.backbone.result

Class org.researchstack.backbone.result.Result extends java.lang.Object implements Serializable

Serialized Fields

identifier

startDate

endDate