Class DecoratedText

DecoratedText

تطبيق مصغّر يعرض نصًا مع زخارف اختيارية تشمل المفاتيح المحتملة رمزًا وتصنيفًا أعلى وتصنيفًا أسفل. يجب ضبط المحتوى النصي وأحد المفاتيح باستخدام setText(text) وأحد DecoratedText أو DecoratedText أو setTopLabel(text) أو setBottomLabel(text). تم تصميم هذه الفئة لاستبدال KeyValue.

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

const decoratedText =
    CardService.newDecoratedText().setText('Text').setTopLabel('TopLabel');

const multilineDecoratedText = CardService.newDecoratedText()
                                   .setText('Text')
                                   .setTopLabel('TopLabel')
                                   .setWrapText(true)
                                   .setBottomLabel('BottomLabel');

الطُرق

الطريقة	نوع القيمة التي يتم عرضها	وصف قصير
setAuthorizationAction(action)	DecoratedText	تُستخدَم لضبط إجراء تفويض يفتح عنوان URL يؤدي إلى مسار التفويض عند النقر على العنصر.
setBottomLabel(text)	DecoratedText	لضبط نص التصنيف لاستخدامه كمفتاح، ويتم عرضه أسفل محتوى النص.
setButton(button)	DecoratedText	لضبط Button الذي يظهر على يسار النص.
setComposeAction(action, composedEmailType)	DecoratedText	تُستخدَم لضبط إجراء ينشئ مسودة رسالة إلكترونية عند النقر على العنصر.
setEndIcon(endIcon)	DecoratedText	لضبط الرمز IconImage الاختياري الذي يظهر على يسار المحتوى
setOnClickAction(action)	DecoratedText	تُستخدَم لضبط إجراء يتم تنفيذه عند النقر على العنصر.
setOnClickOpenLinkAction(action)	DecoratedText	تُستخدَم لضبط إجراء يفتح عنوان URL في علامة تبويب عند النقر على العنصر.
setOpenLink(openLink)	DecoratedText	تُستخدَم لضبط عنوان URL ليتم فتحه عند النقر على العنصر.
setStartIcon(startIcon)	DecoratedText	لضبط الرمز IconImage الاختياري لعرضه قبل محتوى النص
setSwitchControl(switchToSet)	DecoratedText	لضبط Switch الذي يظهر على يسار المحتوى
setText(text)	DecoratedText	لضبط النص الذي سيتم استخدامه كقيمة
setTopLabel(text)	DecoratedText	لضبط نص التصنيف الذي سيتم استخدامه كمفتاح ويتم عرضه أعلى محتوى النص.
setWrapText(wrapText)	DecoratedText	لضبط ما إذا كان يجب عرض نص القيمة على سطر واحد أو أسطر متعددة.

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

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

الإرجاع

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

---

setBottomLabel(text)

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

المعلمات

الاسم	النوع	الوصف
text	String	نص التصنيف.

الإرجاع

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

---

setButton(button)

لضبط Button الذي يظهر على يسار النص. يمكن أن يضمّن جهاز DecoratedText زرًا واحدًا أو مفتاحًا واحدًا فقط.

المعلمات

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

الإرجاع

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

---

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

الإرجاع

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

---

setEndIcon(endIcon)

لضبط الرمز IconImage الاختياري الذي يظهر على يسار المحتوى لا يمكن أن يتضمّن DecoratedText سوى زر واحد أو مفتاح واحد أو رمز واحد.

المعلمات

الاسم	النوع	الوصف
endIcon	IconImage	الرمز المطلوب إضافته

الإرجاع

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

---

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

الإرجاع

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

---

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

الإرجاع

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

---

setOpenLink(openLink)

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

المعلمات

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

الإرجاع

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

---

setStartIcon(startIcon)

لضبط الرمز IconImage الاختياري لعرضه قبل محتوى النص

المعلمات

الاسم	النوع	الوصف
startIcon	IconImage	الرمز المطلوب عرضه

الإرجاع

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

---

setSwitchControl(switchToSet)

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

المعلمات

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

الإرجاع

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

---

setText(text)

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

المعلمات

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

الإرجاع

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

---

setTopLabel(text)

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

المعلمات

الاسم	النوع	الوصف
text	String	نص التصنيف.

الإرجاع

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

---

setWrapText(wrapText)

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

المعلمات

الاسم	النوع	الوصف
wrapText	Boolean	إذا كان true، يتمّ لفّ النص وعرضه على عدّة أسطر. بخلاف ذلك، يتم اقتطاع النص.

الإرجاع

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