Class CardAction

CardAction

عنصر قائمة يمكن النقر عليه وتتم إضافته إلى قائمة عنوان البطاقة.

var action = CardService.newAction();
// Finish building the action...

var cardAction = CardService.newCardAction()
    .setText("Card action")
    .setOnClickAction(action);

الطُرق

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

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

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

المَعلمات

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

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

CardAction: هذا الكائن للتسلسل.


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

المَعلمات

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

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

CardAction: هذا الكائن للتسلسل.


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

المَعلمات

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

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

CardAction: هذا الكائن للتسلسل.


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

المَعلمات

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

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

CardAction: هذا الكائن للتسلسل.


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

المَعلمات

الاسمTypeالوصف
openLinkOpenLinkعنصر OpenLink يصف عنوان URL المُراد فتحه.

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

CardAction: هذا الكائن للتسلسل.


setText(text)

لضبط نص القائمة لهذا الإجراء.

المَعلمات

الاسمTypeالوصف
textStringنص عنصر القائمة.

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

CardAction: هذا الكائن للتسلسل.