หน้านี้ได้รับการแปลโดย Cloud Translation API

Class DecoratedText

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

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

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

พารามิเตอร์

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

รีเทิร์น

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

`setBottomLabel(text)`

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

พารามิเตอร์

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

รีเทิร์น

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

`setButton(button)`

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

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
`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 เมื่อการดำเนินการเสร็จสิ้น

// ...

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

รีเทิร์น

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

`setEndIcon(endIcon)`

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

พารามิเตอร์

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

รีเทิร์น

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

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

รีเทิร์น

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

`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 ที่จะทำเมื่อองค์ประกอบนี้ คลิกแล้ว

รีเทิร์น

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

`setOpenLink(openLink)`

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

พารามิเตอร์

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

รีเทิร์น

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

`setStartIcon(startIcon)`

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

พารามิเตอร์

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

รีเทิร์น

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

`setSwitchControl(switchToSet)`

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

พารามิเตอร์

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

รีเทิร์น

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

`setText(text)`

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

พารามิเตอร์

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

รีเทิร์น

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

`setTopLabel(text)`

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

พารามิเตอร์

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

รีเทิร์น

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

`setWrapText(wrapText)`

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

พารามิเตอร์

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

รีเทิร์น

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