Class ImageButton

تنظيم صفحاتك في مجموعات يمكنك حفظ المحتوى وتصنيفه حسب إعداداتك المفضّلة.
ImageButton

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

var 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 لصورة لاستخدامها كرمز لهذا الزر.
setOnClickAction(action)ImageButtonضبط الإجراء الذي يتم تنفيذه عند النقر على العنصر.
setOnClickOpenLinkAction(action)ImageButtonضبط الإجراء الذي يفتح عنوان URL في علامة تبويب عند النقر على العنصر.
setOpenLink(openLink)ImageButtonضبط عنوان URL ليتم فتحه عند النقر على العنصر.

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

setAltText(altText)

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

المعلّمات

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

تذكرة ذهاب وعودة

ImageButton — هذا العنصر للسلاسل.


setAuthorizationAction(action)

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

يمكن أن يحتوي كائن واجهة مستخدم على مجموعة واحدة فقط من setOpenLink(openLink) أو setOnClickAction(action) أو setOnClickOpenLinkAction(action) أو setAuthorizationAction(action) أو setComposeAction(action, composedEmailType).

// ...

var 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).

// ...

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

المعلّمات

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

تذكرة ذهاب وعودة

ImageButton — هذا العنصر للسلاسل.


setIcon(icon)

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

المعلّمات

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

تذكرة ذهاب وعودة

ImageButton — هذا العنصر للسلاسل.


setIconUrl(url)

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

المعلّمات

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

تذكرة ذهاب وعودة

ImageButton — هذا العنصر للسلاسل.


setOnClickAction(action)

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

يجب أن تحدّد المعلمة Action دالة رد اتصال تعرض كائن 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();
}

المعلّمات

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

تذكرة ذهاب وعودة

ImageButton — هذا العنصر للسلاسل.


setOnClickOpenLinkAction(action)

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

يجب أن تتضمن المعلمة Action دالة رد اتصال تعرض كائن 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();
}

المعلّمات

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

تذكرة ذهاب وعودة

ImageButton — هذا العنصر للسلاسل.


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

المعلّمات

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

تذكرة ذهاب وعودة

ImageButton — هذا العنصر للسلاسل.