App搜索编程指南(三) —— 让项目可索引之索引活动和导航点(一)

版本记录

版本号 时间
V1.0 2018.09.18

前言

iOS系统有自己的搜索,大家试过的都知道,这个搜索速度非常之快,可以很快的在网页、appleStor、地图以及其他App中的内容,接下来就让我们一起来看一下这个搜索。感兴趣的看下面几篇文章。
1. App搜索编程指南(一) —— 搜索基本之搜索推动用户参与(一)
2. App搜索编程指南(二) —— 搜索基本之示例实现(一)

Index Activities and Navigation Points - 索引活动和导航点

NSUserActivity类提供的方法允许您捕获用户先前访问过的特定应用程序状态和导航点,然后使用Handoff恢复它们(有关在应用程序中启用Handoff的详细信息,请参阅Handoff Programming Guide)。 在iOS 8及更高版本中运行的应用程序中,用户希望Handoff帮助他们在一台设备上启动活动并在另一台设备上继续活动。

除了支持Handoff之外,在iOS 9及更高版本中使用NSUserActivity还可以:

  • 用户在您的应用中执行索引活动。 活动可以包括创建或查看内容,查看一组项目(例如结果列表)或访问应用程序中的导航点。
  • 将特定项目标记为可用于公共搜索(对于可适用于公共搜索的项目的一些示例,请参阅Example Implementations)。
  • 提供有关项目的可索引元数据,为用户提供搜索结果中的丰富信息。

要提供最佳搜索结果,请避免一次创建多个NSUserActivity对象。 另请注意,NSUserActivity类不用于帮助您索引应用中的任意数据。 如果要索引特定于应用程序的数据,请使用Core Spotlight框架的API并使用相应的relatedUniqueIdentifier将索引项链接在一起(有关详细信息,请参阅Index App Content)。

使用NSUserActivity API还可以利用Siri建议和智能提醒。 Siri建议显示在Spotlight搜索屏幕中,可包含可搜索的活动。 (请注意,只有具有高参与率的活动才有资格包含在Siri建议中。有关参与的更多信息,请参阅Combine APIs to Increase Coverage。)用户可以使用Siri智能提醒来提醒您与应用相关的特定内容。 当用户收到智能提醒时,他们指定的活动会显示在提醒中。

App搜索编程指南(三) —— 让项目可索引之索引活动和导航点(一)_第1张图片
App搜索编程指南(三) —— 让项目可索引之索引活动和导航点(一)_第2张图片

当用户使用您的应用程序时,您可以创建与各种导航点和应用程序状态关联的活动对象。 默认情况下,每个项目都会添加到设备上的索引中。 在iOS 9及更高版本中,将公共项目标记为符合公共索引的条件也会将其添加到设备上索引并带来额外的优势:当您使用网络标记使您的相关网站内容可搜索时,用户参与公开符合条件的您的应用中搜索结果,可以帮助您提高网站内容的排名。 当用户在Spotlight搜索结果中点按可搜索的活动或状态时,您可以使用NSUserActivity API继续活动并将用户返回到应用中的相关区域。

注意:使用NSUserActivity索引的项目不会添加到Apple的服务器端索引或在设备之间同步。 要了解有关为所有iOS用户提供适当项目的方法的更多信息,请参阅 Mark Up Web Content。使用NSUserActivity是帮助iOS衡量用户查看应用内容频率的最佳方式。 用户查看的频率对与您的应用相关的搜索结果的排名有很大影响(要了解提升此排名的其他方法,请参阅Improve the Ranking of Your Results)。

1. Creating Searchable Activities - 创建可搜索的活动

要使活动或导航点可搜索,请创建一个NSUserActivity对象来表示它。 使用NSUserActivity属性标识项目的类型,提供描述项目的元数据,并使其符合搜索条件。 将项目设置为符合搜索条件意味着当项目变为当前项目时,该项目将添加到设备上的索引。Listing 3-1显示了如何创建活动。

// Listing 3-1  Creating an activity

// It's recommended that you use reverse DNS notation for the required activity type property.
var activity: NSUserActivity = NSUserActivity(activityType: "com.myCompany.myContentType")
 
// Set properties that describe the activity and that can be used in search.
activity.title = "My Activity Title"
activity.userInfo = ["id": "http://www.mydomain.com/myContentItem/ABC-123"]
 
// Add the item to the private on-device index.
activity.eligibleForSearch = true

尽管Listing 3-1中未显示,但NSUserActivity还定义了contentAttributeSet属性,该属性允许您指定描述项目所需的任意数量的属性。 contentAttributeSet属性采用CSSearchableItemAttributeSet对象,该对象是Core Spotlight对象,用于提供可索引的元数据以丰富搜索结果。 Core Spotlight定义了大量属性,用于指定多个主题区域中的元数据,例如媒体,事件和消息。 只需要title,userInfo和contentAttributeSet属性,但为了给用户提供最佳体验,建议您为尽可能多的属性提供值。 特别是,建议您始终为thumbnailData和contentDescription属性提供特定于内容的值。 有关可以使用的完整属性列表,请参阅CSSearchableItemAttributeSet Class Reference

图3-1显示了如何使用三个常用属性来提供有关可搜索项目的元数据。

App搜索编程指南(三) —— 让项目可索引之索引活动和导航点(一)_第3张图片
Figure 3-1 A searchable item can use various properties to display metadata

特别值得一提的是三个NSUserActivity属性:

  • eligibleForPublicIndexing
  • expirationDate
  • webpageURL

默认情况下,活动是私有的 当您设置项目的qualifiedForPublicIndexing属性并使用网络标记来搜索您的相关网站内容时,用户与该项目的互动有助于提高您网站内容的排名。 要了解有关使用Web标记的更多信息,请参阅 Mark Up Web Content。

如果未正确设置expirationDate属性,系统会在一段时间后自动使活动到期。

当您的应用内容在您的网站中也可用且您在应用中使用NSUserActivity API并在您的网站中使用网络标记时,webpageURL属性非常有用。特别是,您可以使用webpageURL属性来避免对同一项重复索引(要了解更多信息,请参阅 Combine APIs to Increase Coverage)。设置webpageURL属性时,还要使用必须存储的userInfo字典的键设置requiredUserInfoKeys属性。如果未设置requiredUserInfoKeys属性,则在恢复活动时userInfo字典将为空。

当用户执行活动或进入与您创建的NSUserActivity对象关联的应用程序状态时,您的应用程序会调用becomeCurrent方法将活动标记为当前。符合搜索条件的当前活动会自动添加到私有设备上的索引(即CSSearchableIndex)。此外,您可以在搜索结果中启用用户操作,例如拨打电话号码或获取到某个位置的路线(要了解如何执行此操作,请参阅CSSearchableItemAttributeSet Class Reference中的Supporting Actions)。

为了保证活动及其元数据被编入索引,您必须对活动保持强引用,直到将其添加到索引中。有两种方法可以执行此操作:第一种方法是将活动分配给创建活动的控制器对象中的属性。第二种方法是使用UIResponder对象的userActivity属性。如果使用第二种方式,则需要在updateUserActivityState:方法中设置元数据 - 例如userInfo属性中的信息。否则,您在活动中设置的元数据将不会保留。

如果您希望某个活动符合搜索条件但不适用于设备之间的Handoff,请将eligibleForSearch属性设置为true,并将eligibleForHandoff属性设置为false

使用Core Spotlight API删除使用NSUserActivity编制索引的项目。使用NSUserActivity和Core Spotlight API对项目建立索引并使用relatedUniqueIdentifier属性连接项目时,使用Core Spotlight API删除项目会使该活动不符合索引条件。有关使用relatedUniqueIdentifier属性的更多信息,请参阅Combine APIs to Increase Coverage。

2. Continuing Activities Chosen in Search Results - 搜索结果中选择的持续活动

当用户点击您添加到索引的NSUserActivity项目的搜索结果时,您的应用程序应该打开并恢复与该项目关联的上下文。 为此,您的app委托实现了application:continueUserActivity:restorationHandler:,检查传入活动的类型,以查看应用程序是否正在打开,因为用户点击了搜索结果中的索引项。application:continueUserActivity:restorationHandler:方法与您当前使用Handoff继续活动的方法相同。

Listing 3-2 显示了application:continueUserActivity:restorationHandler:的主要实现框架。

// Listing 3-2   Continuing a user activity

func application(UIApplication, continueUserActivity userActivity: NSUserActivity, restorationHandler: [AnyObject]? -> Void) -> Bool {
    if userActivity.activityType == "com.myCompany.myContentType" {
        // Restore app state for this userActivity and associated userInfo value.
    }
    return true
}

后记

本篇主要讲述了让项目可索引之索引活动和导航点,感兴趣的给个赞或者关注~~~

App搜索编程指南(三) —— 让项目可索引之索引活动和导航点(一)_第4张图片

你可能感兴趣的:(App搜索编程指南(三) —— 让项目可索引之索引活动和导航点(一))