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)

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

พารามิเตอร์

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

รีเทิร์น

TextButton — ออบเจ็กต์นี้สำหรับการทำห่วงโซ่

---

setAuthorizationAction(action)

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

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

// ...

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

พารามิเตอร์

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

รีเทิร์น

TextButton — ออบเจ็กต์นี้สำหรับการทำห่วงโซ่

---

setBackgroundColor(backgroundColor)

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

พารามิเตอร์

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

รีเทิร์น

TextButton — ออบเจ็กต์นี้สำหรับการทำห่วงโซ่

---

setComposeAction(action, composedEmailType)

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

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

หมายเหตุ: วิธีนี้ไม่ได้ตั้งค่าการดำเนินการเขียนที่ ใช้เพื่อขยาย UI การเขียน แต่วิธีนี้จะเชื่อมต่อองค์ประกอบ UI นี้กับ Action ที่เขียนข้อความฉบับร่างใน Apps Script ที่ เปิดใน Gmail เมื่อการดำเนินการเสร็จสิ้น

// ...

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

พารามิเตอร์

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

รีเทิร์น

TextButton — ออบเจ็กต์นี้สำหรับการทำห่วงโซ่

---

setDisabled(disabled)

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

พารามิเตอร์

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

รีเทิร์น

TextButton — ออบเจ็กต์นี้สำหรับการทำห่วงโซ่

---

setOnClickAction(action)

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

พารามิเตอร์ Action ต้องระบุฟังก์ชัน Callback ที่ส่งคืนออบเจ็กต์ 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();
}

พารามิเตอร์

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

รีเทิร์น

TextButton — ออบเจ็กต์นี้สำหรับการทำห่วงโซ่

---

setOnClickOpenLinkAction(action)

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

พารามิเตอร์ Action ต้องระบุฟังก์ชัน Callback ที่ส่งคืนออบเจ็กต์ 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();
}

พารามิเตอร์

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

รีเทิร์น

TextButton — ออบเจ็กต์นี้สำหรับการทำห่วงโซ่

---

setOpenLink(openLink)

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

พารามิเตอร์

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

รีเทิร์น

TextButton — ออบเจ็กต์นี้สำหรับการทำห่วงโซ่

---

setText(text)

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

พารามิเตอร์

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

รีเทิร์น

TextButton — ออบเจ็กต์นี้สำหรับการทำห่วงโซ่

---

setTextButtonStyle(textButtonStyle)

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

พารามิเตอร์

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

รีเทิร์น

TextButton — ออบเจ็กต์นี้สำหรับการทำห่วงโซ่