Class TextButton

ปุ่มข้อความ

TextButton ที่มีป้ายกํากับข้อความ คุณสามารถกําหนดสีพื้นหลังและปิดใช้งานปุ่ม ได้เมื่อจําเป็น

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)

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

พารามิเตอร์

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

ไปกลับ

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

พารามิเตอร์

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

ไปกลับ

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


setBackgroundColor(backgroundColor)

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
backgroundColorStringสีในรูปแบบ #เจ้าหน้าที่

ไปกลับ

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


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

ไปกลับ

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


setDisabled(disabled)

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

พารามิเตอร์

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

ไปกลับ

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


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

ไปกลับ

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


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

ไปกลับ

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


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

พารามิเตอร์

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

ไปกลับ

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


setText(text)

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

พารามิเตอร์

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

ไปกลับ

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


setTextButtonStyle(textButtonStyle)

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

พารามิเตอร์

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

ไปกลับ

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