One Logo Pool Ball
TipKit · IOS API REFERENCE

Tip

protocol · iOS 17.0+ · SDK 27.1

protocol Tip : Identifiable, Sendable

A type that sets a tip's content, as well as the conditions for when it displays.

Members (6)

method · iOS 17.0+

invalidate

Swift declaration
func invalidate(reason: Self.InvalidationReason)

Permanently invalidates a tip and prevents it from displaying. - Parameters: - reason: The reason for the tip's invalidation. The tip's `invalidationReason` returns this value after invalidation.

get · iOS 17.0+

shouldDisplay

Swift declaration
var shouldDisplay: Bool { get }

A Boolean value that determines whether to display a tip. This value returns `true` when a tip's status is `.available`, and `false` otherwise.

get · iOS 17.0+

statusUpdates

Swift declaration
var statusUpdates: AsyncStream<Self.Status> { get }

An asynchronous sequence for monitoring a tip's status changes.

method · iOS 26.0+

resetEligibility

Swift declaration
func resetEligibility() async

Reset an invalidated tip.

get · iOS 17.0+

shouldDisplayUpdates

Swift declaration
var shouldDisplayUpdates: AsyncMapSequence<AsyncStream<Self.Status>, Bool> { get }

An asynchronous sequence for monitoring a tip's display eligibility.

get · iOS 17.0+

status

Swift declaration
var status: Self.Status { get }

The current status of a tip based on its rules and the configured ``Tips/ConfigurationOption/displayFrequency(_:)``.

Skipped declarations

No declarations were skipped in this snapshot.

All TipKit types →