تمت ترجمة هذه الصفحة بواسطة 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`	تمثّل هذه السمة الكائن الذي يحدد إجراء الإنشاء المطلوب اتخاذه عند النقر على هذا العنصر.
`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: هذا الكائن، للتسلسل.