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، سيستخدم الزر اللون الثانوي المحدّد في بيان الإضافة. هذه الطريقة لا تنفّذ أي عملية لأزرار 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 الذي ينشئ مسودات رسائل في "برمجة تطبيقات Google"، ويتم فتحها في 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	قيمة تعداد تحدّد ما إذا كانت المسودّة التي تم إنشاؤها مستقلة أو مسودّة ردّ.

الإرجاع

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	رمز Material Design

الإرجاع

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

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