ConsentTask

public class ConsentTask: ORKOrderedTask

An ORKTask-implementing class that can be fed to an ORKTaskViewController to guide a user through consenting.

Data to be shown is read from the Contract resource, which will be converted into an ORKConsentDocument.

  • Undocumented

    Declaration

    Swift

    public class ConsentTask: ORKOrderedTask
  • Undocumented

    Declaration

    Swift

    public class ConsentTask: ORKOrderedTask
  • The identifier of the review step.

    Declaration

    Swift

    public static let reviewStepName = "reviewStep"
  • The identifier for the participant’s signature in results of the review step.

    Declaration

    Swift

    public static let participantSignatureName = "participant"
  • The sharing step.

    Declaration

    Swift

    public var sharingStep: ORKStep?
  • The identifier of the sharing step.

    Declaration

    Swift

    public static let sharingStepName = "sharing"
  • The identifier of the passcode/PIN step.

    Declaration

    Swift

    public static let pinStepName = "passcode"
  • Undocumented

    Declaration

    Swift

    public class ConsentTask: ORKOrderedTask
  • Designated initializer. Throws exceptions when step creation from the given contract fails.

    The fact that we need to initialize all stored properties before throwing is bonkers, fix it Swift!!

    Declaration

    Swift

    public init(identifier: String, contract: Contract, options: ConsentTaskOptions) throws

    Parameters

    identifier

    The identifier for the task

    contract

    The Contract resource to use to create steps from

    options

    Options for the consenting task

  • Undocumented

    Declaration

    Swift

    public class ConsentTask: ORKOrderedTask
  • Retrieves the signature result (identifier participantSignatureName) of the consent signature step (identifier reviewStepName).

    Declaration

    Swift

    public func signatureResult(from taskResult: ORKTaskResult) -> ORKConsentSignatureResult?

    Parameters

    from

    The result of the consent task

    Return Value

    The consent signature result, if the step has been completed yet

  • Extracts the consent signature from the signature result, if it’s there. If this method returns a signature, the patient has agreed to the consent and signed on screen.

    Declaration

    Swift

    public func signature(in result: ORKConsentSignatureResult) -> ORKConsentSignature?

    Parameters

    in

    The consent signature result to inspect

    Return Value

    The consent signature, if it’s there

  • Retrieve the consent signature found in the task result, if it’s there, indicating the user consented.

    Declaration

    Swift

    public func signature(from taskResult: ORKTaskResult) -> ORKConsentSignature?

    Parameters

    from

    The result of the consent task to inspect

    Return Value

    The consent signature, if the user consented and signed

  • Undocumented

    Declaration

    Swift

    public class ConsentTask: ORKOrderedTask