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

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

เมธอด

วิธีการ	ประเภทการแสดงผล	รายละเอียดแบบย่อ
`addEventAction(eventAction)`	`Widget`	เพิ่มการดำเนินการของเหตุการณ์ที่ทำได้ในวิดเจ็ต
`setAuthorizationAction(action)`	`DecoratedText`	ตั้งค่าการดำเนินการให้สิทธิ์ที่จะเปิด URL ไปยังโฟลว์การให้สิทธิ์เมื่อมีการคลิกออบเจ็กต์
`setBottomLabel(text)`	`DecoratedText`	ตั้งค่าข้อความป้ายกำกับที่จะใช้เป็นคีย์และแสดงใต้เนื้อหาข้อความ
`setButton(button)`	`DecoratedText`	กำหนด `Button` ที่แสดงทางด้านขวาของข้อความ
`setComposeAction(action, composedEmailType)`	`DecoratedText`	ตั้งค่าการทำงานที่เขียนอีเมลฉบับร่างเมื่อมีการคลิกออบเจ็กต์
`setEndIcon(endIcon)`	`DecoratedText`	กำหนด `IconImage` ที่ไม่บังคับซึ่งแสดงทางด้านขวาของเนื้อหา
`setId(id)`	`Widget`	กำหนดรหัสที่ไม่ซ้ำกันที่กำหนดให้ซึ่งใช้ระบุวิดเจ็ตที่จะเปลี่ยน
`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`	กำหนดข้อความป้ายกำกับที่จะใช้เป็นคีย์และแสดงเหนือเนื้อหาข้อความ
`setVisibility(visibility)`	`Widget`	ตั้งค่าระดับการมองเห็นของวิดเจ็ต
`setWrapText(wrapText)`	`DecoratedText`	กำหนดว่าจะให้ข้อความค่าแสดงในบรรทัดเดียวหรือหลายบรรทัด

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

`addEventAction(eventAction)`

เพิ่มการดำเนินการของเหตุการณ์ที่ทำได้ในวิดเจ็ต

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
`eventAction`	`EventAction`	`EventAction` ที่จะเพิ่ม

รีเทิร์น

Widget — ออบเจ็กต์สำหรับการเชื่อมโยง

`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 รองรับปุ่มหรือสวิตช์ได้เพียงอย่างเดียว

พารามิเตอร์

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

รีเทิร์น

DecoratedText - ออบเจ็กต์นี้สำหรับการเชื่อมโยง

`setComposeAction(action, composedEmailType)`

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

พารามิเตอร์ Action ต้องระบุฟังก์ชันเรียกกลับที่แสดงผลออบเจ็กต์ 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 - ออบเจ็กต์นี้สำหรับการเชื่อมโยง

`setId(id)`

กำหนดรหัสที่ไม่ซ้ำกันที่กำหนดให้ซึ่งใช้ระบุวิดเจ็ตที่จะเปลี่ยน การเปลี่ยนแปลงวิดเจ็ต รองรับเฉพาะในส่วนเสริม

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
`id`	`String`	รหัสของวิดเจ็ต โดยมีความยาวได้ไม่เกิน 64 อักขระและอยู่ในรูปแบบ `[a-zA-Z0-9-]+`

รีเทิร์น

Widget - ออบเจ็กต์นี้สำหรับการเชื่อมโยง

`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 ต้องระบุฟังก์ชันเรียกกลับที่แสดงผลออบเจ็กต์ 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 จะตั้งค่าได้เพียงอย่างใดอย่างหนึ่งระหว่าง 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 - ออบเจ็กต์นี้สำหรับการเชื่อมโยง

`setVisibility(visibility)`

ตั้งค่าระดับการมองเห็นของวิดเจ็ต ค่าเริ่มต้นคือ `VISIBLE`

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
`visibility`	`Visibility`	`Visibility` ของวิดเจ็ต

รีเทิร์น

Widget — ออบเจ็กต์สำหรับการเชื่อมโยง

`setWrapText(wrapText)`

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

พารามิเตอร์

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

รีเทิร์น

DecoratedText - ออบเจ็กต์นี้สำหรับการเชื่อมโยง

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

เมธอด

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

addEventAction(eventAction)

พารามิเตอร์

รีเทิร์น

setAuthorizationAction(action)

พารามิเตอร์

รีเทิร์น

setBottomLabel(text)

พารามิเตอร์

รีเทิร์น

setButton(button)

พารามิเตอร์

รีเทิร์น

setComposeAction(action, composedEmailType)

พารามิเตอร์

รีเทิร์น

setEndIcon(endIcon)

พารามิเตอร์

รีเทิร์น

setId(id)

พารามิเตอร์

รีเทิร์น

setOnClickAction(action)

พารามิเตอร์

รีเทิร์น

setOnClickOpenLinkAction(action)

พารามิเตอร์

รีเทิร์น

setOpenLink(openLink)

พารามิเตอร์

รีเทิร์น

setStartIcon(startIcon)

พารามิเตอร์

รีเทิร์น

setSwitchControl(switchToSet)

พารามิเตอร์

รีเทิร์น

setText(text)

พารามิเตอร์

รีเทิร์น

setTopLabel(text)

พารามิเตอร์

รีเทิร์น

setVisibility(visibility)

พารามิเตอร์

รีเทิร์น

setWrapText(wrapText)

พารามิเตอร์

รีเทิร์น

Class DecoratedText

`addEventAction(eventAction)`

`setAuthorizationAction(action)`

`setBottomLabel(text)`

`setButton(button)`

`setComposeAction(action, composedEmailType)`

`setEndIcon(endIcon)`

`setId(id)`

`setOnClickAction(action)`

`setOnClickOpenLinkAction(action)`

`setOpenLink(openLink)`

`setStartIcon(startIcon)`

`setSwitchControl(switchToSet)`

`setText(text)`

`setTopLabel(text)`

`setVisibility(visibility)`

`setWrapText(wrapText)`