Class TextButton

TextButton

TextButton ที่มีป้ายกำกับข้อความ คุณสามารถตั้งค่าสีพื้นหลังและปิดใช้งานปุ่มได้เมื่อต้องการ

ใช้ได้กับส่วนเสริมของ Google Workspace และแอป Google Chat

var textButton = CardService.newTextButton()
    .setText("Open Link")
    .setOpenLink(CardService.newOpenLink()
        .setUrl("https://www.google.com"));

วิธีการ

วิธีการประเภทการแสดงผลรายละเอียดแบบย่อ
setAltText(altText)TextButtonตั้งค่าข้อความสำรองของปุ่มสำหรับการช่วยเหลือพิเศษ
setAuthorizationAction(action)TextButtonตั้งค่าการดำเนินการการให้สิทธิ์ซึ่งจะเปิด URL ไปยังขั้นตอนการให้สิทธิ์เมื่อมีการคลิกออบเจ็กต์
setBackgroundColor(backgroundColor)TextButtonตั้งค่าสีพื้นหลังสำหรับปุ่ม TextButtonStyle.FILLED
setComposeAction(action, composedEmailType)TextButtonตั้งค่าการทำงานที่เขียนอีเมลฉบับร่างเมื่อมีการคลิกออบเจ็กต์
setDisabled(disabled)TextButtonตั้งค่าว่าจะปิดใช้งานปุ่มหรือไม่
setOnClickAction(action)TextButtonตั้งค่าการทำงานที่จะดำเนินการเมื่อมีการคลิกออบเจ็กต์
setOnClickOpenLinkAction(action)TextButtonตั้งค่าการดำเนินการที่เปิด URL ในแท็บเมื่อมีการคลิกออบเจ็กต์
setOpenLink(openLink)TextButtonตั้งค่า URL ที่จะเปิดเมื่อมีการคลิกออบเจ็กต์
setText(text)TextButtonตั้งค่าข้อความที่จะแสดงบนปุ่ม
setTextButtonStyle(textButtonStyle)TextButtonตั้งค่ารูปแบบของปุ่ม

เอกสารโดยละเอียด

setAltText(altText)

ตั้งค่าข้อความสำรองของปุ่มสำหรับการช่วยเหลือพิเศษ หากไม่ได้ตั้งค่า ค่าเริ่มต้นจะเป็นข้อความที่แสดงบนปุ่ม

พารามิเตอร์

ชื่อประเภทคำอธิบาย
altTextStringข้อความสำรองที่จะกำหนดให้กับปุ่มนี้

รีเทิร์น

TextButton — ออบเจ็กต์นี้สำหรับการทำเชน


setAuthorizationAction(action)

ตั้งค่าการดำเนินการการให้สิทธิ์ซึ่งจะเปิด URL ไปยังขั้นตอนการให้สิทธิ์เมื่อมีการคลิกออบเจ็กต์ การดำเนินการนี้จะเปิด URL ในหน้าต่างใหม่ เมื่อผู้ใช้ทำตามขั้นตอนการให้สิทธิ์เสร็จสิ้นและกลับไปที่แอปพลิเคชันแล้ว ส่วนเสริมจะโหลดซ้ำ

ออบเจ็กต์ UI มีการตั้งค่า setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) หรือ setComposeAction(action, composedEmailType) ได้เพียงอย่างใดอย่างหนึ่งเท่านั้น

// ...

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
actionAuthorizationActionออบเจ็กต์ที่ระบุการดำเนินการการให้สิทธิ์ที่จะทำเมื่อมีการคลิกองค์ประกอบนี้

รีเทิร์น

TextButton — ออบเจ็กต์นี้สำหรับการทำเชน


setBackgroundColor(backgroundColor)

ตั้งค่าสีพื้นหลังสำหรับปุ่ม TextButtonStyle.FILLED หากไม่ได้ตั้งค่าปุ่ม TextButtonStyle.FILLED ปุ่มจะใช้สีรองที่กำหนดไว้ในไฟล์ Manifest ของส่วนเสริม วิธีนี้ไม่ใช่การดำเนินการสำหรับปุ่ม TextButtonStyle.OUTLINED

พารามิเตอร์

ชื่อประเภทคำอธิบาย
backgroundColorStringสีในรูปแบบ #rgb

รีเทิร์น

TextButton — ออบเจ็กต์นี้สำหรับการทำเชน


setComposeAction(action, composedEmailType)

ตั้งค่าการทำงานที่เขียนอีเมลฉบับร่างเมื่อมีการคลิกออบเจ็กต์ ออบเจ็กต์ UI มีการตั้งค่า setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) หรือ setComposeAction(action, composedEmailType) อย่างใดอย่างหนึ่งเท่านั้น

พารามิเตอร์ Action ต้องระบุฟังก์ชันเรียกกลับที่แสดงผลออบเจ็กต์ ComposeActionResponse ที่กำหนดค่าโดยใช้ ComposeActionResponseBuilder.setGmailDraft(draft)

// ...

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

// ...

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
actionActionออบเจ็กต์ที่ระบุการดำเนินการเขียนที่จะดำเนินการเมื่อมีการคลิกองค์ประกอบนี้
composedEmailTypeComposedEmailTypeค่า enum ที่ระบุว่าฉบับร่างที่เขียนเป็นฉบับร่างแบบสแตนด์อโลนหรือฉบับร่างของการตอบกลับ

รีเทิร์น

TextButton — ออบเจ็กต์นี้สำหรับการทำเชน


setDisabled(disabled)

ตั้งค่าว่าจะปิดใช้งานปุ่มหรือไม่ ปุ่มที่ปิดใช้จะเป็นสีเทาและไม่สามารถคลิกได้

พารามิเตอร์

ชื่อประเภทคำอธิบาย
disabledBooleanสถานะปิดใช้

รีเทิร์น

TextButton — ออบเจ็กต์นี้สำหรับการทำเชน


setOnClickAction(action)

ตั้งค่าการทำงานที่จะดำเนินการเมื่อมีการคลิกออบเจ็กต์ ออบเจ็กต์ UI มีการตั้งค่า setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) หรือ setComposeAction(action, composedEmailType) ได้เพียงอย่างใดอย่างหนึ่งเท่านั้น

พารามิเตอร์ Action ต้องระบุฟังก์ชันเรียกกลับที่แสดงผลออบเจ็กต์ ActionResponse

// ...

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
actionActionการดำเนินการที่จะทำเมื่อมีการคลิกองค์ประกอบนี้

รีเทิร์น

TextButton — ออบเจ็กต์นี้สำหรับการทำเชน


setOnClickOpenLinkAction(action)

ตั้งค่าการดำเนินการที่เปิด URL ในแท็บเมื่อมีการคลิกออบเจ็กต์ ใช้ฟังก์ชันนี้เมื่อจำเป็นต้องสร้าง URL หรือเมื่อคุณต้องดำเนินการอื่นๆ ในโปรแกรมเพิ่มเติมเพื่อสร้างออบเจ็กต์ OpenLink ออบเจ็กต์ UI มีการตั้งค่า setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) หรือ setComposeAction(action, composedEmailType) ได้เพียงอย่างใดอย่างหนึ่งเท่านั้น

พารามิเตอร์ Action ต้องระบุฟังก์ชันเรียกกลับที่แสดงผลออบเจ็กต์ ActionResponse ที่กำหนดค่าโดยใช้ ActionResponseBuilder.setOpenLink(openLink)

// ...

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
actionActionออบเจ็กต์ที่ระบุการทำงานของลิงก์แบบเปิดที่จะทำเมื่อมีการคลิกองค์ประกอบนี้

รีเทิร์น

TextButton — ออบเจ็กต์นี้สำหรับการทำเชน


ตั้งค่า URL ที่จะเปิดเมื่อมีการคลิกออบเจ็กต์ ใช้ฟังก์ชันนี้เมื่อทราบ URL อยู่แล้ว และจำเป็นต้องเปิดเท่านั้น ออบเจ็กต์ UI มีการตั้งค่า setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) หรือ setComposeAction(action, composedEmailType) ได้เพียงอย่างใดอย่างหนึ่งเท่านั้น

พารามิเตอร์

ชื่อประเภทคำอธิบาย
openLinkOpenLinkออบเจ็กต์ OpenLink ที่อธิบาย URL ที่จะเปิด

รีเทิร์น

TextButton — ออบเจ็กต์นี้สำหรับการทำเชน


setText(text)

ตั้งค่าข้อความที่จะแสดงบนปุ่ม

พารามิเตอร์

ชื่อประเภทคำอธิบาย
textStringข้อความที่ปรากฏบนปุ่ม

รีเทิร์น

TextButton — ออบเจ็กต์นี้สำหรับการทำเชน


setTextButtonStyle(textButtonStyle)

ตั้งค่ารูปแบบของปุ่ม หากไม่ได้ตั้งค่า ค่าเริ่มต้นจะเป็นปุ่ม TextButtonStyle.OUTLINED

พารามิเตอร์

ชื่อประเภทคำอธิบาย
textButtonStyleTextButtonStyleรูปแบบของปุ่ม

รีเทิร์น

TextButton — ออบเจ็กต์นี้สำหรับการทำเชน