Skip to content

Commit 2e6ee8b

Browse files
PierrickVouletpierrick
PierrickVoulet
and
pierrick
authored
Add Attendance Chat App codelab sources into solutions (#478)
Co-authored-by: pierrick <[email protected]>
1 parent 4714a6a commit 2e6ee8b

File tree

11 files changed

+543
-0
lines changed

11 files changed

+543
-0
lines changed

‎solutions/attendance-chat-app/README.md

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Attendance Chat App
2+
3+
This code sample shows how to build a Google Chat app using Google
4+
Apps Script. The Chat app responds to messages in a space or direct message (DM) and
5+
allows the user to set a vacation responder in Gmail or add an all-day event to
6+
their Calendar from Google Chat.
7+
8+
## Usage
9+
10+
You can follow [this codelab](https://developers.google.com/codelabs/chat-apps-script)
11+
to build and test this Chat app.
12+
13+
To use this Chat app, you must enable the Hangouts Chat API in the
14+
[Google API Console](https://console.developers.google.com/). After enabling
15+
the API, configuring the Chat app, and publishing it, you must add the Chat app to a space
16+
or DM to begin a conversation.
17+
18+
For more information about how to publish a Chat app, see
19+
[Publishing Google Chat apps](https://developers.google.com/workspace/chat/apps-publish).
20+
21+
## Disclaimer
22+
23+
This is not an official product.

‎solutions/attendance-chat-app/final/Code.gs

+160
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,160 @@
1+
/**
2+
* Responds to an ADDED_TO_SPACE event in Google Chat.
3+
* @param {object} event the event object from Google Chat
4+
* @return {object} JSON-formatted response
5+
* @see https://developers.google.com/workspace/chat/receive-respond-interactions
6+
*/
7+
function onAddToSpace(event) {
8+
console.info(event);
9+
var message = 'Thank you for adding me to ';
10+
if (event.space.type === 'DM') {
11+
message += 'a DM, ' + event.user.displayName + '!';
12+
} else {
13+
message += event.space.displayName;
14+
}
15+
return { text: message };
16+
}
17+
18+
/**
19+
* Responds to a REMOVED_FROM_SPACE event in Google Chat.
20+
* @param {object} event the event object from Google Chat
21+
* @see https://developers.google.com/workspace/chat/receive-respond-interactions
22+
*/
23+
function onRemoveFromSpace(event) {
24+
console.info(event);
25+
console.log('Chat app removed from ', event.space.name);
26+
}
27+
28+
var DEFAULT_IMAGE_URL = 'https://goo.gl/bMqzYS';
29+
var HEADER = {
30+
header: {
31+
title : 'Attendance Chat app',
32+
subtitle : 'Log your vacation time',
33+
imageUrl : DEFAULT_IMAGE_URL
34+
}
35+
};
36+
37+
/**
38+
* Creates a card-formatted response.
39+
* @param {object} widgets the UI components to send
40+
* @return {object} JSON-formatted response
41+
*/
42+
function createCardResponse(widgets) {
43+
return {
44+
cards: [HEADER, {
45+
sections: [{
46+
widgets: widgets
47+
}]
48+
}]
49+
};
50+
}
51+
52+
var REASON = {
53+
SICK: 'Out sick',
54+
OTHER: 'Out of office'
55+
};
56+
/**
57+
* Responds to a MESSAGE event triggered in Google Chat.
58+
* @param {object} event the event object from Google Chat
59+
* @return {object} JSON-formatted response
60+
*/
61+
function onMessage(event) {
62+
console.info(event);
63+
var reason = REASON.OTHER;
64+
var name = event.user.displayName;
65+
var userMessage = event.message.text;
66+
67+
// If the user said that they were 'sick', adjust the image in the
68+
// header sent in response.
69+
if (userMessage.indexOf('sick') > -1) {
70+
// Hospital material icon
71+
HEADER.header.imageUrl = 'https://goo.gl/mnZ37b';
72+
reason = REASON.SICK;
73+
} else if (userMessage.indexOf('vacation') > -1) {
74+
// Spa material icon
75+
HEADER.header.imageUrl = 'https://goo.gl/EbgHuc';
76+
}
77+
78+
var widgets = [{
79+
textParagraph: {
80+
text: 'Hello, ' + name + '.<br/>Are you taking time off today?'
81+
}
82+
}, {
83+
buttons: [{
84+
textButton: {
85+
text: 'Set vacation in Gmail',
86+
onClick: {
87+
action: {
88+
actionMethodName: 'turnOnAutoResponder',
89+
parameters: [{
90+
key: 'reason',
91+
value: reason
92+
}]
93+
}
94+
}
95+
}
96+
}, {
97+
textButton: {
98+
text: 'Block out day in Calendar',
99+
onClick: {
100+
action: {
101+
actionMethodName: 'blockOutCalendar',
102+
parameters: [{
103+
key: 'reason',
104+
value: reason
105+
}]
106+
}
107+
}
108+
}
109+
}]
110+
}];
111+
return createCardResponse(widgets);
112+
}
113+
114+
/**
115+
* Responds to a CARD_CLICKED event triggered in Google Chat.
116+
* @param {object} event the event object from Google Chat
117+
* @return {object} JSON-formatted response
118+
* @see https://developers.google.com/workspace/chat/receive-respond-interactions
119+
*/
120+
function onCardClick(event) {
121+
console.info(event);
122+
var message = '';
123+
var reason = event.action.parameters[0].value;
124+
if (event.action.actionMethodName == 'turnOnAutoResponder') {
125+
turnOnAutoResponder(reason);
126+
message = 'Turned on vacation settings.';
127+
} else if (event.action.actionMethodName == 'blockOutCalendar') {
128+
blockOutCalendar(reason);
129+
message = 'Blocked out your calendar for the day.';
130+
} else {
131+
message = "I'm sorry; I'm not sure which button you clicked.";
132+
}
133+
return { text: message };
134+
}
135+
136+
var ONE_DAY_MILLIS = 24 * 60 * 60 * 1000;
137+
/**
138+
* Turns on the user's vacation response for today in Gmail.
139+
* @param {string} reason the reason for vacation, either REASON.SICK or REASON.OTHER
140+
*/
141+
function turnOnAutoResponder(reason) {
142+
var currentTime = (new Date()).getTime();
143+
Gmail.Users.Settings.updateVacation({
144+
enableAutoReply: true,
145+
responseSubject: reason,
146+
responseBodyHtml: "I'm out of the office today; will be back on the next business day.<br><br><i>Created by Attendance Chat app!</i>",
147+
restrictToContacts: true,
148+
restrictToDomain: true,
149+
startTime: currentTime,
150+
endTime: currentTime + ONE_DAY_MILLIS
151+
}, 'me');
152+
}
153+
154+
/**
155+
* Places an all-day meeting on the user's Calendar.
156+
* @param {string} reason the reason for vacation, either REASON.SICK or REASON.OTHER
157+
*/
158+
function blockOutCalendar(reason) {
159+
CalendarApp.createAllDayEvent(reason, new Date(), new Date(Date.now() + ONE_DAY_MILLIS));
160+
}

‎solutions/attendance-chat-app/final/appsscript.json

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
{
2+
"timeZone": "America/Los_Angeles",
3+
"dependencies": {
4+
"enabledAdvancedServices": [{
5+
"userSymbol": "Gmail",
6+
"serviceId": "gmail",
7+
"version": "v1"
8+
}]
9+
},
10+
"chat": {
11+
}
12+
}

‎solutions/attendance-chat-app/step-3/Code.gs

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
/**
2+
* Responds to an ADDED_TO_SPACE event
3+
* in Google Chat.
4+
*
5+
* @param event the event object from Google Chat
6+
* @return JSON-formatted response
7+
*/
8+
function onAddToSpace(event) {
9+
console.info(event);
10+
11+
var message = "";
12+
13+
if (event.space.type === "DM") {
14+
message = "Thank you for adding me to a DM, " +
15+
event.user.displayName + "!";
16+
} else {
17+
message = "Thank you for adding me to " +
18+
event.space.displayName;
19+
}
20+
21+
return { "text": message };
22+
}
23+
24+
/**
25+
* Responds to a REMOVED_FROM_SPACE event
26+
* in Google Chat.
27+
*
28+
* @param event the event object from Google Chat
29+
*/
30+
function onRemoveFromSpace(event) {
31+
console.info(event);
32+
console.info("Chat app removed from ", event.space.name);
33+
}

‎solutions/attendance-chat-app/step-3/appsscript.json

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"timeZone": "America/Los_Angeles",
3+
"dependencies": {
4+
},
5+
"chat": {}
6+
}

‎solutions/attendance-chat-app/step-4/Code.gs

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
/**
2+
* Responds to an ADDED_TO_SPACE event
3+
* in Google Chat.
4+
*
5+
* @param event the event object from Google Chat
6+
* @return JSON-formatted response
7+
*/
8+
function onAddToSpace(event) {
9+
console.info(event);
10+
11+
var message = "";
12+
13+
if (event.space.type === "DM") {
14+
message = "Thank you for adding me to a DM, " +
15+
event.user.displayName + "!";
16+
} else {
17+
message = "Thank you for adding me to " +
18+
event.space.displayName;
19+
}
20+
21+
return { "text": message };
22+
}
23+
24+
/**
25+
* Responds to a REMOVED_FROM_SPACE event
26+
* in Google Chat.
27+
*
28+
* @param event the event object from Google Chat
29+
*/
30+
function onRemoveFromSpace(event) {
31+
console.info(event);
32+
console.info("Chat app removed from ", event.space.name);
33+
}

‎solutions/attendance-chat-app/step-4/appsscript.json

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"timeZone": "America/Los_Angeles",
3+
"dependencies": {
4+
},
5+
"chat": {}
6+
}

‎solutions/attendance-chat-app/step-5/Code.gs

+69
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
/**
2+
* Responds to an ADDED_TO_SPACE event
3+
* in Google Chat.
4+
*
5+
* @param event the event object from Google Chat
6+
* @return JSON-formatted response
7+
*/
8+
function onAddToSpace(event) {
9+
console.info(event);
10+
11+
var message = "";
12+
13+
if (event.space.type === "DM") {
14+
message = "Thank you for adding me to a DM, " +
15+
event.user.displayName + "!";
16+
} else {
17+
message = "Thank you for adding me to " +
18+
event.space.displayName;
19+
}
20+
21+
return { "text": message };
22+
}
23+
24+
/**
25+
* Responds to a REMOVED_FROM_SPACE event
26+
* in Google Chat.
27+
*
28+
* @param event the event object from Google Chat
29+
*/
30+
function onRemoveFromSpace(event) {
31+
console.info(event);
32+
console.info("Chat app removed from ", event.space.name);
33+
}
34+
35+
/**
36+
* Creates a card-formatted response.
37+
*
38+
* @param widgets the UI components to send
39+
* @return JSON-formatted response
40+
*/
41+
function createCardResponse(widgets) {
42+
return {
43+
"cards": [
44+
header,
45+
{
46+
"sections": [{
47+
"widgets": widgets
48+
}]
49+
}]
50+
};
51+
}
52+
53+
/**
54+
* Responds to a MESSAGE event triggered in Google Chat.
55+
*
56+
* @param event the event object from Google Chat
57+
* @return JSON-formatted response
58+
*/
59+
function onMessage(event) {
60+
var userMessage = event.message.text;
61+
62+
var widgets = [{
63+
"textParagraph": {
64+
"text": "You said: " + userMessage
65+
}
66+
}];
67+
68+
return createCardResponse(widgets);
69+
}

‎solutions/attendance-chat-app/step-5/appsscript.json

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"timeZone": "America/Los_Angeles",
3+
"dependencies": {
4+
},
5+
"chat": {}
6+
}

0 commit comments

Comments
 (0)