Contents

getNextRequestedUpdateDate(handler:)

Gets the next time at which to update your complication.

Declaration

optional func getNextRequestedUpdateDate(handler: @escaping (Date?) -> Void)

Parameters

  • handler:

    The handler to execute with the next date at which to run your complication code. This block has no return value and takes the following parameter:

    updateDate

    The date after which you’d like your complication to run again. If you specify nil, ClockKit doesn’t schedule a new update time for your complication. You can still trigger updates manually.

Discussion

Your implementation of this method must execute the block in the handler parameter and specify an appropriate date. Specify a date as far into the future as you can manage for your complications. ClockKit wakes up your complication at some point after the specified date to request new data. The exact time at which your complication runs isn’t guaranteed.

If your complication data changes before the specified update date, you can invalidate your complication data using the CLKComplicationServer object.

If you don’t implement this method, ClockKit doesn’t schedule your complication for another update. You must trigger updates to your complication’s data manually by extending or reloading your timeline.

See Also

Deprecated methods