DataDetector.Options

struct · iOS 26.0+ · SDK 27.1

struct Options

A set of options that can be used to refine the behavior of text scanning, and better interpret the semantic of the matches. These properties are only hints, no assumption should be made about how the will be used. Set `documentDate` to the creation date of the scanned string. (e.g. Text message reception date). Default is now. Set `documentTimeZone` to the time zone matching the documentDate. Default is the current user time zone. Set `documentLanguageCode` to the language code of the scanned string. Example: "en". *Only set this if it is already known with high confidence*. If guessing is required, it should be left to nil. Set `documentRegion` to the region relevant to the scanned string, if any. *Only set this if it is already known with high confidence*. If guessing is required, it should be left to nil.

Members (9)

get documentDate(): (globalThis.Date) | null

var documentDate: Date?

set documentDate(value: (globalThis.Date) | null)

var documentDate: Date?

get documentRegion(): (_Foundation_Locale_Region) | null

var documentRegion: Locale.Region?

set documentRegion(value: (_Foundation_Locale_Region) | null)

var documentRegion: Locale.Region?

get documentTimeZone(): (_Foundation_TimeZone) | null

var documentTimeZone: TimeZone?

set documentTimeZone(value: (_Foundation_TimeZone) | null)

var documentTimeZone: TimeZone?

get documentLanguageCode(): (_Foundation_Locale_LanguageCode) | null

var documentLanguageCode: Locale.LanguageCode?

set documentLanguageCode(value: (_Foundation_Locale_LanguageCode) | null)

var documentLanguageCode: Locale.LanguageCode?

static init(): DataDetector_Options

init()

All DataDetection types →