xref: /aosp_15_r20/developers/build/prebuilts/gradle/MessagingService/README.md (revision d353a188ca6ec4b5eba25b5fbd7bcb8ce61322fb)
1*d353a188SXin Li
2*d353a188SXin LiAndroid MessagingService Sample
3*d353a188SXin Li===================================
4*d353a188SXin Li
5*d353a188SXin LiThis sample shows a simple service that sends notifications using
6*d353a188SXin LiNotificationCompat. It also extends the notification with Remote
7*d353a188SXin LiInput to allow Android N devices to reply via text directly from
8*d353a188SXin Lithe notification without having to open an App. The same Remote
9*d353a188SXin LiInput object also allows Android Auto users to respond by voice
10*d353a188SXin Liwhen the notification is presented there.
11*d353a188SXin LiNote: Each unread conversation from a user is sent as a distinct
12*d353a188SXin Linotification.
13*d353a188SXin Li
14*d353a188SXin LiIntroduction
15*d353a188SXin Li------------
16*d353a188SXin Li
17*d353a188SXin Li#### Checklist while building a messaging app that supports Android Auto:
18*d353a188SXin Li1. Ensure that Message notifications are extended using
19*d353a188SXin LiNotificationCompat.Builder.extend(new CarExtender()...)
20*d353a188SXin Li2. Declare a meta-data tag to your AndroidManifest.xml to specify that your app
21*d353a188SXin Liis automotive enabled.
22*d353a188SXin Li
23*d353a188SXin Liexample: AndroidManifest.xml
24*d353a188SXin Li
25*d353a188SXin Li```
26*d353a188SXin Li       <meta-data android:name="com.google.android.gms.car.application"
27*d353a188SXin Li                   android:resource="@xml/automotive_app_desc"/>
28*d353a188SXin Li```
29*d353a188SXin Li
30*d353a188SXin LiInclude the following to indicate that the application wants to show notifications on
31*d353a188SXin Lithe Android Auto overview screen.
32*d353a188SXin Li
33*d353a188SXin Liexample: res/xml/automotive\_app\_desc.xml
34*d353a188SXin Li```
35*d353a188SXin Li        <automotiveApp>
36*d353a188SXin Li            <uses name="notification"/>
37*d353a188SXin Li        </automotiveApp>
38*d353a188SXin Li```
39*d353a188SXin Li
40*d353a188SXin Li#### Flow
41*d353a188SXin LiMessagingFragment is shown to the user. Depending on the button clicked, the MessagingService is
42*d353a188SXin Lisent a message. MessagingService in turn creates notifications which can be viewed either on the
43*d353a188SXin Lidevice or in the messaging-simulator.
44*d353a188SXin Li
45*d353a188SXin LiWhen a message is read, the associated PendingIntent is triggered and MessageReadReceiver is called
46*d353a188SXin Liwith the appropriate conversationId. Similarly, when a reply is received, the MessageReplyReceiver
47*d353a188SXin Liis called with the appropriate conversationId. MessageLogger logs each event and shows them in a
48*d353a188SXin LiTextView in MessagingFragment for correlation.
49*d353a188SXin Li
50*d353a188SXin LiPre-requisites
51*d353a188SXin Li--------------
52*d353a188SXin Li
53*d353a188SXin Li- Android SDK 24
54*d353a188SXin Li- Android Build Tools v27.0.2
55*d353a188SXin Li- Android Support Repository
56*d353a188SXin Li
57*d353a188SXin LiScreenshots
58*d353a188SXin Li-------------
59*d353a188SXin Li
60*d353a188SXin Li<img src="screenshots/1-main.png" height="400" alt="Screenshot"/> <img src="screenshots/2-onemessage.png" height="400" alt="Screenshot"/> <img src="screenshots/3-threemessages.png" height="400" alt="Screenshot"/>
61*d353a188SXin Li
62*d353a188SXin LiGetting Started
63*d353a188SXin Li---------------
64*d353a188SXin Li
65*d353a188SXin LiThis sample uses the Gradle build system. To build this project, use the
66*d353a188SXin Li"gradlew build" command or use "Import Project" in Android Studio.
67*d353a188SXin Li
68*d353a188SXin LiSupport
69*d353a188SXin Li-------
70*d353a188SXin Li
71*d353a188SXin Li- Google+ Community: https://plus.google.com/communities/105153134372062985968
72*d353a188SXin Li- Stack Overflow: http://stackoverflow.com/questions/tagged/android
73*d353a188SXin Li
74*d353a188SXin LiIf you've found an error in this sample, please file an issue:
75*d353a188SXin Lihttps://github.com/googlesamples/android-MessagingService
76*d353a188SXin Li
77*d353a188SXin LiPatches are encouraged, and may be submitted by forking this project and
78*d353a188SXin Lisubmitting a pull request through GitHub. Please see CONTRIBUTING.md for more details.
79*d353a188SXin Li
80*d353a188SXin LiLicense
81*d353a188SXin Li-------
82*d353a188SXin Li
83*d353a188SXin LiCopyright 2017 The Android Open Source Project, Inc.
84*d353a188SXin Li
85*d353a188SXin LiLicensed to the Apache Software Foundation (ASF) under one or more contributor
86*d353a188SXin Lilicense agreements.  See the NOTICE file distributed with this work for
87*d353a188SXin Liadditional information regarding copyright ownership.  The ASF licenses this
88*d353a188SXin Lifile to you under the Apache License, Version 2.0 (the "License"); you may not
89*d353a188SXin Liuse this file except in compliance with the License.  You may obtain a copy of
90*d353a188SXin Lithe License at
91*d353a188SXin Li
92*d353a188SXin Lihttp://www.apache.org/licenses/LICENSE-2.0
93*d353a188SXin Li
94*d353a188SXin LiUnless required by applicable law or agreed to in writing, software
95*d353a188SXin Lidistributed under the License is distributed on an "AS IS" BASIS, WITHOUT
96*d353a188SXin LiWARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
97*d353a188SXin LiLicense for the specific language governing permissions and limitations under
98*d353a188SXin Lithe License.
99