AI-generated Key Takeaways
-
CalendarEventActionResponseBuilder
helps in constructing responses for actions taken on Calendar events within Apps Script. -
It provides methods to add attendees, attachments, and conference data to the event.
-
The
build()
method finalizes the response and ensures its validity before execution. -
Developers can chain methods together for a more fluent and readable code structure.
-
Responses built using this object are ultimately represented by a
CalendarEventActionResponse
instance.
A builder for Calendar
objects.
Methods
Method | Return type | Brief description |
---|---|---|
add | Calendar | Specifies that the response should add the attachments to the Calendar event when the associated UI action is taken. |
add | Calendar | Specifies that the response should add the indicated attendees to the Calendar event when the associated UI action is taken. |
build() | Calendar | Builds the current Calendar event action response and validates it. |
set | Calendar | Specifies that the response should set the indicated conference data to the Calendar event when the associated UI action is taken. |
Detailed documentation
addAttachments(attachments)
Specifies that the response should add the attachments to the Calendar event when the associated UI action is taken.
Parameters
Name | Type | Description |
---|---|---|
attachments | Attachment[] | An array of Attachment s to add. |
Return
Calendar
— This object, for chaining.
addAttendees(emails)
Specifies that the response should add the indicated attendees to the Calendar event when the associated UI action is taken.
Parameters
Name | Type | Description |
---|---|---|
emails | String[] | An array of email addresses to add to the event. |
Return
Calendar
— This object, for chaining.
Throws
Error
— If too many attendees have been added.
build()
Builds the current Calendar event action response and validates it.
Return
Calendar
— A validated Calendar
.
Throws
Error
— If the constructed Calendar event action response isn't valid.
setConferenceData(conferenceData)
Specifies that the response should set the indicated conference data to the Calendar event when the associated UI action is taken.
Parameters
Name | Type | Description |
---|---|---|
conference | Conference | Conference data to set to the event, created by an add on. |
Return
Calendar
— This object, for chaining.