Class TextButton

دکمه متن

یک TextButton با یک برچسب متنی. می توانید رنگ پس زمینه را تنظیم کنید و در صورت نیاز دکمه را غیرفعال کنید.

برای افزونه‌های Google Workspace و برنامه‌های Google Chat موجود است.

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)

متن جایگزین دکمه را برای دسترسی تنظیم می کند. اگر تنظیم نشده باشد، متنی که روی دکمه نمایش داده می‌شود پیش‌فرض است.

مولفه های

نام	تایپ کنید	شرح
altText	String	متن جایگزین برای اختصاص دادن به این دکمه.

برگشت

TextButton - این شیء برای زنجیر کردن.

---

setAuthorizationAction(action)

یک اقدام مجوز را تنظیم می کند که با کلیک روی شی، یک URL را به جریان مجوز باز می کند. این URL را در یک پنجره جدید باز می کند. هنگامی که کاربر جریان مجوز را تمام کرد و به برنامه بازگشت، افزونه بارگیری مجدد می شود.

یک شی UI فقط می تواند یکی از مجموعه های setOpenLink(openLink) ، setOnClickAction(action) ، setOnClickOpenLinkAction(action) ، setAuthorizationAction(action) یا setComposeAction(action, composedEmailType) داشته باشد.

// ...

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

مولفه های

نام	تایپ کنید	شرح
action	AuthorizationAction	شیئی که اقدام مجوزی را که باید هنگام کلیک روی این عنصر انجام شود را مشخص می کند.

برگشت

TextButton - این شیء برای زنجیر کردن.

---

setBackgroundColor(backgroundColor)

رنگ پس زمینه را برای دکمه TextButtonStyle.FILLED تنظیم می کند. اگر برای دکمه TextButtonStyle.FILLED تنظیم نشده باشد، دکمه از رنگ ثانویه تعریف شده در مانیفست افزودنی استفاده می کند. این روش برای دکمه های TextButtonStyle.OUTLINED بدون عملیات است.

مولفه های

نام	تایپ کنید	شرح
backgroundColor	String	رنگ با فرمت #rgb.

برگشت

TextButton - این شیء برای زنجیر کردن.

---

setComposeAction(action, composedEmailType)

اقدامی را تنظیم می‌کند که با کلیک روی شی، یک ایمیل پیش‌نویس می‌نویسد. یک شی UI فقط می تواند یکی از مجموعه های setOpenLink(openLink) ، setOnClickAction(action) ، setOnClickOpenLinkAction(action) ، setAuthorizationAction(action) یا setComposeAction(action, composedEmailType) داشته باشد.

پارامتر Action باید تابع callback را مشخص کند که یک شی ComposeActionResponse پیکربندی شده با استفاده از ComposeActionResponseBuilder.setGmailDraft(draft) را برمی گرداند.

توجه : این روش یک عملکرد نوشتن را تنظیم نمی کند که برای گسترش رابط کاربری نوشتن استفاده می شود. در عوض، این روش این عنصر رابط کاربری را به یک 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	شیئی که عمل compose را مشخص می کند که هنگام کلیک روی این عنصر انجام شود.
composedEmailType	ComposedEmailType	یک مقدار enum که مشخص می کند پیش نویس تشکیل شده یک پیش نویس مستقل است یا پاسخ.

برگشت

TextButton - این شیء برای زنجیر کردن.

---

setDisabled(disabled)

تنظیم می کند که آیا دکمه غیرفعال باشد. یک دکمه غیرفعال خاکستری است و نمی توان روی آن کلیک کرد.

مولفه های

نام	تایپ کنید	شرح
disabled	Boolean	حالت معلول

برگشت

TextButton - این شیء برای زنجیر کردن.

---

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	اقدامی که هنگام کلیک روی این عنصر انجام می شود.

برگشت

TextButton - این شیء برای زنجیر کردن.

---

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	شیئی که عمل پیوند باز را مشخص می کند که هنگام کلیک روی این عنصر انجام شود.

برگشت

TextButton - این شیء برای زنجیر کردن.

---

setOpenLink(openLink)

یک URL را تنظیم می کند که با کلیک روی شیء باز شود. از این تابع زمانی استفاده کنید که URL از قبل شناخته شده باشد و فقط باید باز شود. یک شی UI فقط می تواند یکی از مجموعه های setOpenLink(openLink) ، setOnClickAction(action) ، setOnClickOpenLinkAction(action) ، setAuthorizationAction(action) یا setComposeAction(action, composedEmailType) داشته باشد.

مولفه های

نام	تایپ کنید	شرح
openLink	OpenLink	یک شی OpenLink که URL مورد نظر را برای باز کردن توصیف می کند.

برگشت

TextButton - این شیء برای زنجیر کردن.

---

setText(text)

متنی که روی دکمه نمایش داده می شود را تنظیم می کند.

مولفه های

نام	تایپ کنید	شرح
text	String	متنی که روی دکمه ظاهر می شود.

برگشت

TextButton - این شیء برای زنجیر کردن.

---

setTextButtonStyle(textButtonStyle)

سبک دکمه را تنظیم می کند. اگر تنظیم نشود، به طور پیش‌فرض روی دکمه TextButtonStyle.OUTLINED قرار می‌گیرد.

مولفه های

نام	تایپ کنید	شرح
textButtonStyle	TextButtonStyle	سبک دکمه.

برگشت

TextButton - این شیء برای زنجیر کردن.