Trình tạo phổ biến cho các đối tượng có thể lập chỉ mục

Hình dán

Đây là thông tin tổng quan về các thuộc tính quan trọng nhất cần đưa vào khi lập chỉ mục hình dán hoặc để tích hợp với Gboard. Xem Mẫu Lập chỉ mục ứng dụng trên GitHub.

Tài sản Mô tả Ví dụ
name Tên hoặc từ khóa dùng để tìm kiếm — không hiển thị. "Gói hình dán Snoopy"
url URL liên kết đến hình dán hoặc gói hình dán trong ứng dụng. "http://sstick/pack/canonical/url/snoopy"
image Hình dán hoặc gói hình dán. Để có chất lượng hình ảnh tối ưu, hãy sử dụng ảnh vuông có kích thước 320 500 pixel. "http://link/to/the/image/bye"
description Nhãn hỗ trợ tiếp cận cho hình dán hoặc gói hình dán. "Một gói hình dán Snoopy"

Ví dụ: Gói hình dán

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

Ví dụ: Hình dán cá nhân

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

Nội dung

Đây là thông tin tổng quan về các thuộc tính quan trọng nhất mà ứng dụng cần chỉ định khi lập chỉ mục một thông báo.

Tài sản Mô tả Ví dụ
url URL liên kết đến thông báo trong ứng dụng. "myapp://messages/42"
name Dòng chủ đề của thư hoặc trực tiếp chính thư, nếu không có dòng chủ đề riêng biệt. "V/v: bữa trưa"
text Không bắt buộc. Nội dung thư, nếu có. Đối với loại tin nhắn nhanh không có dòng chủ đề riêng, hãy sử dụng "name" (tên) (xem bên trên). "Bạn có rảnh ăn trưa không?"
dateReceived Thời gian nhận tin nhắn, cho tin nhắn đến. new Date(2016, 6, 2, 23, 43, 00)
dateSent Thời gian tin nhắn được gửi, đối với tin nhắn đi. new Date(2016, 6, 2, 23, 43, 00)
isPartOf.id Mã nhận dạng cho cuộc trò chuyện hoặc chuỗi thư có chứa thư này. "42"
sender Người gửi tin nhắn.
sender.name Tên người gửi. "Alice"
sender.url Không bắt buộc. URL liên kết đến người đó trong ứng dụng. "http://example.net/profiles/alice"
sender.image Không bắt buộc. Hình ảnh người gửi. Có thể sử dụng URL web hoặc URI nội dung. "http://example.net/alice.jpg"
sender.email Không bắt buộc. Địa chỉ email của người gửi. "alice@example.net"
sender.telephone Không bắt buộc. Số điện thoại của người gửi. "+16502530000"
sender.isSelf Cho biết người dùng có phải là người gửi hay không. Giá trị mặc định là "false". false
recipient Một hoặc nhiều người nhận thư.
recipient.name Tên của người nhận. "Bob"
recipient.url Không bắt buộc. URL liên kết đến người đó trong ứng dụng. "http://example.net/profiles/bob"
recipient.image Không bắt buộc. Hình ảnh người nhận. Có thể sử dụng URL web hoặc URI nội dung. "http://example.net/bob.jpg"
recipient.email Không bắt buộc. Địa chỉ email của người gửi. "bob@example.net"
recipient.telephone Không bắt buộc. Số điện thoại của người gửi. "+16502530000"
recipient.isSelf Cho biết người dùng có phải là người nhận hay không. Giá trị mặc định là "false". đúng
messageAttachment Không bắt buộc. Một hoặc nhiều tệp đính kèm vào thư.
messageAttachment.name Tên của tệp đính kèm vào thư. "Hình dán"
messageAttachment.image Hình ảnh đại diện cho tệp đính kèm. Có thể sử dụng URL web hoặc URI nội dung. "http://example.net/stickers/23.png"

Ví dụ: Tin nhắn đến

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

Đối với email, hãy sử dụng Indexables.emailMessageBuilder(). Không có trong các trường được hỗ trợ, nhưng giao diện người dùng kết quả sẽ khác (ví dụ: đánh dấu dòng tiêu đề của email).

Lưu ý

Đây là thông tin tổng quan về các thuộc tính quan trọng nhất mà ứng dụng cần chỉ định khi lập chỉ mục ghi chú.

Tài sản Mô tả Ví dụ
url URL liên kết đến ghi chú trong ứng dụng. "myapp://notes/42"
name Tiêu đề của ghi chú hoặc trực tiếp là văn bản ghi chú, nếu không có tiêu đề riêng biệt. "Danh sách mua sắm"
text Không bắt buộc. Nội dung của ghi chú, nếu có. Đối với các ghi chú không có tiêu đề riêng biệt, hãy dùng từ "name" (tên) (xem bên trên). "bít tết, mì ống, rượu vang"
image Hình ảnh thể hiện ghi chú. Có thể sử dụng URL web hoặc URI nội dung. "http://example.net/shopping.jpg"
dateCreated Thời gian tạo ghi chú. new Date(2016, 6, 2, 23, 43, 00)
author Không bắt buộc. Tác giả của ghi chú.
author.name Tên tác giả ghi chú. "Bob"

Ví dụ: Ghi chú

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