IntentTimeLineProvider (意圖時間表提供商)
建議WidgetKit何時更新用戶可配置的窗口小部件顯示的類型
宣言
protocol IntentTimeLineProvider
總覽
*指控時間軸提供程懋序執行與相他為的功能,但還將用戶配置的詳細信息合并到時間軸條目(。)TimelineProvider
例如,在顯示用戶已選擇的游戲角色的健康狀態的小部件中,提供者會收到一個自定義意圖,用于指定要顯示的角色。然后,在Xcode項目中,定義一個自定義SiriKit Intent Definition文件。意向定義可以包括角色的詳細信息,例如角色的名稱,頭像,戰略聯盟等。
Xcode生成以下INIntent
定制意圖:
public class SelectCharacterIntent: INIntent {
@NSManaged public var characterName: String?
@NSManaged public var avatar: String?
@NSManaged public var alliances: [String]?
@NSManaged public var healthLevel: NSNumber?
}
因為用戶可以添加特定小部件的多個實例,所以您的提供者需要一種方法來區分WidgetKit詢問的是哪個實例。當WidgetKit調用getSnapshot(for:in:completion:)或getTimeline(for:in:completion:)時,它會傳遞一個自定義INIntent的實例,該實例由用戶選擇的詳細信息配置。游戲小部件提供程序訪問意圖的屬性,并將它們包含在TimelineEntry中。然后,WidgetKit調用小部件配置的內容閉包,傳遞時間軸條目以允許視圖訪問用戶配置的屬性。例如,提供者可能實現一個TimelineEntry,它的屬性與自定義意圖中的屬性相對應:
struct CharacterDetailEntry : TimeLineEntry {
var date:Date
var name:String?
var avator:String?
var alliances:[String]?
var healthLevel:Double?
}
為了生成快照,游戲小部件提供程序使用意圖中的屬性初始化角色詳細信息條目。
struct CharacterDetailProvider:IntentTimeLineProvider {
func getSnapshot(for configuration:SelectCharacterIntent,in context:Context,completion:@escaping (CharacterDetailEntry) ->Void) {
let entry = CharacterDetailEntry(
date:Date(),
name:configuration.characterName,
avatar:configuration.avatar,
alliances:configuration.alliances,
healthLevel:configuration.healthLevel?.doubleValue
)
completion(entry)
}
話題
產生時間表
func getSnapshot(for: Self.Intent, in: Self.Context, completion: (Self.Entry) -> Void)
提供一個時間軸條目,表示小部件的當前時間和狀態。
需要。 提供了默認實現。
func getTimeline(for: Self.Intent, in: Self.Context, completion: (Timeline<Self.Entry>) -> Void)
提供當前時間以及(可選)任何將來時間的時間線條目數組,以更新窗口小部件。
需要。 提供了默認實現。
func placeholder(in: Self.Context) -> Self.Entry
需要。 提供了默認實現。
associatedtype Entry : TimelineEntry
需要。
associatedtype Intent : INIntent
需要。
實例方法
func snapshot(for: Self.Intent, with: Self.Context, completion: (Self.Entry) -> ())
需要。 提供了默認實現。
func timeline(for: Self.Intent, with: Self.Context, completion: (Timeline<Self.Entry>) -> ())
需要。 提供了默認實現。
另外閱讀
相關文件
class INIntent
在您的應用或Intents擴展中實現的請求。
時間表管理
使小部件保持最新
計劃小部件的時間軸,以使用動態視圖及時顯示相關信息,并在發生變化時更新時間軸。
protocol TimelineProvider
建議WidgetKit何時更新窗口小部件顯示的類型。
struct TimelineProviderContext
一個對象,其中包含有關如何渲染小部件的詳細信息,包括其大小以及它是否出現在小部件庫中。
protocol TimelineEntry
一種類型,指定顯示小部件的日期,并可選地指示小部件內容的當前相關性。
struct Timeline
一個對象,指定WidgetKit更新窗口小部件視圖的日期。
class WidgetCenter
包含用戶配置的小部件列表的對象,用于重新加載小部件時間線。