Class OverflowMenuItem

OverflowMenuItem

OverflowMenuItem مع رمز ونص ويمكنك إيقاف عنصر القائمة عند الحاجة.

لا تتوفّر هذه الميزة إلا لتطبيقات 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'));

الطُرق

الطريقةنوع القيمة التي يتم عرضهاوصف قصير
setAuthorizationAction(action)OverflowMenuItemتُستخدَم لضبط إجراء تفويض يفتح عنوان URL يؤدي إلى مسار التفويض عند النقر على العنصر.
setComposeAction(action, composedEmailType)OverflowMenuItemتُستخدَم لضبط إجراء ينشئ مسودة رسالة إلكترونية عند النقر على العنصر.
setDisabled(disabled)OverflowMenuItemلضبط ما إذا كان عنصر القائمة غير مفعّل
setOnClickAction(action)OverflowMenuItemتُستخدَم لضبط إجراء يتم تنفيذه عند النقر على العنصر.
setOnClickOpenLinkAction(action)OverflowMenuItemتُستخدَم لضبط إجراء يفتح عنوان URL في علامة تبويب عند النقر على العنصر.
setOpenLink(openLink)OverflowMenuItemتحدِّد هذه السياسة عنوان URL ليتم فتحه عند النقر على العنصر.
setStartIcon(icon)OverflowMenuItemلضبط الرمز الأول لعنصر القائمة
setText(text)OverflowMenuItemلضبط عنوان عنصر القائمة

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

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

الإرجاع

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


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قيمة تعداد تحدد ما إذا كانت المسودة التي تم إنشاؤها مستقلة أو مسودة رد.

الإرجاع

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


setDisabled(disabled)

لضبط ما إذا كان عنصر القائمة غير مفعّل يظهر العنصر غير مفعّل باللون الرمادي ولا يمكن النقر عليه.

المعلمات

الاسمالنوعالوصف
disabledBooleanحالة الإيقاف.

الإرجاع

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


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الإجراء الذي يتم اتّخاذه عند النقر على هذا العنصر.

الإرجاع

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


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العنصر الذي يحدّد إجراء فتح الرابط الذي يجب اتّخاذه عند النقر على هذا العنصر

الإرجاع

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


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

المعلمات

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

الإرجاع

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


setStartIcon(icon)

لضبط الرمز الأول لعنصر القائمة

المعلمات

الاسمالنوعالوصف
iconIconImageالرمز المطلوب عرضه

الإرجاع

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


setText(text)

لضبط عنوان عنصر القائمة. مطلوب.

المعلمات

الاسمالنوعالوصف
textStringالنص المراد عرضه

الإرجاع

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