Class TextButton

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)

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

المَعلمات

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

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

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

المَعلمات

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

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

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


setBackgroundColor(backgroundColor)

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

المَعلمات

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

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

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


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

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

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


setDisabled(disabled)

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

المَعلمات

الاسمالنوعالوصف
disabledBooleanحالة الإيقاف

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

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

المَعلمات

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

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

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

المَعلمات

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

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

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


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

المَعلمات

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

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

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


setText(text)

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

المَعلمات

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

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

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


setTextButtonStyle(textButtonStyle)

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

المَعلمات

الاسمالنوعالوصف
textButtonStyleTextButtonStyleنمط الزرّ.

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

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