Class DecoratedText

تنظيم صفحاتك في مجموعات يمكنك حفظ المحتوى وتصنيفه حسب إعداداتك المفضّلة.
النص المزخرف

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

var decoratedText = CardService.newDecoratedText()
    .setText("Text")
    .setTopLabel("TopLabel");

var 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).

// ...

var action = CardService.newAuthorizationAction().setAuthorizationUrl('url');
CardService.newTextButton().setText('Authorize').setAuthorizationAction(action);

المعلّمات

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

تذكرة ذهاب وعودة

DecoratedText — هذا العنصر للسلاسل.


setBottomLabel(text)

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

المعلّمات

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

تذكرة ذهاب وعودة

DecoratedText — هذا العنصر للسلاسل.


setButton(button)

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

المعلّمات

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

تذكرة ذهاب وعودة

DecoratedText — هذا العنصر للسلاسل.


setComposeAction(action, composedEmailType)

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

يجب أن تتضمن المعلمة Action دالة رد اتصال تعرض كائن ComposeActionResponse تم ضبطه باستخدام ComposeActionResponseBuilder.setGmailDraft(draft).

// ...

var action = CardService.newAction().setFunctionName('composeEmailCallback');
CardService.newTextButton()
    .setText('Compose Email')
    .setComposeAction(action, CardService.ComposedEmailType.REPLY_AS_DRAFT);

// ...

function composeEmailCallback() {
  var thread = GmailApp.getThreadById(e.threadId);
  var draft = thread.createDraftReply('This is a reply');
  return CardService.newComposeActionResponseBuilder()
      .setGmailDraft(draft)
      .build();
}

المعلّمات

الاسمالنوعالوصف
actionActionتمثّل هذه السمة العنصر الذي يحدِّد الإجراء الذي سيتم اتخاذه عند النقر على هذا العنصر.
composedEmailTypeComposedEmailTypeقيمة تعداد تحدد ما إذا كانت المسودة المكوّنة مسودة مستقلة أو ردًا.

تذكرة ذهاب وعودة

DecoratedText — هذا العنصر للسلاسل.


setEndIcon(endIcon)

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

المعلّمات

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

تذكرة ذهاب وعودة

DecoratedText — هذا العنصر للسلاسل.


setOnClickAction(action)

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

يجب أن تحدّد المعلمة Action دالة رد اتصال تعرض كائن ActionResponse.

// ...

var 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();
}

المعلّمات

الاسمالنوعالوصف
actionActionالإجراء الذي يجب اتخاذه عند النقر على هذا العنصر.

تذكرة ذهاب وعودة

DecoratedText — هذا العنصر للسلاسل.


setOnClickOpenLinkAction(action)

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

يجب أن تتضمن المعلمة Action دالة رد اتصال تعرض كائن ActionResponse تم ضبطه باستخدام ActionResponseBuilder.setOpenLink(openLink).

// ...

var 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();
}

المعلّمات

الاسمالنوعالوصف
actionActionتمثّل هذه السمة العنصر الذي يحدِّد إجراء الرابط المفتوح الذي يجب اتخاذه عند النقر على هذا العنصر.

تذكرة ذهاب وعودة

DecoratedText — هذا العنصر للسلاسل.


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

المعلّمات

الاسمالنوعالوصف
openLinkOpenLinkعنصر OpenLink يصف عنوان URL لفتحه.

تذكرة ذهاب وعودة

DecoratedText — هذا العنصر للسلاسل.


setStartIcon(startIcon)

تعمل هذه السياسة على ضبط السمة الاختيارية IconImage لعرضها قبل المحتوى النصي.

المعلّمات

الاسمالنوعالوصف
startIconIconImageالرمز المطلوب عرضه.

تذكرة ذهاب وعودة

DecoratedText — هذا العنصر للسلاسل.


setSwitchControl(switchToSet)

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

المعلّمات

الاسمالنوعالوصف
switchToSetSwitchمفتاح التبديل المراد إضافته.

تذكرة ذهاب وعودة

DecoratedText — هذا العنصر للسلاسل.


setText(text)

إعداد النص المراد استخدامه كقيمة. يتيح تنسيق HTML الأساسي. مطلوبة.

المعلّمات

الاسمالنوعالوصف
textStringالمحتوى النصي لهذه الأداة

تذكرة ذهاب وعودة

DecoratedText — هذا العنصر للسلاسل.


setTopLabel(text)

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

المعلّمات

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

تذكرة ذهاب وعودة

DecoratedText — هذا العنصر للسلاسل.


setWrapText(wrapText)

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

المعلّمات

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

تذكرة ذهاب وعودة

DecoratedText — هذا العنصر للسلاسل.