ORKConsentSignature Class Reference

Inherits from NSObject
Conforms to NSCopying
NSSecureCoding
Declared in ORKConsentSignature.h

The ORKConsentSignature class represents a signature in as ORKConsentDocument object. The signature can be that of an investigator, possibly prefilled with an image, date, and first and last name; or you might need to collect the details of a signature.

Signatures can be collected in a consent review step (ORKConsentReviewStep). After a signature has been obtained (which produces an ORKConsentSignatureResult object), the resulting signature can be substituted into a copy of the document, and used when generating a PDF.

Alternatively, the details of a signature can be uploaded to a server for PDF generation elsewhere or simply as a record of having obtained consent.

The signature object has no concept of a cryptographic signature – it is merely a record of any input the user made during a consent review step. Also, an ORKConsentSignature object does not verify or vouch for user identity.

Factory methods

+ signatureForPersonWithTitle:dateFormatString:identifier:givenName:familyName:signatureImage:dateString:

Returns a fully populated signature.

+ (ORKConsentSignature *)signatureForPersonWithTitle:(nullable NSString *)title dateFormatString:(nullable NSString *)dateFormatString identifier:(NSString *)identifier givenName:(nullable NSString *)givenName familyName:(nullable NSString *)familyName signatureImage:(nullable UIImage *)signatureImage dateString:(nullable NSString *)signatureDate

Parameters

title

The title of the signatory.

dateFormatString

The format string to use when formatting the date of signature.

identifier

The identifier of the signature, unique within this document.

givenName

The given name of the signatory.

familyName

The family name of the signatory.

signatureImage

An image of the signature.

signatureDate

The date on which the signature was obtained, represented as a string.

Discussion

Use this factory method when you need to prepopulate the investigator’s signature in a generated consent document.

Declared In

ORKConsentSignature.h

+ signatureForPersonWithTitle:dateFormatString:identifier:

Returns a signature to be collected.

+ (ORKConsentSignature *)signatureForPersonWithTitle:(nullable NSString *)title dateFormatString:(nullable NSString *)dateFormatString identifier:(NSString *)identifier

Parameters

title

The title of the signatory.

dateFormatString

The format string to use when formatting the date of signature.

identifier

The identifier of the signature, unique within this document.

Discussion

Use this factory method when representing a request to collect a signature for a consent review step.

Declared In

ORKConsentSignature.h

Consent review configuration

  requiresName

A Boolean value indicating whether the user needs to enter their name during consent review.

@property (nonatomic, assign) BOOL requiresName

Discussion

The default value of this property is YES. In a consent review step, the name entry screen is not displayed when the value of this property is NO.

Declared In

ORKConsentSignature.h

  requiresSignatureImage

A Boolean value indicating whether the user needs to draw a signature during consent review.

@property (nonatomic, assign) BOOL requiresSignatureImage

Discussion

The default value of this property is YES. In a consent review step, the signature entry screen is not shown when this property is NO.

Declared In

ORKConsentSignature.h

Identifying signatories

  identifier

The identifier for this signature.

@property (nonatomic, copy) NSString *identifier

Discussion

The identifier should be unique in the document. It can be used to find or replace a specific signature in an ORKConsentDocument object. The identifier is also reproduced in the ORKConsentSignatureResult object produced by an ORKConsentReviewStep object.

Declared In

ORKConsentSignature.h

Personal information.

  title

The title of the signatory.

@property (nonatomic, copy, nullable) NSString *title

Declared In

ORKConsentSignature.h

  givenName

The given name (first name in Western languages)

@property (nonatomic, copy, nullable) NSString *givenName

Declared In

ORKConsentSignature.h

  familyName

The family name (last name in Western languages)

@property (nonatomic, copy, nullable) NSString *familyName

Declared In

ORKConsentSignature.h

  signatureImage

The image of the signature, if any.

@property (nonatomic, copy, nullable) UIImage *signatureImage

Declared In

ORKConsentSignature.h

  signatureDate

The date associated with the signature.

@property (nonatomic, copy, nullable) NSString *signatureDate

Declared In

ORKConsentSignature.h

  signatureDateFormatString

The date format string to be used when producing a date string for the PDF or consent review.

@property (nonatomic, copy, nullable) NSString *signatureDateFormatString

Discussion

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.

Declared In

ORKConsentSignature.h