Builder umum untuk objek Indexable

Stiker

Ini adalah ringkasan properti yang paling penting untuk disertakan saat mengindeks stiker atau paket stiker untuk diintegrasikan dengan Gboard. Lihat Contoh App Indexing di GitHub sebagai contoh.

Properti Deskripsi Contoh
name Nama atau kata kunci yang digunakan untuk penelusuran — tidak ditampilkan. "Paket Stiker Snoopy"
url URL yang menautkan ke stiker atau paket stiker dalam aplikasi. "http://sticker/pack/canonical/url/snoopy"
image Gambar stiker atau paket stiker. Untuk mendapatkan kualitas gambar yang optimal, gunakan gambar persegi berukuran 320 atau 500 piksel. "http://link/to/the/image/bye"
description Label aksesibilitas untuk paket stiker atau stiker Anda. "Satu paket stiker Snoopy"

Contoh: Paket stiker

// Build and index the sticker objects on first run after update or install
// to minimize lag between sticker install and stickers surfacing in Gboard.

FirebaseAppIndex.update(new Indexable.Builder("StickerPack")
   .setName("Snoopy Pack")
   .setImage("content://sticker/pack/canonical/image")
   // see: Support links to your app content section
   .setUrl("http://sticker/pack/canonical/url/snoopy")
   // Set the accessibility label for the sticker pack.
   .setDescription("A sticker pack of Snoopy")
   .put("hasSticker",
        new Indexable.Builder("Sticker")
          .setName("Hey")
          .setImage("http://link/to/the/image/hey")
          .setDescription("A Snoopy hey sticker.")
          .build(),
       new Indexable.Builder("Sticker")
          .setName("Bye")
          .setImage("http://link/to/the/image/bye")
          .setDescription("A Snoopy bye sticker.")
          .build())
   .build());

Contoh: Stiker individual

Indexable[] stickers = new Indexable[]{
      new Indexable.Builder("Sticker")
   .setName("Hey")
   .setImage("http://www.snoopysticker.com?id=1234")
   // see: Support links to your app content section
   .setUrl("http://sticker/canonical/image/hey")
   // Set the accessibility label for the sticker.
   .setDescription("A sticker for hi")
   // Add search keywords.
   .put("keywords", "hey", "snoopy", "hi", "hello")
   .put("isPartOf",
        new Indexable.Builder("StickerPack")
          .setName("Snoopy Pack"))
          .build())
   .build()),
new Indexable.Builder("Sticker")
   .setName("Bye")
   .setImage("http://www.snoopysticker.com?id=4567")
   // see: Support links to your app content section
   .setUrl("http://sticker/canonical/image/bye")
   // Set the accessibility label for the sticker.
   .setDescription("A sticker for Bye")
   // Add search keywords.
   .put("keywords", "bye", "snoopy", "see ya", "good bye")
   .put("isPartOf",
        new Indexable.Builder("StickerPack")
          .setName("Snoopy Pack")
          .build())
   .build())};
// Make sure we update stickers in batch
FirebaseAppIndex.update(stickers);

Pesan

Ini adalah ringkasan properti paling penting yang harus ditentukan oleh aplikasi saat mengindeks pesan.

Properti Deskripsi Contoh
url URL yang tertaut ke pesan dalam aplikasi. "myapp://messages/42"
name Baris subjek pesan, atau langsung pesan itu sendiri, jika tidak memiliki baris subjek terpisah. "Re: makan siang"
text Opsional. Isi pesan, jika ada. Untuk jenis pesan instan tanpa baris subjek terpisah, gunakan "name" (lihat di atas). "Apakah kamu punya waktu luang untuk makan siang?"
dateReceived Waktu saat pesan diterima, untuk pesan masuk. Tanggal baru(2016, 6, 2, 23, 43, 00)
dateSent Waktu pesan dikirim, untuk pesan keluar. Tanggal baru(2016, 6, 2, 23, 43, 00)
isPartOf.id ID untuk percakapan atau rangkaian pesan yang memiliki pesan tersebut. "42"
sender Pengirim pesan.
sender.name Nama pengirim. "Alice"
sender.url Opsional. URL yang tertaut ke orang dalam aplikasi. "http://example.net/profiles/alice"
sender.image Opsional. Gambar pengirim. URL web atau URI Konten dapat digunakan. "http://example.net/alice.jpg"
sender.email Opsional. Alamat email pengirim. "alice@example.net"
sender.telephone Opsional. Nomor telepon pengirim. "+16502530000"
sender.isSelf Indikasi apakah pengguna adalah pengirim. Secara default, nilainya adalah false. false
recipient Satu atau beberapa penerima pesan.
recipient.name Nama penerima. "Budi"
recipient.url Opsional. URL yang tertaut ke orang dalam aplikasi. "http://example.net/profiles/bob"
recipient.image Opsional. Gambar penerima. URL web atau URI Konten dapat digunakan. "http://example.net/bob.jpg"
recipient.email Opsional. Alamat email pengirim. "bagus@contoh.net"
recipient.telephone Opsional. Nomor telepon pengirim. "+16502530000"
recipient.isSelf Indikasi apakah pengguna adalah penerima. Secara default, nilainya adalah false. true
messageAttachment Opsional. Satu atau beberapa lampiran pada pesan.
messageAttachment.name Nama lampiran pada pesan. "Stiker"
messageAttachment.image Gambar yang mewakili lampiran. URL web atau URI Konten dapat digunakan. "http://example.net/stickers/23.png"

Contoh: Pesan masuk

Indexable message = Indexables.messageBuilder()
    .setUrl("myapp://messages/42")
    .setText("Are you free for lunch?")
    .setDateReceived(new Date(2016, 6, 2, 23, 44, 00))
    .setIsPartOf(Indexables.conversationBuilder().setId("42")
    .setSender(Indexables.personBuilder()
        .setName("Alice")
        .setImage("http://example.net/alice.jpg")
        .setEmail("alice@example.net")
        .setTelephone("+16502530000"))
    .setRecipient(Indexables.personBuilder()
        .setName("Bob")
        .setImage("http://example.net/bob.jpg")
        .setEmail("bob@people.net")
        .setTelephone("+16502530000")
        .setIsSelf(true))
    .build();
 

Untuk pesan email, gunakan Indexables.emailMessageBuilder(). Tidak ada pada isian yang didukung, namun UI hasilnya akan berbeda (mis. menyoroti baris subjek email).

Catatan

Ini adalah ringkasan properti paling penting yang harus ditentukan oleh aplikasi saat mengindeks catatan.

Properti Deskripsi Contoh
url URL yang tertaut ke catatan di aplikasi. "myapp://notes/42"
name Judul catatan, atau langsung teks catatan itu sendiri, jika tidak memiliki judul terpisah. "Daftar belanja"
text Opsional. Teks catatan, jika ada. Untuk catatan tanpa judul terpisah, gunakan "nama" (lihat di atas). "steak, pasta, anggur"
image Gambar yang mewakili catatan. URL web atau URI Konten dapat digunakan. "http://example.net/shopping.jpg" (hanya dalam bahasa Inggris)
dateCreated Waktu pembuatan catatan. Tanggal baru(2016, 6, 2, 23, 43, 00)
author Opsional. Penulis catatan.
author.name Nama penulis catatan. "Budi"

Contoh: Catatan

Indexable note = Indexables.noteDigitalDocumentBuilder()
    .setUrl("myapp://notes/42")
    .setName("Shopping list")
    .setText("steak, pasta, wine")
    .setImage("http://example.net/shopping.jpg")
    .setDateCreated(new Date(2016, 6, 2, 23, 43, 00))
    .build();