CLKComplicationDataSource
A protocol that provides ClockKit with information about your complication.
Declaration
@MainActor protocol CLKComplicationDataSource : NSObjectProtocolMentioned in
Overview
Apps that support a complication must define a class that supports the CLKComplicationDataSource protocol and register it with the system. Your data source is responsible for providing timeline entries and data for all of the complication families that you support. You do this by implementing the protocol methods, returning the timeline entries displayed by your complication and information about the features that your complication supports.
You don’t instantiate your data source class explicitly. After defining your class, specify the class name in the General tab of the project settings for your WatchKit extension. When the system needs data, ClockKit instantiates your data source and initializes it by calling its init method. Once initialized, ClockKit calls the corresponding protocol methods to gather any needed data. You can also specify your class name in your app’s Info.plist file using the CLKComplicationsPrincipalClass key.
When the user installs your complication on the clock face, ClockKit creates an appropriate CLKComplication object for the selected complication family. ClockKit then passes the complication to your data source so that you know how to format your timeline entries. Use the General tab of your WatchKit extension’s project settings to specify the families you support.
Your complication data source class must implement the CLKComplicationDataSource protocol’s getCurrentTimelineEntry(for:withHandler:) method.
You may implement other methods as needed to support the data in your complication. For example, to batch load future timeline entries, implement getTimelineEndDate(for:withHandler:) and pass a future date to the handler. For more information, see Creating complications for your watchOS app.
ClockKit calls your data source methods on your watchOS app’s main thread.
Topics
Migrating to WidgetKit
widgetMigratorCLKComplicationStaticWidgetMigrationConfigurationCLKComplicationAppIntentWidgetMigrationConfigurationCLKComplicationIntentWidgetMigrationConfigurationCLKComplicationWidgetMigratorCLKComplicationWidgetMigrationConfiguration
Setting information property keys
Deprecated methods
CLKLaunchedTimelineEntryDateKeyCLKLaunchedComplicationIdentifierKeygetComplicationDescriptors(handler:)handleSharedComplicationDescriptors(_:)getLocalizableSampleTemplate(for:withHandler:)getPrivacyBehavior(for:withHandler:)CLKComplicationPrivacyBehaviorgetAlwaysOnTemplate(for:withHandler:)getTimelineEndDate(for:withHandler:)getCurrentTimelineEntry(for:withHandler:)getTimelineEntries(for:after:limit:withHandler:)getTimelineAnimationBehavior(for:withHandler:)CLKComplicationTimelineAnimationBehaviorgetSupportedTimeTravelDirections(for:withHandler:)CLKComplicationTimeTravelDirectionsgetTimelineStartDate(for:withHandler:)getTimelineEntries(for:before:limit:withHandler:)getNextRequestedUpdateDate(handler:)requestedUpdateDidBegin()requestedUpdateBudgetExhausted()getPlaceholderTemplate(for:withHandler:)