تمت ترجمة هذه الصفحة بواسطة Cloud Translation API‏.

Class ImageButton

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

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

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

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

المعلمات

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

الإرجاع

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

المعلمات

الاسم	النوع	الوصف
`action`	`AuthorizationAction`	الكائن الذي يحدد إجراء التفويض الذي يجب اتخاذه عندما يكون هذا العنصر النقر عليه.

الإرجاع

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

`setComposeAction(action, composedEmailType)`

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

يجب أن تحدد المعلمة Action دالة استدعاء تعرض كائن ComposeActionResponse تم إعداده باستخدام ComposeActionResponseBuilder.setGmailDraft(draft).

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

// ...

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

المعلمات

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

الإرجاع

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

`setIcon(icon)`

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

المعلمات

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

الإرجاع

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

`setIconUrl(url)`

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

المعلمات

الاسم	النوع	الوصف
`url`	`String`	عنوان 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();
}

المعلمات

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

الإرجاع

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

المعلمات

الاسم	النوع	الوصف
`action`	`Action`	الكائن الذي يحدد إجراء الرابط المفتوح الذي يجب اتخاذه عندما يكون هذا العنصر النقر عليه.

الإرجاع

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

`setOpenLink(openLink)`

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

المعلمات

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

الإرجاع

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