PlatformAvailability

public struct PlatformAvailability

Describes the availability of a given entity on a particular platform, e.g., a particular class might only be available on Mac OS 10.7 or newer.

  • A string that describes the platform for which this structure provides availability information.

    Declaration

    Swift

    public let platform: String

  • The version number in which this entity was introduced.

    Declaration

    Swift

    public let introduced: Version

  • The version number in which this entity was deprecated (but is still available).

    Declaration

    Swift

    public let deprecated: Version?

  • The version number in which this entity was obsoleted, and therefore is no longer available.

    Declaration

    Swift

    public let obsoleted: Version?

  • Whether the entity is unconditionally unavailable on this platform.

    Declaration

    Swift

    public let unavailable: Bool

  • An optional message to provide to a user of this API, e.g., to suggest replacement APIs.

    Declaration

    Swift

    public let message: String?