Class TextButton

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

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

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اللون بتنسيق #RSS.

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

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 — هذا العنصر للسلاسل.