تمت ترجمة هذه الصفحة بواسطة Cloud Translation API‏.

Class DecoratedText

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

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

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

المعلمات

الاسم	النوع	الوصف
`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 عند اكتمال الإجراء.

// ...

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

المعلمات

الاسم	النوع	الوصف
`action`	`Action`	الكائن الذي يحدد إجراء Compose المطلوب اتخاذه عندما يكون هذا العنصر النقر عليه.
`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.

// ...

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

المعلمات

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

الإرجاع

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

المعلمات

الاسم	النوع	الوصف
`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 — هذا العنصر، للتسلسل.