تتيح لك عناصر Action إنشاء سلوك تفاعلي في إضافات Google Workspace. تحدّد هذه الدوال الإجراءات التي تحدث عندما يتفاعل المستخدم مع أداة (مثل زر) في واجهة المستخدم الخاصة بالإضافة.
يتم ربط إجراء بأداة معيّنة باستخدام دالة معالجة الأدوات، والتي تحدّد أيضًا الشرط الذي يؤدي إلى تنفيذ الإجراء. عندما يتم تشغيل الإجراء، ينفّذ دالة ردّ اتصال معيّنة. يتم تمرير عنصر حدث إلى دالّة رد الاتصال، ويحمل هذا العنصر معلومات حول تفاعلات المستخدم من جهة العميل. يجب تنفيذ دالّة رد الاتصال وإرجاع عنصر استجابة محدّد.
على سبيل المثال، لنفترض أنّك تريد زرًا ينشئ بطاقة جديدة ويعرضها عند النقر عليه. لإجراء ذلك، عليك إنشاء أداة زر جديدة واستخدام دالة معالج أداة الزر setOnClickAction(action) لضبط Action لإنشاء البطاقات. يحدّد
Action الذي تحدّده دالّة رد الاتصال في برمجة تطبيقات
يتم تنفيذها عند النقر على الزر. في هذه الحالة، عليك تنفيذ دالة رد الاتصال لإنشاء البطاقة التي تريدها وعرض عنصر ActionResponse. يطلب عنصر الاستجابة من الإضافة عرض البطاقة التي أنشأتها دالة معاودة الاتصال.
توضّح هذه الصفحة إجراءات عناصر واجهة المستخدم الخاصة بـ Google Drive التي يمكنك تضمينها في الإضافة.
التفاعلات على Drive
يمكن أن تتضمّن إضافات Google Workspace التي توسّع نطاق Drive إجراءً إضافيًا خاصًا بأداة Drive. يتطلّب هذا الإجراء أن تعرض دالّة رد الاتصال المرتبطة بالإجراء عنصر استجابة متخصصًا:
| الإجراء الذي تمت محاولة تنفيذه | يجب أن تعرض دالّة رد الاتصال |
|---|---|
| طلب الوصول إلى الملفات المحدّدة | DriveItemsSelectedActionResponse |
لاستخدام إجراءات التطبيق المصغّر وعناصر الرد هذه، يجب استيفاء جميع الشروط التالية:
- يتم تشغيل الإجراء عندما يختار المستخدم عنصرًا واحدًا أو أكثر من عناصر Drive.
- تتضمّن الإضافة
https://www.googleapis.com/auth/drive.fileنطاق Drive في بيانها.
طلب إذن الوصول إلى الملفات المحدّدة
يوضّح المثال التالي كيفية إنشاء واجهة مستندة إلى السياق لتطبيق Drive يتم تشغيلها عندما يختار المستخدم عنصرًا واحدًا أو أكثر من عناصر Drive. يختبر المثال كل عنصر لمعرفة ما إذا تم منح الملحق إذن الوصول أم لا. وفي حال عدم منحه، يستخدم المثال عنصر DriveItemsSelectedActionResponse لطلب هذا الإذن من المستخدم. بعد منح الإذن لأحد العناصر، تعرض الإضافة مقدار مساحة التخزين المستخدَمة من حصة Drive لهذا العنصر.
/**
* Builds a card that checks selected items' quota usage. Checking
* quota usage requires user-permissions, so this
* add-on provides a button to request
* `drive.file` scope for items the add-on
* doesn't yet have permission to access.
*
* @param e The event object passed containing contextual information about
* the Drive items selected.
* @return {Card}
*/
function onDriveItemsSelected(e) {
var builder = CardService.newCardBuilder();
// For each item the user has selected in Drive, display
// either its quota information or a button that lets the user provide
// permission to access that file to retrieve its quota details.
e['drive']['selectedItems'].forEach(
function(item){
var cardSection = CardService.newCardSection()
.setHeader(item['title']);
// This add-on uses the recommended, limited-permission `drive.file`
// scope to get granular per-file access permissions.
// See: https://developers.google.com/drive/api/v2/about-auth
if (item['addonHasFileScopePermission']) {
// If the add-on has access permission, read and display its
// quota.
cardSection.addWidget(
CardService.newTextParagraph().setText(
"This file takes up: " + getQuotaBytesUsed(item['id'])));
} else {
// If the add-on doesn't have access permission, add a button
// that lets the user provide that permission on a per-file
// basis.
cardSection.addWidget(
CardService.newTextParagraph().setText(
"The add-on needs permission to access this file's quota."));
var buttonAction = CardService.newAction()
.setFunctionName("onRequestFileScopeButtonClicked")
.setParameters({id: item.id});
var button = CardService.newTextButton()
.setText("Request permission")
.setOnClickAction(buttonAction);
cardSection.addWidget(button);
}
builder.addSection(cardSection);
});
return builder.build();
}
/**
* Callback function for a button action. Instructs Drive to
* display a permissions dialog to the user, requesting `drive.file` scope
* for a specific item on behalf of this add-on.
*
* @param {Object} e The parameters object that contains the item's
* Drive ID.
* @return {DriveItemsSelectedActionResponse}
*/
function onRequestFileScopeButtonClicked (e) {
var idToRequest = e.parameters.id;
return CardService.newDriveItemsSelectedActionResponseBuilder()
.requestFileScope(idToRequest).build();
}
/**
* Use the Advanced Drive Service (See
* https://developers.google.com/apps-script/advanced/drive), with
* `drive.file` scope permissions to request the quota usage of a specific
* Drive item.
*
* @param {string} itemId The ID of the item to check.
* @return {string} A description of the item's quota usage, in bytes.
*/
function getQuotaBytesUsed(itemId) {
try {
return Drive.Files.get(itemId,{fields: "quotaBytesUsed"})
.quotaBytesUsed + " bytes";
} catch (e) {
return "Error fetching how much quota this item uses. Error: " + e;
}
}