Class Chip

Chip

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

متاحة لتطبيقات Google Chat. في الإصدار التجريبي من إضافات Google Workspace

معاينة المطور: يتوفّر كجزء من برنامج الاستخدام المبكر في 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 الذي ينشئ مسودات رسائل في "برمجة تطبيقات Google"، ويتم فتحها في 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: هذا العنصر، للتسلسل