Einer Android-App mit den Messaging- und People-APIs Chatfunktionen hinzufügen

1. Hinweis

Es ist schwierig, eine Messaging-App zu erstellen. Obwohl die Nutzererfahrung insgesamt subjektiv ist, bietet Android die Messaging- und People-APIs, die das Chat-Erlebnis verbessern und optimieren.

In diesem Codelab erfährst du, wie du mit diesen APIs eine faszinierende Umgebung für Chat-Apps unter Android schaffst. Sie erweitern die JetChat-App, eine einfache und nicht funktionsfähige Chat-App, die Jetpack Compose verwendet.

Vorbereitung

• Grundkenntnisse in der Android-Entwicklung
• Grundkenntnisse zu Benachrichtigungen

Inhalt

Eine erweiterte JetChat-App, die Folgendes ausführt:

• Zeigt Benachrichtigungen zu Unterhaltungen im Bereich für reservierte Unterhaltungen der Benachrichtigungsleiste an.
• Referenzen teilen in diesen Benachrichtigungen Ziele, die du in den Unterhaltungen deiner App teilen kannst.
• Erzwingt Best Practices zum Erstellen dieser Objekte, um die vom System bereitgestellten Standardfunktionen zur Optimierung Ihrer App zu nutzen.

Aufgaben in diesem Lab

• Benachrichtigungen zu Unterhaltungen im Bereich für reservierte Unterhaltungen der Benachrichtigungsleiste einblenden
• Informationen zu den verschiedenen Möglichkeiten, die durch die Messaging API und die People API ermöglicht werden

Voraussetzungen

• Git
• Android Studio
• Ein GitHub-Konto

2. Einrichten

Der Ausgangspunkt basiert auf der JetChat-App. Der Startcode erweitert die JetChat-App, um die Messaging- und People-APIs besser präsentieren zu können.

Startercode abrufen

So rufen Sie den Startcode für dieses Codelab ab:

1. Klonen Sie über die Befehlszeile das folgende GitHub-Repository:

git clone –branch starter-code \
https://github.com/android/people-messaging-codelab.git

2. Öffnen Sie das Projekt in Android Studio und klicken Sie dann auf App ausführen. Der Bereich Emulator mit der App wird eingeblendet.

Erweiterte JetChat App entdecken

1. Geben Sie im Textfeld Nachricht #composers der App eine Nachricht ein und tippen Sie dann auf Senden.
2. Verlassen Sie die App. Nach wenigen Sekunden erhalten Sie eine Push-Benachrichtigung mit einer Antwort von einem Chatteilnehmer.

Hinweis:Die Antwort stammt nicht von einer Person. Die App ist so programmiert, dass sie einen Chat simuliert.

3. Unterhaltungsbenachrichtigungen erstellen

Mit Android 11 wurden APIs eingeführt, die es ermöglichen, dass chatbezogene Benachrichtigungen in einem dafür vorgesehenen Abschnitt der Benachrichtigungsleiste angezeigt werden, was ausschließlich für Unterhaltungen vorgesehen ist.

Die Benachrichtigung muss zur Notification.MessagingStyle-Klasse gehören und auf eine langlebige Verknüpfung zum Teilen verweisen. In diesem Abschnitt erfahren Sie, wie Sie diese API-Anforderungen erfüllen, damit Benachrichtigungen angezeigt werden, die Unterhaltungen im Bereich „Unterhaltungen“ repräsentieren.

So richten Sie Benachrichtigungen für den NotificationCompat.MessagingStyle-Kurs ein:

1. Klicken Sie in Android Studio auf dem Tab Project (Projekt) auf app > java > com.example.compose.jetchat > conversation. Doppelklicken Sie dann auf ConversationFragment.
2. Suchen Sie in der Datei ConversationFragment.kt die Klasse ConversationFragment und dann den Codeblock Notification der createNotification-Funktion, in dem die Benachrichtigung erstellt wird.
3. Ersetzen Sie die Methode setContentText durch eine setStyle-Methode, die den Stil der Benachrichtigung auf die Klasse NotificationCompat.MessagingStyle festlegt. Diese Hilfsklasse fügt die mit der Methode setContextText festgelegte Nachricht mit zusätzlichem Kontext hinzu, der für die Nachricht relevant ist, z. B. die Zeit, zu der sie gesendet wurde, und die Person, die sie gesendet hat.

ConversationFragment.kt

private fun createNotification(
   notificationId: Int,
   message: Message,
   person: Person,
   shortcut: ShortcutInfoCompat,
   time: Long
): Notification? {
    ...
    .setStyle(NotificationCompat.MessagingStyle(person).addMessage(
                      NotificationCompat.MessagingStyle.Message(
                          message.content,
                          time,
                          person
                      )
    )
    )
    ...
    .build()
}

App ausführen

1. Starten Sie die App.
2. Geben Sie im Textfeld Nachricht #composers der App eine Nachricht ein und tippen Sie dann auf Senden.
3. Verlassen Sie die App. Sie erhalten wieder eine Push-Benachrichtigung, diese ist jedoch anders gestaltet. Sie enthält einen Avatar und einen individuellen Stil für die Nachricht. Es gibt jedoch noch einiges zu tun, bis deine Benachrichtigungen an der gewünschten Stelle angezeigt werden.

4. Freigabeziele für Unterhaltungen erstellen

Sie müssen in der Benachrichtigung auf eine Verknüpfung oder ein Freigabeziel verweisen. Freigabeziele werden in der Datei shortcuts.xml definiert und sind die Einstiegspunkte für die Verarbeitung programmatisch definierter Verknüpfungen. Die von dir erstellten Verknüpfungen repräsentieren die Unterhaltungen in der App und ermöglichen es dir, Inhalte in deinen Unterhaltungen zu teilen.

Hinweis:Sie erstellen Freigabeziele speziell für eingehende Nachrichten, die auf dem Gerät des Nutzers als Benachrichtigungen angezeigt werden. Sie sollten auch Freigabeziele für ausgehende Nachrichten erstellen. Diese werden in diesem Codelab jedoch nicht behandelt. Dieselben Schritte und Codebeispiele wie für gemeinsame Ziele für eingehende Nachrichten gelten jedoch auch für gemeinsame Ziele für ausgehende Nachrichten.

Freigabeziele definieren

1. Klicken Sie auf dem Tab Project (Projekt) mit der rechten Maustaste auf das Verzeichnis res und wählen Sie dann New > Verzeichnis.
2. Geben Sie in das Textfeld xml ein und drücken Sie dann Enter (oder return unter macOS).
3. Klicken Sie mit der rechten Maustaste auf das Verzeichnis xml und wählen Sie Datei aus.
4. Geben Sie in das Textfeld shortcuts.xml ein und drücken Sie dann Enter (oder return unter macOS).
5. Deklarieren Sie in der Datei shortcuts.xml das Freigabeziel , das die Freigabe von Daten vom Typ text/plain verwaltet:

shortcuts.xml

<shortcuts xmlns:android="http://schemas.android.com/apk/res/android">
  <share-target android:targetClass="com.example.compose.jetchat.NavActivity">
   <data android:mimeType="text/plain" />
   <category android:name="com.example.compose.jetchat.share.TEXT_SHARE_TARGET" />
 </share-target>
</shortcuts>

6. Klicken Sie auf dem Tab Projekt auf manifests und doppelklicken Sie dann auf AndroidManifest.xml.
7. Definieren Sie in der Datei AndroidManifest.xml die Datei shortcuts.xml:

AndroidManifest.xml

<manifest xmlns:android="http://schemas.android.com/apk/res/android"
    package="com.example.compose.jetchat">

   <application
        android:allowBackup="true"
        android:icon="@mipmap/ic_launcher"
        android:label="@string/app_name"
        android:supportsRtl="true"
        android:theme="@style/Theme.Jetchat.NoActionBar">
...
 <meta-data android:name="android.app.shortcuts"
            android:resource="@xml/shortcuts" />

    </application>
</manifest>

8. Definiere in der Komponente activity der Datei AndroidManifest.xml den Intent-Filter, der die Freigabelogik enthält:

AndroidManifest.xml

<manifest xmlns:android="http://schemas.android.com/apk/res/android"
   package="com.example.compose.jetchat">

   ...
       <activity
           ...
           <intent-filter>
               <action android:name="android.intent.action.SEND" />
               <category android:name="android.intent.category.DEFAULT" />
               <data android:mimeType="text/plain" />
           </intent-filter>
...

Tastenkombinationen festlegen

Für jede Benachrichtigung musst du die entsprechende Verknüpfung verknüpfen. Sie definieren nur ein eindeutiges Kürzel pro Konversation, da dieses für den Kontakt steht, mit dem Sie die Daten teilen möchten.

So erstellen Sie eine Verknüpfung:

1. Klicken Sie auf dem Tab Project (Projekt) auf app > java > com.example.compose.jetchat > conversation > util und dann doppelt auf ConversationUtil.
2. Fügen Sie in der Datei ConversationUtil.kt eine generateShortcut-Funktion hinzu:

ConversationUtil.kt

import android.content.Intent
import androidx.core.content.pm.ShortcutInfoCompat
import com.example.compose.jetchat.NavActivity

class ConversationUtil {

   companion object {
...
fun generateShortcut(context: Context, shortcutId: String): ShortcutInfoCompat {
   return ShortcutInfoCompat.Builder(context, shortcutId)
   .setCategories(setOf(CATEGORY_SHARE))
   .setLongLived(true)
   .setShortLabel(shortcutId)
   .setLongLabel(shortcutId)
   .setIntent(
       Intent(context, NavActivity::class.java)
           .setAction(Intent.ACTION_VIEW)
   )
   .build()
}

Diese Funktion enthält die für die Unterhaltung erforderlichen Methoden setPerson und setLongLived. Die Person ist der Kontakt, der mit der Verknüpfung verknüpft ist. Wenn Sie „Langlebig“ auf einen true-Wert festlegen, wird diese Verknüpfung vom System im Cache gespeichert und auf verschiedenen Oberflächen der Benutzeroberfläche angezeigt.

Verweisen Sie auf den Kurzbefehl in der Benachrichtigung.

Hinweis:Freigabeziele, die für ausgehende Nachrichten veröffentlicht wurden, sind nicht an eine Benachrichtigung gebunden, da ausgehende Nachrichten normalerweise keine Benachrichtigung für den Nutzer auslösen, der die Nachricht sendet.

Sie müssen in der Benachrichtigung auf die Freigabeverknüpfung verweisen. Sie müssen jedoch die Verknüpfung erstellen, bevor Sie die Benachrichtigung senden.

Führen Sie dazu die folgenden Schritte aus:

1. Suchen Sie in der Datei ConversationFragment.kt nach der Klasse ConversationFragment.
2. Erstellen Sie vor dem Aufruf der Variablen notification eine shortcut-Variable, die auf die aus ConversationUtil.generateShortcut generierte Tastenkombination verweist.
3. Ersetzen Sie in der Methode createNotification der Variablen notification den Parameter null durch die Variable shortcut als Parameter.

ConversationFragment.kt

private fun simulateResponseAsANotification() {
   ...
   if (message.author != "me") {
       ...
       val shortcut = ConversationUtil.generateShortcut(context!!, message.author)
       val notification = createNotification(notificationId, message, person, shortcut, time)
       ...
   }
}

4. Fügen Sie in der Methode createNotification die Methode NotificationCompat.Builder#setShortcutInfo hinzu und übergeben Sie dann die Variable shortcut als Parameter.

ConversationFragment.kt

private fun createNotification(
  notificatoinIf: Int,
  messagin: Message,
  person: Person,
  shortcut: ShortcutInfoCompat?,
  time: Long
): Notification {
...
return NotificationCompat.Builder(context!!,  ConversationUtil.CHANNEL_MESSAGES)
   ...
   .setShortcutInfo(shortcut)
   .build()
}

Hinweis:Mit der Methode NotificationCompat.Builder#setShortcutInfo wird auch die Klasse LocusId für die Tastenkombination festgelegt. Dies wird dringend empfohlen. Wenn Sie dann die verknüpfte Aktivität mit der Klasse LocusId annotieren, senden Sie Signale an die Informationen auf dem Gerät, dass die Verknüpfung mit dieser Unterhaltung verknüpft ist. Anhand dieser Signale wird die Unterhaltung entsprechend eingestuft. So wird sichergestellt, dass diese Unterhaltung basierend auf der Nutzeraktivität richtig angezeigt wird. Weitere Informationen finden Sie in den Best Practices.

Hinweis:Freigabeziele gelten nicht nur für Unterhaltungen. Sie können außerhalb von Unterhaltungen vorhanden sein. Weitere Informationen zu Freigabezielen finden Sie unter Sharing Shortcuts API.

Verknüpfung veröffentlichen

• Rufen Sie zum Veröffentlichen der Verknüpfung in der Funktion simulateResponseAsANotification vor der Methode notificationManager.notify die Methode pushDynamicShortcut auf:

ConversationFragment.kt

import androidx.core.content.pm.ShortcutManagerCompat

...private fun simulateResponseAsANotification() {
   ...
   if (message.author != "me") {
       ...
       ShortcutManagerCompat.pushDynamicShortcut(context!!, shortcut)
       ...
   }
}

Hinweis: Es gibt verschiedene Möglichkeiten, eine Verknüpfung zu veröffentlichen. Die pushDynamicShortcut-Methode verwendet jedoch die reportShorcutUsed API, die der Information auf dem Computer signalisiert, dass es sich um einen Kontakt handelt, der freigegeben werden soll. Die Methode pushDynamicShortcut sorgt außerdem dafür, dass Tastenkombinationen aktualisiert werden, ohne dass die maximale Anzahl der Tastenkombinationen erreicht werden muss.

Hinweis:Wenn Sie lange auf eine MessagingStyle-Benachrichtigung ohne eine entsprechende Verknüpfung drücken, wird angezeigt, dass die Unterhaltungsfunktionen nicht unterstützt werden. Mit einem verknüpften Kurzbefehl können Sie die Priorität und die Einstellungen für diese Benachrichtigung festlegen. Weitere Informationen finden Sie unter Testen von Unterhaltungsbenachrichtigungen und Tastenkombinationen.

App ausführen

1. Starten Sie die App.
2. Geben Sie im Textfeld Nachricht #composers der App eine Nachricht ein und tippen Sie dann auf Senden.
3. Verlassen Sie die App. Sie erhalten wieder eine Push-Benachrichtigung, aber diese ist individueller als unterhaltungsbezogene Benachrichtigung gestaltet. Das Avatarsymbol ist ausgeprägter und das App-Symbol ist integriert. Auch Absender, Uhrzeit und Text wurden optimiert.

5. Optional: Bubbles aktivieren

In Android 9 wurden Bubbles eingeführt, verbessert und umfunktioniert, um sie im Kontext von Unterhaltungen in Android 11 zu verwenden. Bubbles sind kreisförmige Overlays, die Avatare für deine Unterhaltungen sind. Sie werden im App Launcher angezeigt und ermöglichen es Ihnen, in einer maximierten Bubble ganz einfach auf Unterhaltungen zu antworten. Auch wenn die Funktion implementiert wurde, sind Bubbles noch optional – je nach Präferenz des Nutzers.

So aktivieren Sie Bubbles:

1. Fügen Sie in der Datei AndroidManifest.xml die Attribute allowEmbedded und resizeableActivity hinzu und legen Sie jedes Attribut auf einen Wert true fest:

AndroidManifest.xml

<activity
  ...
  android:allowEmbedded="true"
  android:resizeableActivity="true"
  ...
</activity>

2. Fügen Sie in der Klasse ConversationUtil der Datei ConversationUtil.kt die Metadaten der Bubble hinzu:

ConversationUtil.kt

import androidx.core.app.NotificationCompat
import androidx.core.graphics.drawable.IconCompat


fun createBubbleMetadata(context: Context, icon: IconCompat): NotificationCompat.BubbleMetadata {
        // Create bubble intent
        val target = Intent(context, NavActivity::class.java)
        val bubbleIntent = PendingIntent.getActivity(context, REQUEST_BUBBLE, target, flagUpdateCurrent(mutable = true))

        // Create bubble metadata
        return NotificationCompat.BubbleMetadata.Builder(bubbleIntent, icon)
            .setDesiredHeight(400)
            .setSuppressNotification(true)
            .build()
    }

3. Erstellen Sie in der Datei ConversationFragment.kt die Bubble-Metadaten und verweisen Sie auf diese:

ConversationFragment.kt

private fun createNotification(
  notificatoinIf: Int,
  messagin: Message,
  person: Person,
  shortcut: ShortcutInfoCompat?,
  time: Long
): Notification {
...
// Reference the bubble metadata in the notification.
  return NotificationCompat.Builder(context!!,     ConversationUtil.CHANNEL_MESSAGES)
    ...
     .setBubbleMetadata(ConversationUtil.createBubbleMetadata(context!!, person.icon!!))
...
    .build()
}

App ausführen

1. Starten Sie die App.
2. Geben Sie im Textfeld Nachricht #composers der App eine Nachricht ein und tippen Sie dann auf Senden.
3. Verlassen Sie die App. Nach wenigen Sekunden erhalten Sie vom Chat eine Benachrichtigung in Form einer Bubble.
4. Tippen Sie auf das Infofeld. Die Unterhaltung wird in der Bubble geöffnet.

6. Optional: Link teilen

Du hast Freigabeziele deklariert und in deinen Benachrichtigungen darauf verwiesen. Dadurch kann dein Kontakt auch im Sharesheet angezeigt werden. Dies ist eine Bottom-up-Komponente, die angezeigt wird, wenn ein ACTION-Intent gesendet wird. Inhalte zum Teilen werden oben auf dem Sharesheet angezeigt. So kannst du Rich Content in deinen Unterhaltungen teilen.

So rufst du das Sharesheet auf:

1. Öffnen Sie auf Ihrem Gerät Google Chrome und rufen Sie eine Webseite Ihrer Wahl auf, z. B. developer.android.com.
2. Klicken Sie, falls erforderlich, auf Mehr vert.
3. Klicken Sie auf Teilen. Das Sharesheet wird unten auf dem Bildschirm angezeigt.

4. Klicken Sie nach Möglichkeit auf JetChat. Die URL wird im Chat geteilt.
5. Wenn JetChat nicht angezeigt wird, klicken Sie auf Mehr, um das System-Sharesheet aufzurufen. Wischen Sie dann in ShareSheet nach oben und klicken Sie auf JetChat. Die URL wird im Chat geteilt.

Dies ist ein einfaches Beispiel. Es gibt umfangreichere Inhaltstypen, die Sie mit anderen teilen können. Weitere Informationen finden Sie unter Einfache Daten aus anderen Apps abrufen.

7. Glückwunsch

Glückwunsch! Jetzt wissen Sie, wie Sie einer Android-App mit der Messaging API und der People API chatbezogene Funktionen hinzufügen. Viel Spaß beim Messaging!

Weitere Informationen

• Emoji-Kompatibilität
• Rich Content
• PeopleManager-Klasse
• Personen und Unterhaltungen