target.apidocs.com.google.api.services.calendar.Calendar.Events.html Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of google-api-services-calendar Show documentation

The newest version!







Calendar.Events (Calendar API v3-rev20241101-2.0.0)











Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.google.api.services.calendar
Class Calendar.Events



java.lang.Object


com.google.api.services.calendar.Calendar.Events







Enclosing class:
Calendar




public class Calendar.Events
extends Object
The "events" collection of methods.











Nested Class Summary

Nested Classes 

Modifier and Type
Class and Description


class 
Calendar.Events.CalendarImport 


class 
Calendar.Events.Delete 


class 
Calendar.Events.Get 


class 
Calendar.Events.Insert 


class 
Calendar.Events.Instances 


class 
Calendar.Events.List 


class 
Calendar.Events.Move 


class 
Calendar.Events.Patch 


class 
Calendar.Events.QuickAdd 


class 
Calendar.Events.Update 


class 
Calendar.Events.Watch 









Constructor Summary

Constructors 

Constructor and Description


Events() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


Calendar.Events.CalendarImport
calendarImport(String calendarId,
              Event content)
Imports an event.



Calendar.Events.Delete
delete(String calendarId,
      String eventId)
Deletes an event.



Calendar.Events.Get
get(String calendarId,
   String eventId)
Returns an event based on its Google Calendar ID.



Calendar.Events.Insert
insert(String calendarId,
      Event content)
Creates an event.



Calendar.Events.Instances
instances(String calendarId,
         String eventId)
Returns instances of the specified recurring event.



Calendar.Events.List
list(String calendarId)
Returns events on the specified calendar.



Calendar.Events.Move
move(String calendarId,
    String eventId,
    String destination)
Moves an event to another calendar, i.e.



Calendar.Events.Patch
patch(String calendarId,
     String eventId,
     Event content)
Updates an event.



Calendar.Events.QuickAdd
quickAdd(String calendarId,
        String text)
Creates an event based on a simple text string.



Calendar.Events.Update
update(String calendarId,
      String eventId,
      Event content)
Updates an event.



Calendar.Events.Watch
watch(String calendarId,
     Channel content)
Watch for changes to Events resources.







Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait














Constructor Detail





Events
public Events()









Method Detail





delete
public Calendar.Events.Delete delete(String calendarId,
                                     String eventId)
                              throws IOException
Deletes an event.

 Create a request for the method "events.delete".

 This request holds the parameters needed by the calendar server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
calendarId - Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to
        access the primary calendar of the currently logged in user, use the "primary" keyword.
eventId - Event identifier.
Returns:
the request
Throws:
IOException








get
public Calendar.Events.Get get(String calendarId,
                               String eventId)
                        throws IOException
Returns an event based on its Google Calendar ID. To retrieve an event using its iCalendar ID,
 call the events.list method using the iCalUID parameter.

 Create a request for the method "events.get".

 This request holds the parameters needed by the calendar server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
calendarId - Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to
        access the primary calendar of the currently logged in user, use the "primary" keyword.
eventId - Event identifier.
Returns:
the request
Throws:
IOException








calendarImport
public Calendar.Events.CalendarImport calendarImport(String calendarId,
                                                     Event content)
                                              throws IOException
Imports an event. This operation is used to add a private copy of an existing event to a
 calendar. Only events with an eventType of default may be imported. Deprecated behavior: If a
 non-default event is imported, its type will be changed to default and any event-type-specific
 properties it may have will be dropped.

 Create a request for the method "events.import".

 This request holds the parameters needed by the calendar server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
calendarId - Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to
        access the primary calendar of the currently logged in user, use the "primary" keyword.
content - the Event
Returns:
the request
Throws:
IOException








insert
public Calendar.Events.Insert insert(String calendarId,
                                     Event content)
                              throws IOException
Creates an event.

 Create a request for the method "events.insert".

 This request holds the parameters needed by the calendar server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
calendarId - Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to
        access the primary calendar of the currently logged in user, use the "primary" keyword.
content - the Event
Returns:
the request
Throws:
IOException








instances
public Calendar.Events.Instances instances(String calendarId,
                                           String eventId)
                                    throws IOException
Returns instances of the specified recurring event.

 Create a request for the method "events.instances".

 This request holds the parameters needed by the calendar server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
calendarId - Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to
        access the primary calendar of the currently logged in user, use the "primary" keyword.
eventId - Recurring event identifier.
Returns:
the request
Throws:
IOException








list
public Calendar.Events.List list(String calendarId)
                          throws IOException
Returns events on the specified calendar.

 Create a request for the method "events.list".

 This request holds the parameters needed by the calendar server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
calendarId - Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to
        access the primary calendar of the currently logged in user, use the "primary" keyword.
Returns:
the request
Throws:
IOException








move
public Calendar.Events.Move move(String calendarId,
                                 String eventId,
                                 String destination)
                          throws IOException
Moves an event to another calendar, i.e. changes an event's organizer. Note that only default
 events can be moved; birthday, focusTime, fromGmail, outOfOffice and workingLocation events
 cannot be moved.

 Create a request for the method "events.move".

 This request holds the parameters needed by the calendar server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
calendarId - Calendar identifier of the source calendar where the event currently is on.
eventId - Event identifier.
destination - Calendar identifier of the target calendar where the event is to be moved to.
Returns:
the request
Throws:
IOException








patch
public Calendar.Events.Patch patch(String calendarId,
                                   String eventId,
                                   Event content)
                            throws IOException
Updates an event. This method supports patch semantics.

 Create a request for the method "events.patch".

 This request holds the parameters needed by the calendar server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
calendarId - Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to
        access the primary calendar of the currently logged in user, use the "primary" keyword.
eventId - Event identifier.
content - the Event
Returns:
the request
Throws:
IOException








quickAdd
public Calendar.Events.QuickAdd quickAdd(String calendarId,
                                         String text)
                                  throws IOException
Creates an event based on a simple text string.

 Create a request for the method "events.quickAdd".

 This request holds the parameters needed by the calendar server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
calendarId - Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to
        access the primary calendar of the currently logged in user, use the "primary" keyword.
text - The text describing the event to be created.
Returns:
the request
Throws:
IOException








update
public Calendar.Events.Update update(String calendarId,
                                     String eventId,
                                     Event content)
                              throws IOException
Updates an event.

 Create a request for the method "events.update".

 This request holds the parameters needed by the calendar server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
calendarId - Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to
        access the primary calendar of the currently logged in user, use the "primary" keyword.
eventId - Event identifier.
content - the Event
Returns:
the request
Throws:
IOException








watch
public Calendar.Events.Watch watch(String calendarId,
                                   Channel content)
                            throws IOException
Watch for changes to Events resources.

 Create a request for the method "events.watch".

 This request holds the parameters needed by the calendar server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
calendarId - Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to
        access the primary calendar of the currently logged in user, use the "primary" keyword.
content - the Channel
Returns:
the request
Throws:
IOException














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2024 Google. All rights reserved.

Modifier and Type	Class and Description
`class`	`Calendar.Events.CalendarImport`
`class`	`Calendar.Events.Delete`
`class`	`Calendar.Events.Get`
`class`	`Calendar.Events.Insert`
`class`	`Calendar.Events.Instances`
`class`	`Calendar.Events.List`
`class`	`Calendar.Events.Move`
`class`	`Calendar.Events.Patch`
`class`	`Calendar.Events.QuickAdd`
`class`	`Calendar.Events.Update`
`class`	`Calendar.Events.Watch`

Modifier and Type	Method and Description
`Calendar.Events.CalendarImport`	`calendarImport(String calendarId, Event content)` Imports an event.
`Calendar.Events.Delete`	`delete(String calendarId, String eventId)` Deletes an event.
`Calendar.Events.Get`	`get(String calendarId, String eventId)` Returns an event based on its Google Calendar ID.
`Calendar.Events.Insert`	`insert(String calendarId, Event content)` Creates an event.
`Calendar.Events.Instances`	`instances(String calendarId, String eventId)` Returns instances of the specified recurring event.
`Calendar.Events.List`	`list(String calendarId)` Returns events on the specified calendar.
`Calendar.Events.Move`	`move(String calendarId, String eventId, String destination)` Moves an event to another calendar, i.e.
`Calendar.Events.Patch`	`patch(String calendarId, String eventId, Event content)` Updates an event.
`Calendar.Events.QuickAdd`	`quickAdd(String calendarId, String text)` Creates an event based on a simple text string.
`Calendar.Events.Update`	`update(String calendarId, String eventId, Event content)` Updates an event.
`Calendar.Events.Watch`	`watch(String calendarId, Channel content)` Watch for changes to Events resources.