App Extension编程指南（iOS8/OS X v10.10）：扩展类型--Today

App Extension编程指南（iOS8/OS X v10.10）：扩展类型--Today

2014-09-04 17:00  编辑：suiling  分类： iOS开发  来源：CocoaChina

 0  9878

iOS 8app extensionapp扩展

招聘信息：

• 武汉德资Startup诚聘iOS攻城师
• Weego 我去·旅行 招聘IOS开发工程师
• 紧急招聘iOS开发工程师2

 

本节由CocoaChina翻译组成员翻译自苹果 App Extension Programming Guide--Extension Types--Today 一节，校对：唧唧歪歪（ 微博）

 

Today 视图的中扩展被称为插件。用户可以通过插件快速访问当前重要的信息。比如，用户打开 Today 视图检查当前的股票价格和天气情况，查看日程安排或者快速执行类似标记已完成项目等操作。用户会频繁打开Today视图，并且他们期望能立即看到他们感兴趣的信息。插件也能展示在iOS设备的锁屏界面上。

 

开始之前

要确保 Today 扩展点适合你想提供的功能。最好的插件可以为用户展现最近的更新或者完成简单的任务。如果你创建的扩展想完成步骤繁多或者比较耗时的任务，比如上传或者下载内容，那么Today扩展可能不是最佳选择。

 

可参看  Table 1-1 了解你可以创建的其他扩展类型。

理解Today 插件

在两个平台上，Today 插件应该：

1.确保内容永远是最新的

2.正确响应用户的操作

3.高效运行（特别是iOS插件必须合理使用内存，否则系统可能终止插件的运行）

 

由于与插件的交互快速且有限制，所以你应该设计一个精简的UI以突出用户感兴趣的信息。通常，一个很好的办法是限制插件中可交互项的数目，尤其要注意iOS插件不支持键盘输入。

 

注意：避免在插件中放置滚动视图，因为用户在滚动插件中的内容时，会很容易误滚动整个Today视图。

 

用户使用的平台不同，因此插件配置方式也有差别。

 

iOS.由于插件不允许键盘输入，所以用户需要能使用containing app来配置插件的内容和行为。比如，在 Stocks 插件中，用户可在不同的股票值之间进行切换，但是他们必须打开Stocks app来管理股票列表。

 

OS X.containing app可能不会执行任何功能，所以插件在运行时需要给用户配置它的方式。比如，OS X中的Stocks插件可以让用户找到和添加他们想要追踪的股票。OS X中通知中心的API包括可以让用户配置插件的方法。

 

在用户安装完包含 Today 插件的应用程序后，他们可以为 Today 视图添加插件。当用户在 Today 视图中选择编辑时，通知中心会展现一个视图让用户添加插件，并可对其进行排序和移除。

 

使用Xcode的Today模板

Xcode的Today模板为主要类提供了默认的头文件和执行文件（命名为TodayViewController），一个Info.plist文件，一个界面文件（一个storyboard或者xib文件）。

 

默认情况下，Today 模板提供了以下 Info.plist 键和值（这里展示的是OS X target）：

  
  
<key>NSExtension</key> 
    <dict> 
        <key>NSExtensionPointIdentifier</key> 
        <string>com.apple.widget-extension</string> 
        <key>NSExtensionPrincipalClass</key> 
        <string>TodayViewController</string> 
    </dict> 

如果你使用了自定义视图控制器子类，那么使用自定义类的名字来取代NSExtensionPrincipalClass 键对应的TodayViewController值。

 

iOS.如果你不想使用模板提供的storyboard文件，那就移除NSExtensionMainStoryboard 键，并添加NSExtensionPrincipalClass 键，使用view controller的名字作为值。

 

创建Today插件所需的大部分工作包括设计UI和实现一个完成自定义功能的view controller子类。

 

设计UI

重要：为了获得最佳的效果，请使用Auto Layout设计Today插件的视图。

 

由于Today视图的空间有限，并且用户体验应该是快速和集中的，你不应该默认创建一个过大的插件。在两个平台上，一个插件必须适应Today视图的宽度，但是它可以通过增加高度来展示更多的内容。

 

默认情况下，插件视图包括标准的margin insets。如果你需要检查或者改变边距值，你可以遵循  NCWidgetProviding 协议，并实现 widgetMarginInsetsForProposedMarginInsets:方法。

 

在大多数情况下，调整margin insets不是必须的，但如果你的设计需要你可能会这么做。比如，Reminders插件在左侧边缘展示复选框图片。

 

如果插件需要展示额外的内容，你可以用Auto Layout约束来调整插件到合适的高度。如果不使用Auto Layout，那你可以使用UIViewController 属性  preferredContentSize来指定插件的新高度。比如：

  
  
- (void)receivedAdditionalContent { 
    self.preferredContentSize = [self sizeNeededToShowAdditionalContent]; 
} 

通常情况下，你不应该让插件过高，因为用户必须滚动才能查看全部内容。

 

iOS.如果你想让调整高度的动画和展示内容的动画一起执行，实现viewWillTransitionToSize:withTransitionCoordinator:方法。用 animateAlongsideTransition:completion:方法把动画添加到coordinator参数中。

 

为了让你的插件能在Today视图中清晰地展示出来，可使用notificationCenterVibrancyEffect。

 

OS X. 插件会从它的view controller所在的视图中继承NSAppearanceNameVibrantDark当使用标准控件时，你会自动获得正确的外观。如果使用自定义颜色，那要确保所选颜色在深色视图中看起来也很适合。

 

更新内容

Today 扩展点提供了API来管理插件的状态，并处理内容更新（你可以在  Notification Center Framework Reference 阅读关于该API的内容）。虽然 Today API 针对特定平台会有所不同，但两个平台都支持的功能的API大部分是相同的。

 

为了让插件看起来保持最新的内容，系统会不定期抓取插件视图的快照。当插件再次可见，将会展示最近的快照，直到系统使用视图的实时版本取代它。

 

想要在抓取快照前更新插件的状态，那要确保遵照  NCWidgetProviding 协议。当你的插件接收 widgetPerformUpdateWithCompletionHandler: 调用时使用最近的内容更新插件视图，并调用completion handler(完成处理程序)，使用以下常量来描述更新结果：

 

NCUpdateResultNewData—新内容要求你重绘view

NCUpdateResultNoData—插件不要求更新

NCUpdateResultFailed—在更新期间发生错误

 

指定插件应该在何时出现

如果你的插件只应该在某种环境下进行展示，比如当它有新内容或者值得关注的内容进行展示时，你可以使用 NCWidgetController API来指定插件应该在何时出现。

 

插件与其 containing app 可使用  setHasContent:forWidgetWithBundleIdentifier:方法来设置插件内容的当前状态。即使插件没有运行，Containing app也可以使用这个API。

 

注意：如果没有内容可供展示，那么插件会隐藏自身。通知中心将不会再次打开你的插件直到containing app指定插件应该被展示。

 

打开Containing App

在某些情况下，插件请求containing app打开是有意义的。比如，在OS X中，当用户点击日历插件中的事件时会打开日历应用。（在iOS中，用户可能需要在containing app打开之前解锁设备）在用户当前任务上下文环境中，为了确保containing app能以用户理解的方式打开，你需要定义一个能在app和它的插件中都能使用的URL scheme。

 

插件不能直接通知其containing app打开，它使用 NSExtensionContext的 openURL:completionHandler:方法通知系统去打开其containing app。当插件使用该方法打开URL，系统会在使用它之前确认请求。

 

支持可编辑(仅适用于OS X)

想要在 OS X 插件中支持编辑模式，需要遵照  NCWidgetProviding 协议。当你把 widgetAllowsEditing 属性设置为YES，Info按钮会自动展示在插件的头部区域。（当用户点击Info按钮，它会自动切换至 Done 按钮。）使用 NCWidgetProviding协议来支持可编辑，当视图进入编辑模式时，编辑、完成和取消按钮会自动被提供。

 

为了观察插件中编辑和非编辑模式之间的变化，你可以使用 NCWidgetProviding 协议的widgetDidBeginEditing 和 widgetDidEndEditing 方法。

 

如果你还想在用户编辑插件时展示一个模态搜索UI，可使用NSViewController的NCWidgetProvidingPresentationStyles 类别来模态弹出搜索视图控制器。当用户表明他们进行搜索时，可使用 dismissViewControllerAnimated:completion:方法来解除搜索视图控制器。（注意你也可以使用presentViewControllerInWidget:方法来展示一个在头部区域有取消按钮的非搜索模态视图）

 

测试插件

iOS：你可以在iOS模拟器或者设备上测试iOS插件。

 

OS X：想要在OS X中测试插件，最简单的方法是使用Xcode Widget Simulator，因为当你切换至其他应用程序或者点击边界以外的部分时，通知中心会立刻收起来。你可以在scheme中为widget target指定Widget Simulator。

 

学习更多扩展调试内容，可参看 Debug Your Extension。