您现在的位置: IOS教程網 >> IOS系統 >  >> iOS 教學 >> iOS 相關教學

iOS 9 Spotlight 搜尋 API 使用指南

編輯:iOS 相關教學

iOS 9 Spotlight 搜尋 API 使用指南

iOS 9 對 Spotlight 做了更多開放,讓 App 可以將內容加入系統搜尋索引。透過 CoreSpotlight,使用者可以在 Spotlight 中搜尋 App 內的資料,並直接點擊進入 App 的特定頁面。

一、為何要加入 Spotlight

傳統 App 內的搜尋通常只能在使用者打開 App 後進行。若將內容加入 Spotlight,使用者即使沒有開啟 App,也能從系統搜尋中找到相關資料。這對新聞、文章、商品、食譜、筆記等內容型 App 特別有幫助。

二、加入 CoreSpotlight 框架

若 App 需要支援 iOS 9 以下版本,建議使用條件編譯避免崩潰:

#if __IPHONE_OS_VERSION_MAX_ALLOWED >= 90000
#import 
#import 
#endif

三、建立可搜尋屬性

首先需要建立 CSSearchableItemAttributeSet,用來描述搜尋項目。

CSSearchableItemAttributeSet *attributeSet = [[CSSearchableItemAttributeSet alloc] initWithItemContentType:(NSString *)kUTTypeImage];
attributeSet.title = spotlightTitle;
attributeSet.keywords = keywords;
attributeSet.contentDescription = spotlightDesc;
attributeSet.thumbnailData = photo;

其中 title、keywords、contentDescription 與 thumbnailData 都會影響搜尋結果的呈現。若使用網路圖片,可先下載為 NSData,再設定為縮圖。

四、建立 CSSearchableItem 並加入索引

建立可搜尋項目時,可以透過 uniqueIdentifier 攜帶額外資訊,例如頁面 ID 或參數。

CSSearchableItem *item = [[CSSearchableItem alloc] initWithUniqueIdentifier:spotlightInfo domainIdentifier:domainId attributeSet:attributeSet];
[[CSSearchableIndex defaultSearchableIndex] indexSearchableItems:@[item] completionHandler:^(NSError * error) {
    if (error) {
        NSLog(@"indexSearchableItems Error:%@", error.localizedDescription);
    }
}];

五、刪除 Spotlight 項目

若需要清除所有項目:

[[CSSearchableIndex defaultSearchableIndex] deleteAllSearchableItemsWithCompletionHandler:^(NSError * error) {
    if (error) {
        NSLog(@"%@", error.localizedDescription);
    }
}];

若只需要刪除特定 domain:

[[CSSearchableIndex defaultSearchableIndex] deleteSearchableItemsWithDomainIdentifiers:@"domainId" completionHandler:^(NSError * error) {
    if (error) {
        NSLog(@"%@", error.localizedDescription);
    }
}];

六、使用者點擊搜尋結果後的處理

當使用者從 Spotlight 點擊結果時,App 會收到 NSUserActivity。可以在 AppDelegate 中攔截 CSSearchableItemActionType,並取出 uniqueIdentifier。

- (BOOL)application:(UIApplication *)application continueUserActivity:(NSUserActivity *)userActivity restorationHandler:(void (^)(NSArray * _Nullable))restorationHandler {
    if ([[userActivity activityType] isEqualToString:CSSearchableItemActionType]) {
        NSString *uniqueIdentifier = [userActivity.userInfo objectForKey:CSSearchableItemActivityIdentifier];
        NSLog(@"傳遞過來的值%@", uniqueIdentifier);
    }
    return YES;
}

若需要傳遞多個參數,可以將 JSON 轉成字串,放入 uniqueIdentifier,App 收到後再解析。

七、版本相容提醒

Spotlight 相關 API 僅支援 iOS 9 以上版本。若 App 仍需支援舊版本,務必使用條件編譯或執行期版本檢查,避免在舊裝置上崩潰。

  1. 上一篇文章:
  2. 下一篇文章:
蘋果刷機越獄教程| IOS教程問題解答| IOS技巧綜合| IOS7技巧| IOS8教程
Copyright © IOS教程網 All Rights Reserved