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

Class TextButton

TextButton مع تصنيف نصي. يمكنك ضبط لون الخلفية وإيقاف الزر عند الحاجة.

متاحة لإضافات Google Workspace وتطبيقات Google Chat.

var textButton = CardService.newTextButton()
    .setText("Open Link")
    .setOpenLink(CardService.newOpenLink()
        .setUrl("https://www.google.com"));

الطُرق

الطريقة	نوع القيمة التي يتم إرجاعها	وصف قصير
`setAltText(altText)`	`TextButton`	لضبط النص البديل للزر الخاص بأدوات تسهيل الاستخدام.
`setAuthorizationAction(action)`	`TextButton`	لضبط إجراء تفويض يفتح عنوان URL لمسار التفويض عند النقر على الكائن.
`setBackgroundColor(backgroundColor)`	`TextButton`	لضبط لون الخلفية للزر "`TextButtonStyle.FILLED`".
`setComposeAction(action, composedEmailType)`	`TextButton`	تعيين إجراء يؤدي إلى إنشاء مسودة رسالة إلكترونية عند النقر على الكائن.
`setDisabled(disabled)`	`TextButton`	لتحديد ما إذا كان الزر غير مفعّل أم لا.
`setOnClickAction(action)`	`TextButton`	تحدّد إجراءً يتم تنفيذه عند النقر على العنصر.
`setOnClickOpenLinkAction(action)`	`TextButton`	تحدّد هذه السياسة إجراءً يؤدي إلى فتح عنوان URL في علامة تبويب عند النقر على العنصر.
`setOpenLink(openLink)`	`TextButton`	لضبط عنوان URL ليتم فتحه عند النقر على العنصر.
`setText(text)`	`TextButton`	لتعيين النص الذي يظهر على الزر.
`setTextButtonStyle(textButtonStyle)`	`TextButton`	لضبط نمط الزرّ.

الوثائق التفصيلية

`setAltText(altText)`

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

المَعلمات

الاسم	النوع	الوصف
`altText`	`String`	النص البديل الذي سيتم تعيينه لهذا الزر.

استرجاع الكرة

TextButton: هذا الكائن، للتسلسل.

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

استرجاع الكرة

TextButton: هذا الكائن، للتسلسل.

`setBackgroundColor(backgroundColor)`

لضبط لون الخلفية للزر "TextButtonStyle.FILLED". في حال ترك هذه السياسة بدون ضبط لزر "TextButtonStyle.FILLED"، سيستخدم هذا الزر اللون الثانوي المحدَّد في بيان الإضافة. لا تستخدم هذه الطريقة أزرار TextButtonStyle.OUTLINED.

المَعلمات

الاسم	النوع	الوصف
`backgroundColor`	`String`	اللون بتنسيق #rgb.

استرجاع الكرة

TextButton: هذا الكائن، للتسلسل.

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

استرجاع الكرة

TextButton: هذا الكائن، للتسلسل.

`setDisabled(disabled)`

لتحديد ما إذا كان الزر غير مفعّل أم لا. الزر غير المفعَّل غير مفعّل ولا يمكن النقر عليه.

المَعلمات

الاسم	النوع	الوصف
`disabled`	`Boolean`	حالة الإيقاف

استرجاع الكرة

TextButton: هذا الكائن، للتسلسل.

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

استرجاع الكرة

TextButton: هذا الكائن، للتسلسل.

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

استرجاع الكرة

TextButton: هذا الكائن، للتسلسل.

`setOpenLink(openLink)`

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

المَعلمات

الاسم	النوع	الوصف
`openLink`	`OpenLink`	يشير ذلك المصطلح إلى كائن `OpenLink` يصف عنوان URL بأنّه سيتم فتحه.

استرجاع الكرة

TextButton: هذا الكائن، للتسلسل.

`setText(text)`

لتعيين النص الذي يظهر على الزر.

المَعلمات

الاسم	النوع	الوصف
`text`	`String`	النص الذي يظهر على الزر.

استرجاع الكرة

TextButton: هذا الكائن، للتسلسل.

`setTextButtonStyle(textButtonStyle)`

لضبط نمط الزرّ. وفي حال ترك هذه السياسة بدون ضبط، سيتم ضبط الإعدادات التلقائية على الزر TextButtonStyle.OUTLINED.

المَعلمات

الاسم	النوع	الوصف
`textButtonStyle`	`TextButtonStyle`	نمط الزرّ.

استرجاع الكرة

TextButton: هذا الكائن، للتسلسل.