activities
latest
false
UiPath logo, featuring letters U and I in white

Productivity Activities

Last updated Dec 6, 2024

GetEvents

Retrieve a list of calendar events defined by the filter criteria.

Namespace: UiPath.Gsuite.Activities.API

Assembly: UiPath.Gsuite.Activities.API (in UiPath.Gsuite.Activities.API.dll)

Syntax

IReadOnlyCollection<ICalendarEvent> GetEvents(
	DateTimeOffsetstartDate,
	DateTimeOffsetendDate,
	ICalendarcalendar = null,
	inttop = 0,
	stringtimeZone = "",
	stringsearch = ""
)IReadOnlyCollection<ICalendarEvent> GetEvents(
	DateTimeOffsetstartDate,
	DateTimeOffsetendDate,
	ICalendarcalendar = null,
	inttop = 0,
	stringtimeZone = "",
	stringsearch = ""
)

Parameters

startDate DateTimeOffset
Indicates the date and time as of when to search for events.
endDate DateTimeOffset
Indicates the date and time until which to search for events.
calendar ICalendar (Optional)
The calendar used for the event. If not indicated, the user's default calendar is used.
top Int32 (Optional)
The maximum number of events to return. If 0, it means 'no limit'.
timeZone String (Optional)
Select the time zone for the current event. If left blank, the default option is UTC.
search String (Optional)
The text to filter within events. The filter is applied to the following fields: Summary, Description, Attendee's Display Names, Attendee's Email, and Location.

Return value

IReadOnlyCollection<ICalendarEvent> - The list of events retrieved by the activity.
  • Syntax
  • Parameters
  • Return value

Was this page helpful?

Get The Help You Need
Learning RPA - Automation Courses
UiPath Community Forum
Uipath Logo White
Trust and Security
© 2005-2024 UiPath. All rights reserved.