इंडेक्सेबल ऑब्जेक्ट के लिए सामान्य बिल्डर्स

स्टिकर

यह Gboard के साथ एकीकरण के लिए स्टिकर या स्टिकर पैक को अनुक्रमित करते समय शामिल करने के लिए सबसे महत्वपूर्ण गुणों का एक सिंहावलोकन है। उदाहरण के लिए Github पर ऐप इंडेक्सिंग नमूना देखें।

संपत्ति विवरण उदाहरण
name खोज के लिए उपयोग किया गया नाम या कीवर्ड - प्रदर्शित नहीं किया गया। "स्नूपी स्टिकर पैक"
url ऐप में स्टिकर या स्टिकर पैक से लिंक करने वाला यूआरएल। "http://sticker/pack/canonical/url/snoopy"
image स्टिकर या स्टिकर पैक ग्राफ़िक. इष्टतम छवि गुणवत्ता के लिए, 320 पिक्सेल या 500 पिक्सेल आकार की वर्गाकार छवियों का उपयोग करें। "http://link/to/the/image/bye"
description आपके स्टिकर या स्टिकर पैक के लिए एक्सेसिबिलिटी लेबल। "स्नूपी स्टिकर का एक पैकेट"

उदाहरण: स्टिकर पैक

// 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());

उदाहरण: व्यक्तिगत स्टिकर

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);

संदेश

यह उन सबसे महत्वपूर्ण गुणों का अवलोकन है जिन्हें किसी संदेश को अनुक्रमित करते समय ऐप द्वारा निर्दिष्ट किया जाना चाहिए।

संपत्ति विवरण उदाहरण
url ऐप में संदेश से लिंक करने वाला यूआरएल। "myapp://संदेश/42"
name संदेश की विषय पंक्ति, या सीधे संदेश ही, यदि इसमें कोई अलग विषय पंक्ति नहीं है। "पुन: दोपहर का भोजन"
text वैकल्पिक। संदेश का मुख्य भाग, यदि लागू हो। अलग विषय पंक्ति के बिना त्वरित संदेश प्रकार के संदेशों के लिए, "नाम" का उपयोग करें (ऊपर देखें)। "क्या आप दोपहर के भोजन के लिए स्वतंत्र हैं?"
dateReceived आने वाले संदेशों के लिए, संदेश प्राप्त होने का समय. नई तारीख(2016, 6, 2, 23, 43, 00)
dateSent आउटगोइंग संदेशों के लिए, संदेश भेजे जाने का समय. नई तारीख(2016, 6, 2, 23, 43, 00)
isPartOf.id उस वार्तालाप या थ्रेड के लिए एक आईडी जिसका संदेश हिस्सा है। "42"
sender संदेश भेजने वाला.
sender.name प्रेषक का नाम. "ऐलिस"
sender.url वैकल्पिक। ऐप में व्यक्ति को लिंक करने वाला यूआरएल। "http://example.net/profiles/alice"
sender.image वैकल्पिक। प्रेषक की एक छवि. या तो वेब यूआरएल या सामग्री यूआरआई का उपयोग किया जा सकता है। "http://example.net/alice.jpg"
sender.email वैकल्पिक। प्रेषक का ईमेल पता. "alice@example.net"
sender.telephone वैकल्पिक। प्रेषक का फ़ोन नंबर. "+16502530000"
sender.isSelf यह संकेत कि उपयोगकर्ता प्रेषक है या नहीं. डिफॉल्ट गलत है। असत्य
recipient संदेश के एक या एकाधिक प्राप्तकर्ता.
recipient.name प्राप्तकर्ता का नाम. "बॉब"
recipient.url वैकल्पिक। ऐप में व्यक्ति को लिंक करने वाला यूआरएल। "http://example.net/profiles/bob"
recipient.image वैकल्पिक। प्राप्तकर्ता की एक छवि. या तो वेब यूआरएल या सामग्री यूआरआई का उपयोग किया जा सकता है। "http://example.net/bob.jpg"
recipient.email वैकल्पिक। प्रेषक का ईमेल पता. "bob@example.net"
recipient.telephone वैकल्पिक। प्रेषक का फ़ोन नंबर. "+16502530000"
recipient.isSelf यह संकेत कि उपयोगकर्ता प्राप्तकर्ता है या नहीं। डिफॉल्ट गलत है। सत्य
messageAttachment वैकल्पिक। संदेश में एक या एकाधिक अनुलग्नक।
messageAttachment.name संदेश के अनुलग्नक का नाम. "स्टिकर"
messageAttachment.image अनुलग्नक का प्रतिनिधित्व करने वाली एक छवि. या तो वेब यूआरएल या सामग्री यूआरआई का उपयोग किया जा सकता है। "http://example.net/stickers/23.png"

उदाहरण: आने वाला संदेश

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();
 

ईमेल संदेशों के लिए, इसके बजाय Indexables.emailMessageBuilder() का उपयोग करें। समर्थित फ़ील्ड में कोई अंतर नहीं है, लेकिन परिणाम यूआई अलग होगा (उदाहरण के लिए ईमेल की विषय पंक्ति को हाइलाइट करना)।

टिप्पणी

यह उन सबसे महत्वपूर्ण गुणों का अवलोकन है जिन्हें किसी नोट को अनुक्रमित करते समय ऐप द्वारा निर्दिष्ट किया जाना चाहिए।

संपत्ति विवरण उदाहरण
url ऐप में नोट से लिंक करने वाला यूआरएल। "myapp://notes/42"
name नोट का शीर्षक, या सीधे नोट का पाठ, यदि इसका कोई अलग शीर्षक नहीं है। "खरीदारी की सूची"
text वैकल्पिक। नोट का पाठ, यदि लागू हो। बिना अलग शीर्षक वाले नोट्स के लिए, "नाम" का उपयोग करें (ऊपर देखें)। "स्टेक, पास्ता, वाइन"
image नोट का प्रतिनिधित्व करने वाली एक छवि. या तो वेब यूआरएल या सामग्री यूआरआई का उपयोग किया जा सकता है। "http://example.net/shopping.jpg"
dateCreated नोट का निर्माण समय. नई तारीख(2016, 6, 2, 23, 43, 00)
author वैकल्पिक। नोट के लेखक.
author.name नोट के लेखक का नाम. "बॉब"

उदाहरण: नोट

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();