Class ImageButton

ImageButton

ImageButton مع صورة معروضة عليه

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

const imageButton =
    CardService.newImageButton()
        .setAltText('An image button with an airplane icon.')
        .setIcon(CardService.Icon.AIRPLANE)
        .setOpenLink(CardService.newOpenLink().setUrl('https://airplane.com'));

الطُرق

الطريقةنوع القيمة التي يتم عرضهاوصف قصير
setAltText(altText)ImageButtonتُستخدَم لضبط النص البديل للزر من أجل تسهيل الاستخدام.
setAuthorizationAction(action)ImageButtonتُستخدَم لضبط إجراء تفويض يفتح عنوان URL يؤدي إلى مسار التفويض عند النقر على العنصر.
setComposeAction(action, composedEmailType)ImageButtonتُستخدَم لضبط إجراء ينشئ مسودة رسالة إلكترونية عند النقر على العنصر.
setIcon(icon)ImageButtonتضبط هذه السياسة قيمة Icon محدّدة مسبقًا لعرضها على الزر.
setIconUrl(url)ImageButtonلضبط عنوان URL لصورة لاستخدامها كرمز لهذا الزر.
setImageButtonStyle(imageButtonStyle)ImageButtonلضبط نمط الزر.
setMaterialIcon(icon)ImageButtonتُستخدَم لضبط رمز التصميم المتعدّد الأبعاد.
setOnClickAction(action)ImageButtonتُستخدَم لضبط إجراء يتم تنفيذه عند النقر على العنصر.
setOnClickOpenLinkAction(action)ImageButtonتُستخدَم لضبط إجراء يفتح عنوان URL في علامة تبويب عند النقر على العنصر.
setOpenLink(openLink)ImageButtonتحدِّد هذه السياسة عنوان URL ليتم فتحه عند النقر على العنصر.
setOverflowMenu(menu)ImageButtonلضبط قائمة منبثقة يتم فتحها عند النقر على العنصر.

الوثائق التفصيلية

setAltText(altText)

لضبط النص البديل للزر لسهولة الاستخدام. مطلوب.

المعلمات

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

الإرجاع

ImageButton — هذا الكائن يمكن استخدامه في التسلسل.


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

المعلمات

الاسمالنوعالوصف
actionAuthorizationActionالعنصر الذي يحدّد إجراء التفويض الذي يجب اتّخاذه عند النقر على هذا العنصر

الإرجاع

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


setComposeAction(action, composedEmailType)

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

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

// ...

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

المعلمات

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

الإرجاع

ImageButton — هذا الكائن يمكن استخدامه في التسلسل.


setIcon(icon)

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

المعلمات

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

الإرجاع

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


setIconUrl(url)

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

المعلمات

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

الإرجاع

ImageButton — هذا الكائن يمكن استخدامه في التسلسل.


setImageButtonStyle(imageButtonStyle)

لضبط نمط الزر وفي حال ترك هذه السياسة بدون ضبط، سيتم ضبطها تلقائيًا على الزر ImageButtonStyle.BORDERLESS.

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

const imageButton = CardService.newImageButton().setImageButtonStyle(
    CardService.ImageButtonStyle.BORDERLESS,
);

المعلمات

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

الإرجاع

ImageButton — هذا الكائن يمكن استخدامه في التسلسل.


setMaterialIcon(icon)

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

const imageButton = CardService.newImageButton().setMaterialIcon(
    CardService.newMaterialIcon().setName('search'),
);

المعلمات

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

الإرجاع

ImageButton — هذا الكائن يمكن استخدامه في التسلسل.


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

المعلمات

الاسمالنوعالوصف
actionActionالإجراء الذي يتم اتخاذه عند النقر على هذا العنصر.

الإرجاع

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


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

المعلمات

الاسمالنوعالوصف
actionActionالعنصر الذي يحدّد إجراء فتح الرابط الذي يجب اتّخاذه عند النقر على هذا العنصر

الإرجاع

ImageButton — هذا الكائن يمكن استخدامه في التسلسل.


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

المعلمات

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

الإرجاع

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


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

المعلمات

الاسمالنوعالوصف
menuOverflowMenuالكائن الذي يحدد القائمة الكاملة المراد عرضها عند النقر على هذا العنصر.

الإرجاع

ImageButton — هذا الكائن يمكن استخدامه في التسلسل.