Skip to content

Commit

Permalink
WatchBackgroundRefresh: Version 1.0, 2016-09-13
Browse files Browse the repository at this point in the history 
First release

This sample demonstrates how to use WKRefreshBackgroundTask to update WatchKit apps in the background.
  • Loading branch information
@Lax
Lax committed Dec 24, 2016
1 parent ce12f1b commit 7070c9b
Show file tree
Hide file tree
Showing 19 changed files with 1,190 additions and 0 deletions.
42 changes: 42 additions & 0 deletions WatchBackgroundRefresh/LICENSE.txt
View file
@@ -0,0 +1,42 @@
Sample code project: WatchBackgroundRefresh: Using WKRefreshBackgroundTask to update WatchKit apps in the background
Version: 1.0

IMPORTANT: This Apple software is supplied to you by Apple
Inc. ("Apple") in consideration of your agreement to the following
terms, and your use, installation, modification or redistribution of
this Apple software constitutes acceptance of these terms. If you do
not agree with these terms, please do not use, install, modify or
redistribute this Apple software.

In consideration of your agreement to abide by the following terms, and
subject to these terms, Apple grants you a personal, non-exclusive
license, under Apple's copyrights in this original Apple software (the
"Apple Software"), to use, reproduce, modify and redistribute the Apple
Software, with or without modifications, in source and/or binary forms;
provided that if you redistribute the Apple Software in its entirety and
without modifications, you must retain this notice and the following
text and disclaimers in all such redistributions of the Apple Software.
Neither the name, trademarks, service marks or logos of Apple Inc. may
be used to endorse or promote products derived from the Apple Software
without specific prior written permission from Apple. Except as
expressly stated in this notice, no other rights or licenses, express or
implied, are granted by Apple herein, including but not limited to any
patent rights that may be infringed by your derivative works or by other
works in which the Apple Software may be incorporated.

The Apple Software is provided by Apple on an "AS IS" basis. APPLE
MAKES NO WARRANTIES, EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION
THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS
FOR A PARTICULAR PURPOSE, REGARDING THE APPLE SOFTWARE OR ITS USE AND
OPERATION ALONE OR IN COMBINATION WITH YOUR PRODUCTS.

IN NO EVENT SHALL APPLE BE LIABLE FOR ANY SPECIAL, INDIRECT, INCIDENTAL
OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) ARISING IN ANY WAY OUT OF THE USE, REPRODUCTION,
MODIFICATION AND/OR DISTRIBUTION OF THE APPLE SOFTWARE, HOWEVER CAUSED
AND WHETHER UNDER THEORY OF CONTRACT, TORT (INCLUDING NEGLIGENCE),
STRICT LIABILITY OR OTHERWISE, EVEN IF APPLE HAS BEEN ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.

Copyright (C) 2016 Apple Inc. All Rights Reserved.
24 changes: 24 additions & 0 deletions WatchBackgroundRefresh/README.md
View file
@@ -0,0 +1,24 @@
# WatchBackgroundRrefresh: Using WKRefreshBackgroundTask to update WatchKit apps in the background

This sample demonstrates a common background refresh pattern:

1. First schedule an application task by pressing the button on the UI
2. Now background the app using the crown
3. Wait for that applicaiton task to arrive
4. Using the application task's runtime, start a background URL session to download a file
5. When that file arrives, update the label on the UI to the current time and schedule a snapshot
6. When the snapshot completes, check the dock and you'll see the new timestamp

Schedule runtime -> do some work -> snapshot your UI

## Requirements

### Build

Xcode 8.0 or later; iOS 10.0 SDK or later, watchOS 3.0 SDK or later

### Runtime

iOS 10.0 or later, watchOS 3.0 or later

Copyright (C) 2016 Apple Inc. All rights reserved.
55 changes: 55 additions & 0 deletions ...esh/WatchBackgroundRrefresh WatchKit App/Assets.xcassets/AppIcon.appiconset/Contents.json
View file
@@ -0,0 +1,55 @@
{
"images" : [
{
"size" : "24x24",
"idiom" : "watch",
"scale" : "2x",
"role" : "notificationCenter",
"subtype" : "38mm"
},
{
"size" : "27.5x27.5",
"idiom" : "watch",
"scale" : "2x",
"role" : "notificationCenter",
"subtype" : "42mm"
},
{
"size" : "29x29",
"idiom" : "watch",
"role" : "companionSettings",
"scale" : "2x"
},
{
"size" : "29x29",
"idiom" : "watch",
"role" : "companionSettings",
"scale" : "3x"
},
{
"size" : "40x40",
"idiom" : "watch",
"scale" : "2x",
"role" : "appLauncher",
"subtype" : "38mm"
},
{
"size" : "86x86",
"idiom" : "watch",
"scale" : "2x",
"role" : "quickLook",
"subtype" : "38mm"
},
{
"size" : "98x98",
"idiom" : "watch",
"scale" : "2x",
"role" : "quickLook",
"subtype" : "42mm"
}
],
"info" : {
"version" : 1,
"author" : "xcode"
}
}
28 changes: 28 additions & 0 deletions WatchBackgroundRefresh/WatchBackgroundRrefresh WatchKit App/Base.lproj/Interface.storyboard
View file
@@ -0,0 +1,28 @@
<?xml version="1.0" encoding="UTF-8"?>
<document type="com.apple.InterfaceBuilder.WatchKit.Storyboard" version="3.0" toolsVersion="11145" systemVersion="16A205a" targetRuntime="watchKit" propertyAccessControl="none" useAutolayout="YES" useTraitCollections="YES" colorMatched="YES" initialViewController="AgC-eL-Hgc">
<dependencies>
<plugIn identifier="com.apple.InterfaceBuilder.IBCocoaTouchPlugin" version="11118"/>
<plugIn identifier="com.apple.InterfaceBuilder.IBWatchKitPlugin" version="11060"/>
</dependencies>
<scenes>
<!--Main Interface Controller-->
<scene sceneID="aou-V4-d1y">
<objects>
<controller id="AgC-eL-Hgc" customClass="MainInterfaceController" customModule="WatchBackgroundRrefresh_WatchKit_Extension">
<items>
<label alignment="center" text="Time Display" id="Um8-yT-g1K"/>
<button width="1" alignment="left" verticalAlignment="bottom" title="Schedule Refresh" id="8Jk-FF-pu2">
<connections>
<action selector="ScheduleRefreshButtonTapped" destination="AgC-eL-Hgc" id="J4i-VE-SCb"/>
</connections>
</button>
</items>
<connections>
<outlet property="timeDisplayLabel" destination="Um8-yT-g1K" id="tuG-we-swN"/>
</connections>
</controller>
</objects>
<point key="canvasLocation" x="-61" y="133"/>
</scene>
</scenes>
</document>
35 changes: 35 additions & 0 deletions WatchBackgroundRefresh/WatchBackgroundRrefresh WatchKit App/Info.plist
View file
@@ -0,0 +1,35 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
<key>CFBundleDevelopmentRegion</key>
<string>en</string>
<key>CFBundleDisplayName</key>
<string>WatchBackgroundRrefresh WatchKit App</string>
<key>CFBundleExecutable</key>
<string>$(EXECUTABLE_NAME)</string>
<key>CFBundleIdentifier</key>
<string>$(PRODUCT_BUNDLE_IDENTIFIER)</string>
<key>CFBundleInfoDictionaryVersion</key>
<string>6.0</string>
<key>CFBundleName</key>
<string>$(PRODUCT_NAME)</string>
<key>CFBundlePackageType</key>
<string>APPL</string>
<key>CFBundleShortVersionString</key>
<string>1.0</string>
<key>CFBundleSignature</key>
<string>????</string>
<key>CFBundleVersion</key>
<string>1</string>
<key>UISupportedInterfaceOrientations</key>
<array>
<string>UIInterfaceOrientationPortrait</string>
<string>UIInterfaceOrientationPortraitUpsideDown</string>
</array>
<key>WKCompanionAppBundleIdentifier</key>
<string>com.example.apple-samplecode.watchbackgroundrefresh</string>
<key>WKWatchKitApp</key>
<true/>
</dict>
</plist>
18 changes: 18 additions & 0 deletions ...it Extension/Assets.xcassets/Complication.complicationset/Circular.imageset/Contents.json
View file
@@ -0,0 +1,18 @@
{
"images" : [
{
"idiom" : "watch",
"screenWidth" : "{130,145}",
"scale" : "2x"
},
{
"idiom" : "watch",
"screenWidth" : "{146,165}",
"scale" : "2x"
}
],
"info" : {
"version" : 1,
"author" : "xcode"
}
}
23 changes: 23 additions & 0 deletions ...undRrefresh WatchKit Extension/Assets.xcassets/Complication.complicationset/Contents.json
View file
@@ -0,0 +1,23 @@
{
"assets" : [
{
"idiom" : "watch",
"filename" : "Circular.imageset",
"role" : "circular"
},
{
"idiom" : "watch",
"filename" : "Modular.imageset",
"role" : "modular"
},
{
"idiom" : "watch",
"filename" : "Utilitarian.imageset",
"role" : "utilitarian"
}
],
"info" : {
"version" : 1,
"author" : "xcode"
}
}
18 changes: 18 additions & 0 deletions ...Kit Extension/Assets.xcassets/Complication.complicationset/Modular.imageset/Contents.json
View file
@@ -0,0 +1,18 @@
{
"images" : [
{
"idiom" : "watch",
"screenWidth" : "{130,145}",
"scale" : "2x"
},
{
"idiom" : "watch",
"screenWidth" : "{146,165}",
"scale" : "2x"
}
],
"info" : {
"version" : 1,
"author" : "xcode"
}
}
18 changes: 18 additions & 0 deletions ...Extension/Assets.xcassets/Complication.complicationset/Utilitarian.imageset/Contents.json
View file
@@ -0,0 +1,18 @@
{
"images" : [
{
"idiom" : "watch",
"screenWidth" : "{130,145}",
"scale" : "2x"
},
{
"idiom" : "watch",
"screenWidth" : "{146,165}",
"scale" : "2x"
}
],
"info" : {
"version" : 1,
"author" : "xcode"
}
}
12 changes: 12 additions & 0 deletions WatchBackgroundRefresh/WatchBackgroundRrefresh WatchKit Extension/ExtensionDelegate.swift
View file
@@ -0,0 +1,12 @@
/*
Copyright (C) 2016 Apple Inc. All Rights Reserved.
See LICENSE.txt for this sample’s licensing information
Abstract:
The Extension Delegate.
*/

import WatchKit

class ExtensionDelegate: NSObject, WKExtensionDelegate {
}
38 changes: 38 additions & 0 deletions WatchBackgroundRefresh/WatchBackgroundRrefresh WatchKit Extension/Info.plist
View file
@@ -0,0 +1,38 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
<key>CFBundleDevelopmentRegion</key>
<string>en</string>
<key>CFBundleDisplayName</key>
<string>WatchBackgroundRrefresh WatchKit Extension</string>
<key>CFBundleExecutable</key>
<string>$(EXECUTABLE_NAME)</string>
<key>CFBundleIdentifier</key>
<string>$(PRODUCT_BUNDLE_IDENTIFIER)</string>
<key>CFBundleInfoDictionaryVersion</key>
<string>6.0</string>
<key>CFBundleName</key>
<string>$(PRODUCT_NAME)</string>
<key>CFBundlePackageType</key>
<string>XPC!</string>
<key>CFBundleShortVersionString</key>
<string>1.0</string>
<key>CFBundleSignature</key>
<string>????</string>
<key>CFBundleVersion</key>
<string>1</string>
<key>NSExtension</key>
<dict>
<key>NSExtensionAttributes</key>
<dict>
<key>WKAppBundleIdentifier</key>
<string>com.example.apple-samplecode.watchbackgroundrefresh.watchkitapp</string>
</dict>
<key>NSExtensionPointIdentifier</key>
<string>com.apple.watchkit</string>
</dict>
<key>WKExtensionDelegateClassName</key>
<string>$(PRODUCT_MODULE_NAME).ExtensionDelegate</string>
</dict>
</plist>

0 comments on commit 7070c9b

Please sign in to comment.