README.md
1
2 Android WearNotifications Sample
3 ===================================
4
5 Sample demonstrates best practices for using NotificationStyle Notifications (Inbox,
6 BigPicture, BigText, and Messaging) for both Mobile apps and native/local Android Wear
7 apps. It also covers Notifications on Wear 1.+ and Wear 2.0.
8
9 Introduction
10 ------------
11
12 Steps for trying out the sample:
13 * Compile and install the mobile app onto your mobile device or emulator (for mobile
14 scenario).
15 * Compile and install the wearable app onto your Wear device or emulator (for Wear
16 scenario).
17
18 This sample demonstrate best practices for using [NotificationStyle][1]
19 [Notifications][2] for two scenarios:
20
21 1. Launching Notifications from a Mobile app WITHOUT a native Android Wear app.
22 Notifications appear both on mobile and Wear (bridged to appear like a local/native
23 Wear app).
24
25 2. Launching Notifications from a Native/Local Android Wear app. Notifications only
26 appear on Wear device.
27
28 The Mobile and Wear apps demonstrate [BigTextStyle][3], [BigPictureStyle][4],
29 [InboxStyle][5], and [MessagingStyle][6] Notifications.
30
31 Although there are two apps (Mobile and Wear) running, each should be looked at as a
32 separate experience. That is, neither app uses nor relies on the other.
33
34 They are packaged together simply to show both scenarios in one easy sample.
35
36 Both apps also cover the Notifications being displayed on Wear 1.+ and/or Wear 2.0 and
37 using some of the new features of Wear 2.0 (inline actions).
38
39 [1]: https://developer.android.com/reference/android/support/v4/app/NotificationCompat.Style.html
40 [2]: https://developer.android.com/reference/android/support/v4/app/NotificationCompat.html
41 [3]: https://developer.android.com/reference/android/support/v4/app/NotificationCompat.BigTextStyle.html
42 [4]: https://developer.android.com/reference/android/support/v4/app/NotificationCompat.BigPictureStyle.html
43 [5]: https://developer.android.com/reference/android/support/v4/app/NotificationCompat.InboxStyle.html
44 [6]: https://developer.android.com/reference/android/support/v4/app/NotificationCompat.MessagingStyle.html
45
46 Pre-requisites
47 --------------
48
49 - Android SDK 25
50 - Android Build Tools v25.0.3
51 - Android Support Repository
52
53 Screenshots
54 -------------
55
56 <img src="screenshots/mobile-1.png" height="400" alt="Screenshot"/> <img src="screenshots/mobile-2.png" height="400" alt="Screenshot"/> <img src="screenshots/wear-1.png" height="400" alt="Screenshot"/> <img src="screenshots/wear-2.png" height="400" alt="Screenshot"/>
57
58 Getting Started
59 ---------------
60
61 This sample uses the Gradle build system. To build this project, use the
62 "gradlew build" command or use "Import Project" in Android Studio.
63
64 Support
65 -------
66
67 - Google+ Community: https://plus.google.com/communities/105153134372062985968
68 - Stack Overflow: http://stackoverflow.com/questions/tagged/android
69
70 If you've found an error in this sample, please file an issue:
71 https://github.com/googlesamples/android-WearNotifications
72
73 Patches are encouraged, and may be submitted by forking this project and
74 submitting a pull request through GitHub. Please see CONTRIBUTING.md for more details.
75
76 License
77 -------
78
79 Copyright 2017 The Android Open Source Project, Inc.
80
81 Licensed to the Apache Software Foundation (ASF) under one or more contributor
82 license agreements. See the NOTICE file distributed with this work for
83 additional information regarding copyright ownership. The ASF licenses this
84 file to you under the Apache License, Version 2.0 (the "License"); you may not
85 use this file except in compliance with the License. You may obtain a copy of
86 the License at
87
88 http://www.apache.org/licenses/LICENSE-2.0
89
90 Unless required by applicable law or agreed to in writing, software
91 distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
92 WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
93 License for the specific language governing permissions and limitations under
94 the License.
95