Class DecoratedText

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

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

var decoratedText = CardService.newDecoratedText()
    .setText("Text")
    .setTopLabel("TopLabel");

var 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) ได้เพียง 1 รายการเท่านั้น

// ...

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

พารามิเตอร์

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

ไปกลับ

DecoratedText — เป็นออบเจ็กต์นี้เพื่อเป็นเชน


setBottomLabel(text)

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

พารามิเตอร์

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

ไปกลับ

DecoratedText — เป็นออบเจ็กต์นี้เพื่อเป็นเชน


setButton(button)

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

พารามิเตอร์

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

ไปกลับ

DecoratedText — เป็นออบเจ็กต์นี้เพื่อเป็นเชน


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 ที่จะระบุว่าแบบร่างการเขียนนั้นเป็นข้อความร่างแบบสแตนด์อโลนหรือการตอบกลับ

ไปกลับ

DecoratedText — เป็นออบเจ็กต์นี้เพื่อเป็นเชน


setEndIcon(endIcon)

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

พารามิเตอร์

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

ไปกลับ

DecoratedText — เป็นออบเจ็กต์นี้เพื่อเป็นเชน


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การดําเนินการที่ต้องทําเมื่อมีการคลิกองค์ประกอบนี้

ไปกลับ

DecoratedText — เป็นออบเจ็กต์นี้เพื่อเป็นเชน


setOnClickOpenLinkAction(action)

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

พารามิเตอร์ 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ออบเจ็กต์ที่ระบุการดําเนินการลิงก์แบบเปิดที่ต้องทําเมื่อมีการคลิกองค์ประกอบนี้

ไปกลับ

DecoratedText — เป็นออบเจ็กต์นี้เพื่อเป็นเชน


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

พารามิเตอร์

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

ไปกลับ

DecoratedText — เป็นออบเจ็กต์นี้เพื่อเป็นเชน


setStartIcon(startIcon)

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

พารามิเตอร์

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

ไปกลับ

DecoratedText — เป็นออบเจ็กต์นี้เพื่อเป็นเชน


setSwitchControl(switchToSet)

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

พารามิเตอร์

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

ไปกลับ

DecoratedText — เป็นออบเจ็กต์นี้เพื่อเป็นเชน


setText(text)

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

พารามิเตอร์

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

ไปกลับ

DecoratedText — เป็นออบเจ็กต์นี้เพื่อเป็นเชน


setTopLabel(text)

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

พารามิเตอร์

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

ไปกลับ

DecoratedText — เป็นออบเจ็กต์นี้เพื่อเป็นเชน


setWrapText(wrapText)

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

พารามิเตอร์

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

ไปกลับ

DecoratedText — เป็นออบเจ็กต์นี้เพื่อเป็นเชน