struct · iOS 8.0+ · SDK 27.1
struct TimeZoneInformation about standard time conventions associated with a specific geopolitical region. `TimeZone` defines the behavior of a time zone. Time zone values represent geopolitical regions. Consequently, these values have names for these regions. Time zone values also represent a temporal offset, either plus or minus, from Greenwich Mean Time (GMT) and an abbreviation (such as PST for Pacific Standard Time). `TimeZone` provides two static functions to get time zone values: `current` and `autoupdatingCurrent`. The `autoupdatingCurrent` time zone automatically tracks updates made by the user. Note that time zone database entries such as "America/Los_Angeles" are IDs, not names. An example of a time zone name is "Pacific Daylight Time". Although many `TimeZone` functions include the word "name", they refer to IDs. Cocoa does not provide any API to change the time zone of the computer, or of other applications.
daylightSavingTimeOffset(date?: globalThis.Date): numberfunc daylightSavingTimeOffset(for date: Date = Date()) -> TimeIntervalReturns the daylight saving time offset for a given date. - parameter date: The date to use for the calculation. The default value is the current date.
isDaylightSavingTime(date?: globalThis.Date): booleanfunc isDaylightSavingTime(for date: Date = Date()) -> BoolReturns a Boolean value that indicates whether the receiver uses daylight saving time at a given date. - parameter date: The date to use for the calculation. The default value is the current date.
nextDaylightSavingTimeTransitionAfter(date: globalThis.Date): (globalThis.Date) | nullfunc nextDaylightSavingTimeTransition(after date: Date) -> Date?Returns the next daylight saving time transition after a given date. - parameter date: A date. - returns: The next daylight saving time transition after `date`. Depending on the time zone, this function may return a change of the time zone's offset from GMT. Returns `nil` if the time zone of the receiver does not observe daylight savings time as of `date`.
get nextDaylightSavingTimeTransition(): (globalThis.Date) | nullvar nextDaylightSavingTimeTransition: Date? { get }The date of the next (after the current instant) daylight saving time transition for the time zone. Depending on the time zone, the value of this property may represent a change of the time zone's offset from GMT. The value is `nil` if the time zone does not currently observe daylight saving time.
static get timeZoneDataVersion(): stringstatic var timeZoneDataVersion: String { get }Returns the time zone data version.
static get knownTimeZoneIdentifiers(): Array<string>static var knownTimeZoneIdentifiers: [String] { get }Returns an array of strings listing the identifier of all the time zones known to the system.
static initIdentifier(identifier: string): (TimeZone) | nullinit?(identifier: String)Returns a time zone initialized with a given identifier. An example identifier is "America/Los_Angeles". If `identifier` is an unknown identifier, then returns `nil`.
get identifier(): stringvar identifier: String { get }The geopolitical region identifier that identifies the time zone.
get description(): stringvar description: String { get }A textual representation of this instance. Calling this property directly is discouraged. Instead, convert an instance of any type to a string by using the `String(describing:)` initializer. This initializer works with any type, and uses the custom `description` property for types that conform to `CustomStringConvertible`: struct Point: CustomStringConvertible { let x: Int, y: Int var description: String { return "(\(x), \(y))" } } let p = Point(x: 21, y: 30) let s = String(describing: p) print(s) // Prints "(21, 30)" The conversion of `p` to a string in the assignment to `s` uses the `Point` type's `description` property.
abbreviation(date?: globalThis.Date): (string) | nullfunc abbreviation(for date: Date = Date()) -> String?Returns the abbreviation for the time zone at a given date. Note that the abbreviation may be different at different dates. For example, during daylight saving time the US/Eastern time zone has an abbreviation of "EDT." At other times, its abbreviation is "EST." - parameter date: The date to use for the calculation. The default value is the current date.
static initAbbreviation(abbreviation: string): (TimeZone) | nullinit?(abbreviation: String)Returns a time zone identified by a given abbreviation. In general, you are discouraged from using abbreviations except for unique instances such as "GMT". Time Zone abbreviations are not standardized and so a given abbreviation may have multiple meanings--for example, "EST" refers to Eastern Time in both the United States and Australia - parameter abbreviation: The abbreviation for the time zone. - returns: A time zone identified by abbreviation determined by resolving the abbreviation to an identifier using the abbreviation dictionary and then returning the time zone for that identifier. Returns `nil` if there is no match for abbreviation.
get customMirror(): SDKHandlevar customMirror: Mirror { get }The custom mirror for this instance. If this type has value semantics, the mirror should be unaffected by subsequent mutations of the instance.
localizedName(style: NSTimeZone_NameStyle, locale?: (Locale) | null): (string) | nullfunc localizedName(for style: TimeZone.NameStyle, locale: Locale?) -> String?Returns the name of the receiver localized for a given locale.
secondsFromGMT(date?: globalThis.Date): numberfunc secondsFromGMT(for date: Date = Date()) -> IntThe current difference in seconds between the time zone and Greenwich Mean Time. - parameter date: The date to use for the calculation. The default value is the current date.
static initSecondsFromGMT(seconds: number): (TimeZone) | nullinit?(secondsFromGMT seconds: Int)Returns a time zone initialized with a specific number of seconds from GMT. Time zones created with this never have daylight savings and the offset is constant no matter the date. The identifier and abbreviation do NOT follow the POSIX convention (of minutes-west). - parameter seconds: The number of seconds from GMT. - returns: A time zone, or `nil` if a valid time zone could not be created from `seconds`.
get debugDescription(): stringvar debugDescription: String { get }A textual representation of this instance, suitable for debugging. Calling this property directly is discouraged. Instead, convert an instance of any type to a string by using the `String(reflecting:)` initializer. This initializer works with any type, and uses the custom `debugDescription` property for types that conform to `CustomDebugStringConvertible`: struct Point: CustomDebugStringConvertible { let x: Int, y: Int var debugDescription: String { return "(\(x), \(y))" } } let p = Point(x: 21, y: 30) let s = String(reflecting: p) print(s) // Prints "(21, 30)" The conversion of `p` to a string in the assignment to `s` uses the `Point` type's `debugDescription` property.
static get autoupdatingCurrent(): TimeZonestatic var autoupdatingCurrent: TimeZone { get }The time zone currently used by the system, automatically updating to the user's current preference. If this time zone is mutated, then it no longer tracks the system time zone. The autoupdating time zone only compares equal to itself.
static get abbreviationDictionary(): Record<string, string>static var abbreviationDictionary: [String : String] { get set }Returns the mapping of abbreviations to time zone identifiers.
static set abbreviationDictionary(value: Record<string, string>)static var abbreviationDictionary: [String : String] { get set }Returns the mapping of abbreviations to time zone identifiers.
static get gmt(): TimeZonestatic var gmt: TimeZone { get }static get current(): TimeZonestatic var current: TimeZone { get }The time zone currently used by the system.
No declarations were skipped in this snapshot.