Action
ऑब्जेक्ट की मदद से, Google Workspace ऐड-ऑन में इंटरैक्टिव व्यवहार बनाया जा सकता है. इनसे यह तय होता है कि जब कोई उपयोगकर्ता ऐड-ऑन के यूज़र इंटरफ़ेस (यूआई) में किसी विजेट (उदाहरण के लिए, बटन) के साथ इंटरैक्ट करता है, तो क्या होता है.
किसी विजेट में कार्रवाई जोड़ने के लिए, विजेट हैंडलर फ़ंक्शन का इस्तेमाल किया जाता है. यह फ़ंक्शन, कार्रवाई को ट्रिगर करने वाली शर्त के बारे में भी बताता है. ट्रिगर होने पर, कार्रवाई किसी तय किए गए कॉलबैक फ़ंक्शन को लागू करती है. कॉलबैक फ़ंक्शन को एक इवेंट ऑब्जेक्ट पास किया जाता है. इसमें उपयोगकर्ता के क्लाइंट-साइड इंटरैक्शन की जानकारी होती है. आपको कॉलबैक फ़ंक्शन लागू करना होगा और उसे कोई खास रिस्पॉन्स ऑब्जेक्ट दिखाना होगा.
उदाहरण के लिए, मान लें कि आपको ऐसा बटन चाहिए जो नया कार्ड बनाता और उसे तब दिखाता है
क्लिक किया गया. इसके लिए, आपको एक नया बटन विजेट बनाना होगा. साथ ही, कार्ड बनाने की सुविधा Action
सेट करने के लिए, बटन विजेट हैंडलर फ़ंक्शन setOnClickAction(action)
का इस्तेमाल करना होगा. आपने जो Action
तय किया है वह Apps Script के कॉलबैक फ़ंक्शन के बारे में बताता है. यह फ़ंक्शन, बटन पर क्लिक करने पर काम करता है. इस मामले में, आपको
कॉलबैक फ़ंक्शन लागू करके अपनी पसंद का कार्ड बनाएं और
ActionResponse
ऑब्जेक्ट है. रिस्पॉन्स ऑब्जेक्ट, ऐड-ऑन को वह कार्ड दिखाने के लिए कहता है जिसे कॉलबैक फ़ंक्शन ने बनाया है.
यह पेज कैलेंडर के खास विजेट के बारे में बताता है, जिसे आप अपने ऐड-ऑन.
Calendar के इंटरैक्शन
Calendar के साथ काम करने वाले Google Workspace ऐड-ऑन में, Calendar के लिए कुछ अतिरिक्त विजेट ऐक्शन शामिल किए जा सकते हैं. ये कार्रवाइयां संबंधित कार्रवाई कॉलबैक फ़ंक्शन की ज़रूरत हो खास तरह के रिस्पॉन्स ऑब्जेक्ट लौटाने के लिए:
कार्रवाई की कोशिश की गई | कॉलबैक फ़ंक्शन को यह वैल्यू दिखानी चाहिए |
---|---|
मीटिंग में शामिल होने वाले लोगों को जोड़ा जा रहा है | CalendarEventActionResponse |
कॉन्फ़्रेंस का डेटा सेट करना | CalendarEventActionResponse |
अटैचमेंट जोड़ना | CalendarEventActionResponse |
विजेट से जुड़ी इन कार्रवाइयों और रिस्पॉन्स ऑब्जेक्ट का इस्तेमाल करने के लिए, ये सभी काम करें सही होना चाहिए:
- यह कार्रवाई तब ट्रिगर होती है, जब उपयोगकर्ता के पास Calendar इवेंट खुला होता है.
- ऐड-ऑन
addOns.calendar.currentEventAccess
मेनिफ़ेस्ट फ़ील्ड कोWRITE
याREAD_WRITE
पर सेट किया गया है. - ऐड-ऑन में
https://www.googleapis.com/auth/calendar.addons.current.event.write
Calendar का दायरा शामिल होता है.
इसके अलावा, कार्रवाई कॉलबैक फ़ंक्शन से किए गए बदलाव तब तक सेव नहीं किए जाते हैं उपयोगकर्ता, Calendar इवेंट को सेव करता है.
कॉलबैक फ़ंक्शन की मदद से मेहमानों को जोड़ना
नीचे दिए गए उदाहरण में, ऐसा बटन बनाने का तरीका बताया गया है जो आपकी साइट के बदलाव किए जा रहे कैलेंडर इवेंट में मेहमान:
/**
* Build a simple card with a button that sends a notification.
* This function is called as part of the eventOpenTrigger that builds
* a UI when the user opens an event.
*
* @param e The event object passed to eventOpenTrigger function.
* @return {Card}
*/
function buildSimpleCard(e) {
var buttonAction = CardService.newAction()
.setFunctionName('onAddAttendeesButtonClicked');
var button = CardService.newTextButton()
.setText('Add new attendee')
.setOnClickAction(buttonAction);
// Check the event object to determine if the user can add
// attendees and disable the button if not.
if (!e.calendar.capabilities.canAddAttendees) {
button.setDisabled(true);
}
// ...continue creating card sections and widgets, then create a Card
// object to add them to. Return the built Card object.
}
/**
* Callback function for a button action. Adds attendees to the
* Calendar event being edited.
*
* @param {Object} e The action event object.
* @return {CalendarEventActionResponse}
*/
function onAddAttendeesButtonClicked (e) {
return CardService.newCalendarEventActionResponseBuilder()
.addAttendees(["aiko@example.com", "malcom@example.com"])
.build();
}
कॉलबैक फ़ंक्शन के साथ कॉन्फ़्रेंस डेटा सेट करना
यह कार्रवाई, ओपन इवेंट पर कॉन्फ़्रेंस डेटा सेट करती है. इस कॉन्फ़्रेंस डेटा के लिए, कॉन्फ़्रेंस के लिए इस्तेमाल किए गए सलूशन का आईडी देना ज़रूरी है. ऐसा इसलिए है, क्योंकि उपयोगकर्ता ने अपनी पसंद का सलूशन चुनकर कार्रवाई को ट्रिगर नहीं किया था.
यहां दिए गए उदाहरण में, ऐसा बटन बनाने का तरीका बताया गया है जो बदलाव किए जा रहे किसी इवेंट के लिए कॉन्फ़्रेंस डेटा सेट करता है:
/**
* Build a simple card with a button that sends a notification.
* This function is called as part of the eventOpenTrigger that builds
* a UI when the user opens a Calendar event.
*
* @param e The event object passed to eventOpenTrigger function.
* @return {Card}
*/
function buildSimpleCard(e) {
var buttonAction = CardService.newAction()
.setFunctionName('onSaveConferenceOptionsButtonClicked')
.setParameters(
{'phone': "1555123467", 'adminEmail': "joyce@example.com"});
var button = CardService.newTextButton()
.setText('Add new attendee')
.setOnClickAction(buttonAction);
// Check the event object to determine if the user can set
// conference data and disable the button if not.
if (!e.calendar.capabilities.canSetConferenceData) {
button.setDisabled(true);
}
// ...continue creating card sections and widgets, then create a Card
// object to add them to. Return the built Card object.
}
/**
* Callback function for a button action. Sets conference data for the
* Calendar event being edited.
*
* @param {Object} e The action event object.
* @return {CalendarEventActionResponse}
*/
function onSaveConferenceOptionsButtonClicked(e) {
var parameters = e.commonEventObject.parameters;
// Create an entry point and a conference parameter.
var phoneEntryPoint = ConferenceDataService.newEntryPoint()
.setEntryPointType(ConferenceDataService.EntryPointType.PHONE)
.setUri('tel:' + parameters['phone']);
var adminEmailParameter = ConferenceDataService.newConferenceParameter()
.setKey('adminEmail')
.setValue(parameters['adminEmail']);
// Create a conference data object to set to this Calendar event.
var conferenceData = ConferenceDataService.newConferenceDataBuilder()
.addEntryPoint(phoneEntryPoint)
.addConferenceParameter(adminEmailParameter)
.setConferenceSolutionId('myWebScheduledMeeting')
.build();
return CardService.newCalendarEventActionResponseBuilder()
.setConferenceData(conferenceData)
.build();
}
कॉलबैक फ़ंक्शन के साथ अटैचमेंट जोड़ें
यहां दिए गए उदाहरण में, ऐसा बटन बनाने का तरीका बताया गया है जिससे Calendar इवेंट में बदलाव करते समय उसमें अटैचमेंट जोड़ा जा सके:
/**
* Build a simple card with a button that creates a new attachment.
* This function is called as part of the eventAttachmentTrigger that
* builds a UI when the user goes through the add-attachments flow.
*
* @param e The event object passed to eventAttachmentTrigger function.
* @return {Card}
*/
function buildSimpleCard(e) {
var buttonAction = CardService.newAction()
.setFunctionName('onAddAttachmentButtonClicked');
var button = CardService.newTextButton()
.setText('Add a custom attachment')
.setOnClickAction(buttonAction);
// Check the event object to determine if the user can add
// attachments and disable the button if not.
if (!e.calendar.capabilities.canAddAttachments) {
button.setDisabled(true);
}
// ...continue creating card sections and widgets, then create a Card
// object to add them to. Return the built Card object.
}
/**
* Callback function for a button action. Adds attachments to the Calendar
* event being edited.
*
* @param {Object} e The action event object.
* @return {CalendarEventActionResponse}
*/
function onAddAttachmentButtonClicked(e) {
return CardService.newCalendarEventActionResponseBuilder()
.addAttachments([
CardService.newAttachment()
.setResourceUrl("https://example.com/test")
.setTitle("Custom attachment")
.setMimeType("text/html")
.setIconUrl("https://example.com/test.png")
])
.build();
}
अटैचमेंट का आइकॉन सेट करना
अटैचमेंट आइकॉन को Google के इंफ़्रास्ट्रक्चर पर होस्ट किया जाना चाहिए. उपलब्ध कराएं अटैचमेंट के आइकॉन देखें.