Class KeyValue

المفتاحالقيمة

تمّ إيقاف هذا العمود نهائيًا. تم إيقاف هذه الفئة نهائيًا ويجب عدم استخدامها في النصوص البرمجية الجديدة.

تم إيقاف هذه الفئة نهائيًا. استخدِم DecoratedText بدلاً من ذلك.

الطُرق

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

الطرق المتوقّفة

الطريقة	نوع القيمة التي يتم عرضها	وصف قصير
setBottomLabel(text)	KeyValue	لضبط نص التصنيف لاستخدامه كمفتاح
setButton(button)	KeyValue	تُستخدَم لضبط Button الذي يتم عرضه على يسار السياق.
setContent(text)	KeyValue	لضبط النص الذي سيتم استخدامه كقيمة
setIcon(icon)	KeyValue	لضبط الرمز الذي سيتم استخدامه كمفتاح
setIconAltText(altText)	KeyValue	لضبط النص البديل للرمز
setIconUrl(url)	KeyValue	لضبط عنوان URL للرمز الذي سيتم استخدامه كمفتاح
setMultiline(multiline)	KeyValue	لضبط ما إذا كان يجب عرض نص القيمة على سطر واحد أو أسطر متعددة.
setSwitch(switchToSet)	KeyValue	لضبط Switch الذي يظهر على يسار المحتوى
setTopLabel(text)	KeyValue	لضبط نص التصنيف لاستخدامه كمفتاح

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

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

الإرجاع

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

---

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

الإرجاع

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

---

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

الإرجاع

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

---

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

الإرجاع

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

---

setOpenLink(openLink)

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

المعلمات

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

الإرجاع

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

الطرق المتوقّفة

setBottomLabel(text)

تمّ إيقاف هذا العمود نهائيًا. تم إيقاف هذه الدالة نهائيًا ويجب عدم استخدامها في النصوص البرمجية الجديدة.

لضبط نص التصنيف لاستخدامه كمفتاح يتم عرضها أسفل المحتوى النصي.

المعلمات

الاسم	النوع	الوصف
text	String	نص التصنيف. ملاحظة: لا يتيح تنسيق HTML الأساسي.

الإرجاع

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

---

setButton(button)

تمّ إيقاف هذا العمود نهائيًا. تم إيقاف هذه الدالة نهائيًا ويجب عدم استخدامها في النصوص البرمجية الجديدة.

تُستخدَم لضبط Button الذي يتم عرضه على يسار السياق. يمكن أن يضم KeyValue زرًا واحدًا أو مفتاحًا واحدًا أو رمزًا واحدًا فقط.

المعلمات

الاسم	النوع	الوصف
button	Button	زر الإضافة

الإرجاع

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

---

setContent(text)

تمّ إيقاف هذا العمود نهائيًا. تم إيقاف هذه الدالة نهائيًا ويجب عدم استخدامها في النصوص البرمجية الجديدة.

لضبط النص الذي سيتم استخدامه كقيمة أن تكون متوافقة مع تنسيق HTML الأساسي مطلوب.

المعلمات

الاسم	النوع	الوصف
text	String	محتوى النص لهذه الأداة.

الإرجاع

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

---

setIcon(icon)

تمّ إيقاف هذا العمود نهائيًا. تم إيقاف هذه الدالة نهائيًا ويجب عدم استخدامها في النصوص البرمجية الجديدة.

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

المعلمات

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

الإرجاع

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

---

setIconAltText(altText)

تمّ إيقاف هذا العمود نهائيًا. تم إيقاف هذه الدالة نهائيًا ويجب عدم استخدامها في النصوص البرمجية الجديدة.

لضبط النص البديل للرمز

المعلمات

الاسم	النوع	الوصف
altText	String	النص البديل للأيقونة

الإرجاع

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

---

setIconUrl(url)

تمّ إيقاف هذا العمود نهائيًا. تم إيقاف هذه الدالة نهائيًا ويجب عدم استخدامها في النصوص البرمجية الجديدة.

لضبط عنوان URL للرمز الذي سيتم استخدامه كمفتاح

المعلمات

الاسم	النوع	الوصف
url	String	عنوان URL لصورة مستضافة لاستخدامها كرمز

الإرجاع

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

---

setMultiline(multiline)

تمّ إيقاف هذا العمود نهائيًا. تم إيقاف هذه الدالة نهائيًا ويجب عدم استخدامها في النصوص البرمجية الجديدة.

لضبط ما إذا كان يجب عرض نص القيمة على سطر واحد أو أسطر متعددة.

المعلمات

الاسم	النوع	الوصف
multiline	Boolean	إعداد "السطور المتعددة"

الإرجاع

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

---

setSwitch(switchToSet)

تمّ إيقاف هذا العمود نهائيًا. تم إيقاف هذه الدالة نهائيًا ويجب عدم استخدامها في النصوص البرمجية الجديدة.

لضبط Switch الذي يظهر على يسار المحتوى يمكن أن يضم KeyValue زرًا واحدًا أو مفتاحًا واحدًا أو رمزًا واحدًا فقط.

المعلمات

الاسم	النوع	الوصف
switchToSet	Switch	مفتاح التبديل للإضافة

الإرجاع

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

---

setTopLabel(text)

تمّ إيقاف هذا العمود نهائيًا. تم إيقاف هذه الدالة نهائيًا ويجب عدم استخدامها في النصوص البرمجية الجديدة.

لضبط نص التصنيف لاستخدامه كمفتاح يتم عرضها أعلى المحتوى النصي.

المعلمات

الاسم	النوع	الوصف
text	String	نص التصنيف. ملاحظة: لا يتيح تنسيق HTML الأساسي.

الإرجاع

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