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

الطُرق

الطريقة	نوع القيمة التي تم إرجاعها	وصف قصير
addEventAction(eventAction)	Widget	تضيف هذه السمة إجراء الحدث الذي يمكن تنفيذه على التطبيق المصغّر.
setAuthorizationAction(action)	DecoratedText	يضبط هذا الإعداد إجراء تفويض يفتح عنوان URL لمسار التفويض عند النقر على العنصر.
setBottomLabel(text)	DecoratedText	تضبط هذه السمة نص التصنيف الذي سيتم استخدامه كمفتاح ويتم عرضه أسفل المحتوى النصي.
setButton(button)	DecoratedText	تضبط هذه السمة Button الذي يظهر على يسار النص.
setComposeAction(action, composedEmailType)	DecoratedText	تضبط هذه السمة إجراءً ينشئ مسودة رسالة إلكترونية عند النقر على العنصر.
setEndIcon(endIcon)	DecoratedText	تضبط هذه السمة IconImage الاختيارية التي تظهر على يسار المحتوى.
setId(id)	Widget	يضبط هذا الإجراء المعرّف الفريد الذي تمّ تعيينه والذي يُستخدَم لتحديد الأداة التي سيتمّ تغييرها.
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	تضبط هذه السمة نص التصنيف الذي سيتم استخدامه كمفتاح ويتم عرضه فوق المحتوى النصي.
setVisibility(visibility)	Widget	تضبط هذه السمة مستوى ظهور الأداة.
setWrapText(wrapText)	DecoratedText	تضبط هذه السمة ما إذا كان يجب عرض نص القيمة في سطر واحد أو عدة أسطر.

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

addEventAction(eventAction)

تضيف هذه السمة إجراء الحدث الذي يمكن تنفيذه على التطبيق المصغّر.

المَعلمات

الاسم	النوع	الوصف
eventAction	EventAction	تمثّل هذه السمة EventAction المطلوب إضافتها.

الإرجاع

Widget — العنصر، للتسلسل

---

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

الإرجاع

DecoratedText: هذا العنصر، للتسلسل

---

setEndIcon(endIcon)

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

المَعلمات

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

الإرجاع

DecoratedText: هذا العنصر، للتسلسل

---

setId(id)

يضبط هذا الإجراء المعرّف الفريد الذي تمّ تعيينه والذي يُستخدَم لتحديد الأداة التي سيتمّ تغييرها. لا يمكن تغيير التطبيقات المصغّرة إلا في الإضافات.

المَعلمات

الاسم	النوع	الوصف
id	String	معرّف الأداة، ويمكن أن يتضمّن 64 حرفًا بحدّ أقصى وبالتنسيق `[a-zA-Z0-9-]+`.

الإرجاع

Widget: هذا العنصر، للتسلسل

---

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: هذا العنصر، للتسلسل

---

setVisibility(visibility)

تضبط هذه السمة مستوى ظهور الأداة. القيمة التلقائية هي `VISIBLE`.

المَعلمات

الاسم	النوع	الوصف
visibility	Visibility	Visibility الأداة

الإرجاع

Widget — العنصر، للتسلسل

---

setWrapText(wrapText)

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

المَعلمات

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

الإرجاع

DecoratedText: هذا العنصر، للتسلسل