Class TextButton

TextButton

TextButton يتضمّن تصنيفًا نصيًا يمكنك ضبط لون الخلفية وإيقاف الزر عند الحاجة.

تتوفّر هذه الميزة لإضافات Google Workspace وتطبيقات Google Chat.

const 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	لتحديد ما إذا كان الزر غير مفعّل
setIcon(icon)	TextButton	لضبط رمز Icon محدّد مسبقًا لعرضه على الزر
setIconUrl(url)	TextButton	لضبط عنوان URL لصورة لاستخدامها كرمز لهذا الزر.
setMaterialIcon(icon)	TextButton	تُستخدَم لضبط رمز التصميم المتعدّد الأبعاد.
setOnClickAction(action)	TextButton	تُستخدَم لضبط إجراء يتم تنفيذه عند النقر على العنصر.
setOnClickOpenLinkAction(action)	TextButton	تُستخدَم لضبط إجراء يفتح عنوان URL في علامة تبويب عند النقر على العنصر.
setOpenLink(openLink)	TextButton	تُستخدَم لضبط عنوان URL ليتم فتحه عند النقر على العنصر.
setOverflowMenu(menu)	TextButton	لضبط قائمة منبثقة يتم فتحها عند النقر على العنصر.
setText(text)	TextButton	لضبط النص الذي يظهر على الزر
setTextButtonStyle(textButtonStyle)	TextButton	لضبط نمط الزر

مستندات تفصيلية

setAltText(altText)

تُستخدَم لضبط النص البديل للزر من أجل تسهيل الاستخدام. في حال عدم ضبطه، يتم ضبطه تلقائيًا على النص الذي يظهر على الزر.

المعلمات

الاسم	النوع	الوصف
altText	String	النص البديل الذي سيتمّ تعيينه لهذا الزرّ.

الإرجاع

TextButton: هذا العنصر، لإنشاء سلسلة.

---

setAuthorizationAction(action)

تُستخدَم لضبط إجراء تفويض يفتح عنوان URL يؤدي إلى مسار التفويض عند النقر على العنصر. يؤدي ذلك إلى فتح عنوان URL في نافذة جديدة. عندما ينتهي المستخدم من مسار التفويض ويعود إلى التطبيق، تتم إعادة تحميل الإضافة.

لا يمكن ضبط عنصر واجهة المستخدم إلا على أحد القيم التالية: 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	العنصر الذي يحدّد إجراء التفويض الذي يجب اتّخاذه عند النقر على هذا العنصر

الإرجاع

TextButton: هذا العنصر، لإنشاء سلسلة.

---

setBackgroundColor(backgroundColor)

لضبط لون خلفية الزر TextButtonStyle.FILLED. إذا لم يتم ضبط اللون الثانوي لزر TextButtonStyle.FILLED، سيستخدم الزر اللون الثانوي المحدَّد في manifest الإضافة. لا يمكن استخدام هذه الطريقة مع أزرار TextButtonStyle.OUTLINED.

المعلمات

الاسم	النوع	الوصف
backgroundColor	String	اللون بتنسيق #rgb

الإرجاع

TextButton: هذا العنصر، لإنشاء سلسلة.

---

setComposeAction(action, composedEmailType)

تُستخدَم لضبط إجراء ينشئ مسودة رسالة إلكترونية عند النقر على العنصر. يمكن أن يحتوي عنصر واجهة المستخدم على أحد العناصر التالية فقط: setOpenLink(openLink) أو setOnClickAction(action) أو setOnClickOpenLinkAction(action) أو setAuthorizationAction(action) أو setComposeAction(action, composedEmailType).

يجب أن تحدّد المَعلمة Action دالة ردّ اتصال تعرِض عنصر ComposeActionResponse تمّ إعداده باستخدام ComposeActionResponseBuilder.setGmailDraft(draft).

ملاحظة: لا تضبط هذه الطريقة إجراء إنشاء يُستخدَم لتوسيع واجهة مستخدم الإنشاء. بدلاً من ذلك، تربط هذه الطريقة عنصر واجهة المستخدم هذا بعنصر Action يُنشئ مسودات رسائل في Apps Script يتم فتحها في Gmail عند اكتمال الإجراء.

// ...

const action = CardService.newAction().setFunctionName('composeEmailCallback');
CardService.newTextButton()
    .setText('Compose Email')
    .setComposeAction(action, CardService.ComposedEmailType.REPLY_AS_DRAFT);

// ...

function composeEmailCallback() {
  const thread = GmailApp.getThreadById(e.threadId);
  const draft = thread.createDraftReply('This is a reply');
  return CardService.newComposeActionResponseBuilder()
      .setGmailDraft(draft)
      .build();
}

المعلمات

الاسم	النوع	الوصف
action	Action	العنصر الذي يحدّد إجراء الإنشاء الذي يجب اتّخاذه عند النقر على هذا العنصر
composedEmailType	ComposedEmailType	قيمة مصنّفة تحدد ما إذا كانت المسودة التي تم إنشاؤها هي مسودة مستقلة أو مسودة ردّ.

الإرجاع

TextButton: هذا العنصر، لإنشاء سلسلة.

---

setDisabled(disabled)

لتحديد ما إذا كان الزر غير مفعّل يكون الزر غير مفعّل باللون الرمادي ولا يمكن النقر عليه.

المعلمات

الاسم	النوع	الوصف
disabled	Boolean	الحالة "غير مفعّلة"

الإرجاع

TextButton: هذا العنصر، لإنشاء سلسلة.

---

setIcon(icon)

لضبط رمز Icon محدّد مسبقًا لعرضه على الزر يجب استخدام هذا الرمز أو setIconUrl(url) لتحديد صورة الزر.

المعلمات

الاسم	النوع	الوصف
icon	Icon	إحدى قيم Icon المحدّدة مسبقًا

الإرجاع

TextButton: هذا العنصر، لإنشاء سلسلة.

---

setIconUrl(url)

لضبط عنوان URL لصورة لاستخدامها كرمز لهذا الزر. يجب استخدام هذا الخيار أو setIcon(icon) لتحديد صورة الزر.

المعلمات

الاسم	النوع	الوصف
url	String	عنوان URL لصورة مستضافة لاستخدامها كرمز لهذا الزر

الإرجاع

TextButton: هذا العنصر، لإنشاء سلسلة.

---

setMaterialIcon(icon)

تُستخدَم لضبط رمز التصميم المتعدّد الأبعاد.

const textButton = CardService.newTextButton().setMaterialIcon(
    CardService.newMaterialIcon().setName('search'),
);

المعلمات

الاسم	النوع	الوصف
icon	MaterialIcon	رمز التصميم المتعدّد الأبعاد

الإرجاع

TextButton: هذا العنصر، لإنشاء سلسلة.

---

setOnClickAction(action)

تُستخدَم لضبط إجراء يتم تنفيذه عند النقر على العنصر. لا يمكن أن يتضمّن عنصر واجهة المستخدم سوى أحد الإعدادات التالية: setOpenLink(openLink) أو setOnClickAction(action) أو setOnClickOpenLinkAction(action) أو setAuthorizationAction(action) أو setComposeAction(action, composedEmailType).

يجب أن تحدّد المَعلمة Action دالة ردّ اتصال تعرِض عنصر 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	الإجراء الذي يتم اتّخاذه عند النقر على هذا العنصر.

الإرجاع

TextButton: هذا العنصر، لإنشاء سلسلة.

---

setOnClickOpenLinkAction(action)

تُستخدَم لضبط إجراء يفتح عنوان URL في علامة تبويب عند النقر على العنصر. استخدِم هذه الدالة عندما تحتاج إلى إنشاء عنوان URL أو عندما تحتاج إلى اتّخاذ إجراءات أخرى بالإضافة إلى إنشاء عنصر OpenLink. لا يمكن أن يتضمّن عنصر واجهة المستخدم سوى أحد القيم التالية: 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	العنصر الذي يحدّد إجراء فتح الرابط الذي يجب اتّخاذه عند النقر على هذا العنصر

الإرجاع

TextButton: هذا العنصر، لإنشاء سلسلة.

---

setOpenLink(openLink)

تُستخدَم لضبط عنوان URL ليتم فتحه عند النقر على العنصر. استخدِم هذه الدالة عندما يكون عنوان URL معروفًا ويحتاج فقط إلى فتحه. لا يمكن أن يتضمّن عنصر واجهة المستخدم سوى إحدى القيم التالية: setOpenLink(openLink) أو setOnClickAction(action) أو setOnClickOpenLinkAction(action) أو setAuthorizationAction(action) أو setComposeAction(action, composedEmailType).

المعلمات

الاسم	النوع	الوصف
openLink	OpenLink	عنصر OpenLink يصف عنوان URL المطلوب فتحه

الإرجاع

TextButton: هذا العنصر، لإنشاء سلسلة.

---

setOverflowMenu(menu)

لضبط قائمة منبثقة يتم فتحها عند النقر على العنصر. يمكن لكل عنصر في القائمة تحديد إجراء يتم تفعيله عند النقر عليه. لا تتوفّر القوائم المُدمَجة، ويجب ألّا تحدّد إجراءات عناصر القائمة قائمة كاملة.

لا تتوفّر هذه الميزة إلا لتطبيقات Google Chat. لا تتوفّر الإضافات في Google Workspace.

const overflowMenuItem =
    CardService.newOverflowMenuItem()
        .setStartIcon(
            CardService.newIconImage().setIconUrl(
                'https://www.google.com/images/branding/googleg/1x/googleg_standard_color_64dp.png',
                ),
            )
        .setText('Open Link')
        .setOpenLink(
            CardService.newOpenLink().setUrl('https://www.google.com'));

const overflowMenu =
    CardService.newOverflowMenu().addMenuItem(overflowMenuItem).build();

المعلمات

الاسم	النوع	الوصف
menu	OverflowMenu	العنصر الذي يحدّد القائمة الكاملة التي سيتم عرضها عند النقر على هذا العنصر

الإرجاع

TextButton: هذا العنصر، لإنشاء سلسلة.

---

setText(text)

لضبط النص الذي يظهر على الزر

المعلمات

الاسم	النوع	الوصف
text	String	النص الذي يظهر على الزر

الإرجاع

TextButton: هذا العنصر، لإنشاء سلسلة.

---

setTextButtonStyle(textButtonStyle)

لضبط نمط الزر وفي حال عدم ضبطه، يتم ضبطه تلقائيًا على الزر TextButtonStyle.OUTLINED.

const button =
    CardService.newTextButton()
        .setText('Filled')
        .setTextButtonStyle(CardService.TextButtonStyle.FILLED)
        .setOpenLink(CardService.newOpenLink().setUrl('www.google.com'));

المعلمات

الاسم	النوع	الوصف
textButtonStyle	TextButtonStyle	نمط الزر

الإرجاع

TextButton: هذا العنصر، لإنشاء سلسلة.