Class Chip

Khối

Chip có biểu tượng và nhãn văn bản. Bạn có thể huỷ kích hoạt khối này khi cần.

Chỉ dành cho ứng dụng Google Chat. Không dùng được cho các Tiện ích bổ sung của Google Workspace.

const chip = CardService.newChip()
                 .setLabel('Open Link')
                 .setOpenLink(CardService.newOpenLink().setUrl(
                     'https://www.google.com'));

Phương thức

Phương thứcLoại dữ liệu trả vềMô tả ngắn
setAltText(altText)ChipĐặt văn bản thay thế của khối cho khả năng hỗ trợ tiếp cận.
setAuthorizationAction(action)ChipĐặt một hành động uỷ quyền mở URL đến quy trình uỷ quyền khi người dùng nhấp vào đối tượng.
setComposeAction(action, composedEmailType)ChipĐặt một thao tác soạn email nháp khi người dùng nhấp vào đối tượng.
setDisabled(disabled)ChipThiết lập xem có tắt khối này hay không.
setIcon(icon)ChipĐặt biểu tượng sẽ được dùng làm khối.
setLabel(label)ChipĐặt tiêu đề của khối.
setOnClickAction(action)ChipThiết lập một thao tác thực thi khi đối tượng được nhấp vào.
setOnClickOpenLinkAction(action)ChipĐặt một thao tác mở URL trong thẻ khi đối tượng được nhấp vào.
setOpenLink(openLink)ChipĐặt URL mở ra khi đối tượng được nhấp vào.

Tài liệu chi tiết

setAltText(altText)

Đặt văn bản thay thế của khối cho khả năng hỗ trợ tiếp cận. Nếu không được đặt, giá trị mặc định sẽ là văn bản xuất hiện trên khối.

Thông số

TênLoạiMô tả
altTextStringVăn bản thay thế để chỉ định cho khối này.

Cầu thủ trả bóng

Chip – Đối tượng này, để tạo chuỗi.


setAuthorizationAction(action)

Đặt một hành động uỷ quyền mở URL đến quy trình uỷ quyền khi người dùng nhấp vào đối tượng. Thao tác này sẽ mở URL trong một cửa sổ mới. Khi người dùng hoàn tất quy trình uỷ quyền và quay lại ứng dụng, tiện ích bổ sung sẽ tải lại.

Một đối tượng giao diện người dùng chỉ có thể có một trong các tập hợp setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) hoặc setComposeAction(action, composedEmailType).

// ...

const action = CardService.newAuthorizationAction().setAuthorizationUrl('url');
CardService.newTextButton().setText('Authorize').setAuthorizationAction(action);

Thông số

TênLoạiMô tả
actionAuthorizationActionĐối tượng chỉ định hành động uỷ quyền cần thực hiện khi người dùng nhấp vào phần tử này.

Cầu thủ trả bóng

Chip – Đối tượng này, để tạo chuỗi.


setComposeAction(action, composedEmailType)

Đặt một thao tác soạn email nháp khi người dùng nhấp vào đối tượng. Một đối tượng giao diện người dùng chỉ có thể có một trong các tập hợp setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) hoặc setComposeAction(action, composedEmailType).

Tham số Action phải chỉ định một hàm gọi lại trả về đối tượng ComposeActionResponse được định cấu hình bằng ComposeActionResponseBuilder.setGmailDraft(draft).

// ...

const action = CardService.newAction().setFunctionName('composeEmailCallback');
CardService.newTextButton()
    .setText('Compose Email')
    .setComposeAction(action, CardService.ComposedEmailType.REPLY_AS_DRAFT);

// ...

function composeEmailCallback() {
  const thread = GmailApp.getThreadById(e.threadId);
  const draft = thread.createDraftReply('This is a reply');
  return CardService.newComposeActionResponseBuilder()
      .setGmailDraft(draft)
      .build();
}

Thông số

TênLoạiMô tả
actionActionĐối tượng chỉ định thao tác cần thực hiện khi người dùng nhấp vào phần tử này.
composedEmailTypeComposedEmailTypeGiá trị enum chỉ định liệu thư nháp đã soạn là thư độc lập hay thư trả lời.

Cầu thủ trả bóng

Chip – Đối tượng này, để tạo chuỗi.


setDisabled(disabled)

Thiết lập xem có tắt khối này hay không. Khối bị tắt sẽ chuyển sang màu xám và không thể nhấp vào.

const chip = CardService.newChip().setLabel('bug Report').setDisabled(true);

Thông số

TênLoạiMô tả
disabledBooleanTrạng thái bị vô hiệu hoá.

Cầu thủ trả bóng

Chip – Đối tượng này, để tạo chuỗi.


setIcon(icon)

Đặt biểu tượng sẽ được dùng làm khối.

const chip = CardService.newChip().setIcon(
    CardService.newIconImage().setMaterialIcon(
        CardService.newMaterialIcon().setName('bug_report'),
        ),
);

Thông số

TênLoạiMô tả
iconIconImageMột trong các giá trị IconImage được xác định trước.

Cầu thủ trả bóng

Chip – Đối tượng này, để tạo chuỗi.


setLabel(label)

Đặt tiêu đề của khối. Bắt buộc.

const chip = CardService.newChip().setLabel('bug Report');

Thông số

TênLoạiMô tả
labelStringVăn bản cần hiển thị.

Cầu thủ trả bóng

Chip – Đối tượng này, để tạo chuỗi.


setOnClickAction(action)

Đặt một thao tác thực thi khi người dùng nhấp vào đối tượng. Một đối tượng giao diện người dùng chỉ có thể có một trong các tập hợp setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) hoặc setComposeAction(action, composedEmailType).

Tham số Action phải chỉ định một hàm callback trả về đối tượng ActionResponse.

// ...

const action = CardService.newAction().setFunctionName('notificationCallback');
CardService.newTextButton()
    .setText('Create notification')
    .setOnClickAction(action);

// ...

function notificationCallback() {
  return CardService.newActionResponseBuilder()
      .setNotification(
          CardService.newNotification().setText('Some info to display to user'),
          )
      .build();
}

Thông số

TênLoạiMô tả
actionActionHành động cần thực hiện khi nhấp vào phần tử này.

Cầu thủ trả bóng

Chip – Đối tượng này để tạo chuỗi.


setOnClickOpenLinkAction(action)

Đặt một thao tác mở URL trong thẻ khi đối tượng được nhấp vào. Hãy dùng hàm này khi cần tạo URL hoặc khi bạn cần thực hiện các thao tác khác ngoài việc tạo đối tượng OpenLink. Mỗi đối tượng giao diện người dùng chỉ được có một trong các giá trị: setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) hoặc setComposeAction(action, composedEmailType).

Tham số Action phải chỉ định một hàm gọi lại trả về đối tượng ActionResponse được định cấu hình bằng ActionResponseBuilder.setOpenLink(openLink).

// ...

const action = CardService.newAction().setFunctionName('openLinkCallback');
CardService.newTextButton()
    .setText('Open Link')
    .setOnClickOpenLinkAction(action);

// ...

function openLinkCallback() {
  return CardService.newActionResponseBuilder()
      .setOpenLink(CardService.newOpenLink().setUrl('https://www.google.com'))
      .build();
}

Thông số

TênLoạiMô tả
actionActionĐối tượng chỉ định hành động mở đường liên kết cần thực hiện khi người dùng nhấp vào phần tử này.

Cầu thủ trả bóng

Chip – Đối tượng này để tạo chuỗi.


Đặt URL sẽ được mở khi đối tượng được nhấp vào. Sử dụng hàm này khi URL đã được biết và chỉ cần mở. Một đối tượng giao diện người dùng chỉ có thể có một trong các tập hợp setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) hoặc setComposeAction(action, composedEmailType).

Thông số

TênLoạiMô tả
openLinkOpenLinkĐối tượng OpenLink mô tả URL cần mở.

Cầu thủ trả bóng

Chip – Đối tượng này, để tạo chuỗi.