Class DecoratedText

DecoratedText

วิดเจ็ตที่แสดงข้อความพร้อมการตกแต่งที่ไม่บังคับ คีย์ที่เป็นไปได้ ได้แก่ ไอคอน ป้ายกำกับด้านบน และป้ายกำกับด้านล่าง การตั้งค่าเนื้อหาข้อความและคีย์ใดคีย์หนึ่งต้องใช้ setText(text) และ DecoratedText, DecoratedText, setTopLabel(text) หรือ setBottomLabel(text) ชั้นเรียนนี้มีไว้เพื่อแทนที่ KeyValue

พร้อมใช้งานสำหรับส่วนเสริมของ Google Workspace และแอป Google Chat

const decoratedText =
    CardService.newDecoratedText().setText('Text').setTopLabel('TopLabel');

const multilineDecoratedText = CardService.newDecoratedText()
                                   .setText('Text')
                                   .setTopLabel('TopLabel')
                                   .setWrapText(true)
                                   .setBottomLabel('BottomLabel');

เมธอด

วิธีการ	ประเภทการแสดงผล	รายละเอียดแบบย่อ
setAuthorizationAction(action)	DecoratedText	ตั้งค่าการดำเนินการให้สิทธิ์ซึ่งจะเปิด URL ไปยังขั้นตอนการให้สิทธิ์เมื่อมีการคลิกออบเจ็กต์
setBottomLabel(text)	DecoratedText	ตั้งค่าข้อความป้ายกำกับที่จะใช้เป็นคีย์และแสดงใต้เนื้อหาข้อความ
setButton(button)	DecoratedText	ตั้งค่า Button ที่แสดงทางด้านขวาของข้อความ
setComposeAction(action, composedEmailType)	DecoratedText	ตั้งค่าการดําเนินการที่เขียนอีเมลฉบับร่างเมื่อมีการคลิกวัตถุ
setEndIcon(endIcon)	DecoratedText	ตั้งค่า IconImage ที่ไม่บังคับซึ่งจะแสดงทางด้านขวาของเนื้อหา
setOnClickAction(action)	DecoratedText	ตั้งค่าการดำเนินการที่จะทำงานเมื่อมีการคลิกวัตถุ
setOnClickOpenLinkAction(action)	DecoratedText	ตั้งค่าการดําเนินการที่เปิด URL ในแท็บเมื่อมีการคลิกออบเจ็กต์
setOpenLink(openLink)	DecoratedText	ตั้งค่า URL ที่เปิดขึ้นเมื่อมีการคลิกออบเจ็กต์
setStartIcon(startIcon)	DecoratedText	ตั้งค่า IconImage (ไม่บังคับ) เพื่อแสดงก่อนเนื้อหาข้อความ
setSwitchControl(switchToSet)	DecoratedText	ตั้งค่า Switch ที่แสดงทางด้านขวาของเนื้อหา
setText(text)	DecoratedText	ตั้งค่าข้อความที่จะใช้เป็นค่า
setTopLabel(text)	DecoratedText	ตั้งค่าข้อความป้ายกำกับเพื่อใช้เป็นคีย์และแสดงเหนือเนื้อหาข้อความ
setWrapText(wrapText)	DecoratedText	ตั้งค่าว่าควรแสดงข้อความค่าในบรรทัดเดียวหรือหลายบรรทัด

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

setAuthorizationAction(action)

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

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

// ...

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

พารามิเตอร์

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

รีเทิร์น

DecoratedText — ออบเจ็กต์นี้สําหรับการต่อเชื่อม

---

setBottomLabel(text)

ตั้งค่าข้อความป้ายกำกับที่จะใช้เป็นคีย์และแสดงใต้เนื้อหาข้อความ

พารามิเตอร์

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

รีเทิร์น

DecoratedText — ออบเจ็กต์นี้สําหรับการต่อเชื่อม

---

setButton(button)

ตั้งค่า Button ที่แสดงทางด้านขวาของข้อความ DecoratedText รองรับปุ่มหรือสวิตช์ได้เพียง 1 ตัวเท่านั้น

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
button	Button	ปุ่มเพิ่ม

รีเทิร์น

DecoratedText — ออบเจ็กต์นี้สําหรับการต่อเชื่อม

---

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 เมื่อการดำเนินการเสร็จสมบูรณ์

// ...

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

// ...

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

พารามิเตอร์

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

รีเทิร์น

DecoratedText — ออบเจ็กต์นี้สําหรับการต่อเชื่อม

---

setEndIcon(endIcon)

ตั้งค่า IconImage ที่ไม่บังคับซึ่งจะแสดงทางด้านขวาของเนื้อหา DecoratedText รองรับปุ่ม สวิตช์ หรือไอคอนได้เพียงรายการเดียว

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
endIcon	IconImage	ไอคอนที่จะเพิ่ม

รีเทิร์น

DecoratedText — ออบเจ็กต์นี้สําหรับการต่อเชื่อม

---

setOnClickAction(action)

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

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

พารามิเตอร์

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

รีเทิร์น

DecoratedText — ออบเจ็กต์นี้สําหรับการต่อเชื่อม

---

setOnClickOpenLinkAction(action)

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

พารามิเตอร์ Action ต้องระบุฟังก์ชัน Callback ที่แสดงผลออบเจ็กต์ ActionResponse ที่กําหนดค่าโดยใช้ 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();
}

พารามิเตอร์

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

รีเทิร์น

DecoratedText — ออบเจ็กต์นี้สําหรับการต่อเชื่อม

---

setOpenLink(openLink)

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

พารามิเตอร์

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

รีเทิร์น

DecoratedText — ออบเจ็กต์นี้สําหรับการต่อเชื่อม

---

setStartIcon(startIcon)

ตั้งค่า IconImage (ไม่บังคับ) ให้แสดงก่อนเนื้อหาข้อความ

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
startIcon	IconImage	ไอคอนที่จะแสดง

รีเทิร์น

DecoratedText — ออบเจ็กต์นี้สําหรับการต่อเชื่อม

---

setSwitchControl(switchToSet)

ตั้งค่า Switch ที่แสดงทางด้านขวาของเนื้อหา DecoratedText รองรับปุ่มหรือสวิตช์ได้เพียงรายการเดียว

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
switchToSet	Switch	สวิตช์เพื่อเพิ่ม

รีเทิร์น

DecoratedText — ออบเจ็กต์นี้สําหรับการต่อเชื่อม

---

setText(text)

ตั้งค่าข้อความที่จะใช้เป็นค่า รองรับการจัดรูปแบบ HTML พื้นฐาน ต้องระบุ

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
text	String	เนื้อหาข้อความสําหรับวิดเจ็ตนี้

รีเทิร์น

DecoratedText — ออบเจ็กต์นี้สําหรับการต่อเชื่อม

---

setTopLabel(text)

ตั้งค่าข้อความป้ายกำกับเพื่อใช้เป็นคีย์และแสดงเหนือเนื้อหาข้อความ

พารามิเตอร์

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

รีเทิร์น

DecoratedText — ออบเจ็กต์นี้สําหรับการต่อเชื่อม

---

setWrapText(wrapText)

ตั้งค่าว่าควรแสดงข้อความค่าในบรรทัดเดียวหรือหลายบรรทัด

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
wrapText	Boolean	หากเป็น true ระบบจะตัดข้อความและแสดงหลายบรรทัด มิฉะนั้น ระบบจะตัดข้อความ

รีเทิร์น

DecoratedText — ออบเจ็กต์นี้สําหรับการต่อเชื่อม