Class Chip

شريحة

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

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

const chip = CardService.newChip()
                 .setLabel('Open Link')
                 .setOpenLink(CardService.newOpenLink().setUrl(
                     'https://www.google.com'));

الطُرق

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

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

setAltText(altText)

لضبط النص البديل للشريحة من أجل تسهيل الاستخدام في حال عدم ضبط القيمة، يتم ضبطها تلقائيًا على النص الذي يظهر على الشريحة.

المعلَمات

الاسم	النوع	الوصف
altText	String	النص البديل الذي سيتمّ تعيينه لهذه الشريحة.

الإرجاع

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

---

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

الإرجاع

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

---

setComposeAction(action, composedEmailType)

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

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

ملاحظة: لا تضبط هذه الطريقة إجراء إنشاء يُستخدَم لتوسيع واجهة مستخدم الإنشاء. بدلاً من ذلك، تربط هذه الطريقة عنصر واجهة المستخدم هذا بعنصر Action يُنشئ مسودات رسائل في Apps Script يتم فتحها في 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	قيمة مصنّفة تحدد ما إذا كانت المسودة التي تم إنشاؤها هي مسودة مستقلة أو مسودة ردّ.

الإرجاع

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

---

setDisabled(disabled)

لضبط ما إذا كانت الشريحة غير مفعَّلة. تكون الشريحة غير مفعّلة باللون الرمادي ولا يمكن النقر عليها.

const chip = CardService.newChip().setLabel('bug Report').setDisabled(true);

المعلَمات

الاسم	النوع	الوصف
disabled	Boolean	الحالة "غير مفعّلة"

الإرجاع

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

---

setIcon(icon)

لضبط الرمز الذي سيتم استخدامه كشريحة.

const chip = CardService.newChip().setIcon(
    CardService.newIconImage().setMaterialIcon(
        CardService.newMaterialIcon().setName('bug_report'),
        ),
);

المعلَمات

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

الإرجاع

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

---

setLabel(label)

تُستخدَم لضبط عنوان الشريحة. مطلوب.

const chip = CardService.newChip().setLabel('bug Report');

المعلَمات

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

الإرجاع

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

---

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

الإرجاع

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

---

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

الإرجاع

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

---

setOpenLink(openLink)

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

المعلَمات

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

الإرجاع

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