All Downloads are FREE. Search and download functionalities are using the official Maven repository.
  • Log In
  • Register

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

    There is a newer version: v3-rev20241101-2.0.0
    Show newest version
    





Calendar.Events.Watch (Calendar API v3-rev20240927-2.0.0)









    



    Skip navigation links
    





    

    




    


    

    



    



    



    

    com.google.api.services.calendar
    

    Class Calendar.Events.Watch
    

    

    


    


    

    


    

    

      

    • 


        

      • 



        Constructor Detail
        




          

        • 

          Watch
          

          protected Watch(String calendarId,
                Channel content)
          

          Watch for changes to Events resources.

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

 This request holds the parameters needed by the the calendar server.  After setting any
 optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.
 
           Calendar.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must
 be called to initialize this instance immediately after invoking the constructor. 
          

          

          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
          

          Since:
          

          1.13
          

          

          • 

        

        • 

      


        

      • 



        Method Detail
        
































          

        • 

          getCalendarId
          

          public String getCalendarId()
          

          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.
          

          • 

        




          

        • 

          setCalendarId
          

          public Calendar.Events.Watch setCalendarId(String 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.
          

          • 

        




          

        • 

          getAlwaysIncludeEmail
          

          public Boolean getAlwaysIncludeEmail()
          

          Deprecated and ignored.
          

          • 

        








          

        • 

          getEventTypes
          

          public List<String> getEventTypes()
          

          Event types to return. Optional. This parameter can be repeated multiple times to return events of
     different types. If unset, returns all event types.
          

          • 

        




          

        • 

          setEventTypes
          

          public Calendar.Events.Watch setEventTypes(List<String> eventTypes)
          

          Event types to return. Optional. This parameter can be repeated multiple times to return
 events of different types. If unset, returns all event types.
          

          • 

        




          

        • 

          getICalUID
          

          public String getICalUID()
          

          Specifies an event ID in the iCalendar format to be provided in the response. Optional. Use this if
     you want to search for an event by its iCalendar ID.
          

          • 

        




          

        • 

          setICalUID
          

          public Calendar.Events.Watch setICalUID(String iCalUID)
          

          Specifies an event ID in the iCalendar format to be provided in the response. Optional. Use
 this if you want to search for an event by its iCalendar ID.
          

          • 

        




          

        • 

          getMaxAttendees
          

          public Integer getMaxAttendees()
          

          The maximum number of attendees to include in the response. If there are more than the specified
     number of attendees, only the participant is returned. Optional.

     [minimum: 1]
          

          • 

        




          

        • 

          setMaxAttendees
          

          public Calendar.Events.Watch setMaxAttendees(Integer maxAttendees)
          

          The maximum number of attendees to include in the response. If there are more than the
 specified number of attendees, only the participant is returned. Optional.
          

          • 

        




          

        • 

          getMaxResults
          

          public Integer getMaxResults()
          

          Maximum number of events returned on one result page. The number of events in the resulting page
     may be less than this value, or none at all, even if there are more events matching the query.
     Incomplete pages can be detected by a non-empty nextPageToken field in the response. By default the
     value is 250 events. The page size can never be larger than 2500 events. Optional. [default: 250]
     [minimum: 1]
          

          • 

        




          

        • 

          setMaxResults
          

          public Calendar.Events.Watch setMaxResults(Integer maxResults)
          

          Maximum number of events returned on one result page. The number of events in the resulting
 page may be less than this value, or none at all, even if there are more events matching
 the query. Incomplete pages can be detected by a non-empty nextPageToken field in the
 response. By default the value is 250 events. The page size can never be larger than 2500
 events. Optional.
          

          • 

        




          

        • 

          getOrderBy
          

          public String getOrderBy()
          

          The order of the events returned in the result. Optional. The default is an unspecified, stable
     order.
          

          • 

        




          

        • 

          setOrderBy
          

          public Calendar.Events.Watch setOrderBy(String orderBy)
          

          The order of the events returned in the result. Optional. The default is an unspecified,
 stable order.
          

          • 

        




          

        • 

          getPageToken
          

          public String getPageToken()
          

          Token specifying which result page to return. Optional.
          

          • 

        








          

        • 

          getPrivateExtendedProperty
          

          public List<String> getPrivateExtendedProperty()
          

          Extended properties constraint specified as propertyName=value. Matches only private properties.
     This parameter might be repeated multiple times to return events that match all given constraints.
          

          • 

        




          

        • 

          setPrivateExtendedProperty
          

          public Calendar.Events.Watch setPrivateExtendedProperty(List<String> privateExtendedProperty)
          

          Extended properties constraint specified as propertyName=value. Matches only private
 properties. This parameter might be repeated multiple times to return events that match all
 given constraints.
          

          • 

        




          

        • 

          getQ
          

          public String getQ()
          

          Free text search terms to find events that match these terms in the following fields:

     - summary - description - location - attendee's displayName - attendee's email - organizer's
     displayName - organizer's email - workingLocationProperties.officeLocation.buildingId -
     workingLocationProperties.officeLocation.deskId - workingLocationProperties.officeLocation.label -
     workingLocationProperties.customLocation.label These search terms also match predefined keywords
     against all display title translations of working location, out-of-office, and focus-time events.
     For example, searching for "Office" or "Bureau" returns working location events of type
     officeLocation, whereas searching for "Out of office" or "Abwesend" returns out-of-office events.
     Optional.
          

          • 

        




          

        • 

          setQ
          

          public Calendar.Events.Watch setQ(String q)
          

          Free text search terms to find events that match these terms in the following fields:

 - summary - description - location - attendee's displayName - attendee's email -
 organizer's displayName - organizer's email -
 workingLocationProperties.officeLocation.buildingId -
 workingLocationProperties.officeLocation.deskId -
 workingLocationProperties.officeLocation.label -
 workingLocationProperties.customLocation.label These search terms also match predefined
 keywords against all display title translations of working location, out-of-office, and
 focus-time events. For example, searching for "Office" or "Bureau" returns working location
 events of type officeLocation, whereas searching for "Out of office" or "Abwesend" returns
 out-of-office events. Optional.
          

          • 

        




          

        • 

          getSharedExtendedProperty
          

          public List<String> getSharedExtendedProperty()
          

          Extended properties constraint specified as propertyName=value. Matches only shared properties.
     This parameter might be repeated multiple times to return events that match all given constraints.
          

          • 

        




          

        • 

          setSharedExtendedProperty
          

          public Calendar.Events.Watch setSharedExtendedProperty(List<String> sharedExtendedProperty)
          

          Extended properties constraint specified as propertyName=value. Matches only shared
 properties. This parameter might be repeated multiple times to return events that match all
 given constraints.
          

          • 

        




          

        • 

          getShowDeleted
          

          public Boolean getShowDeleted()
          

          Whether to include deleted events (with status equals "cancelled") in the result. Cancelled
     instances of recurring events (but not the underlying recurring event) will still be included if
     showDeleted and singleEvents are both False. If showDeleted and singleEvents are both True, only
     single instances of deleted events (but not the underlying recurring events) are returned.
     Optional. The default is False.
          

          • 

        




          

        • 

          setShowDeleted
          

          public Calendar.Events.Watch setShowDeleted(Boolean showDeleted)
          

          Whether to include deleted events (with status equals "cancelled") in the result. Cancelled
 instances of recurring events (but not the underlying recurring event) will still be
 included if showDeleted and singleEvents are both False. If showDeleted and singleEvents
 are both True, only single instances of deleted events (but not the underlying recurring
 events) are returned. Optional. The default is False.
          

          • 

        




          

        • 

          getShowHiddenInvitations
          

          public Boolean getShowHiddenInvitations()
          

          Whether to include hidden invitations in the result. Optional. The default is False.
          

          • 

        




          

        • 

          setShowHiddenInvitations
          

          public Calendar.Events.Watch setShowHiddenInvitations(Boolean showHiddenInvitations)
          

          Whether to include hidden invitations in the result. Optional. The default is False.
          

          • 

        




          

        • 

          getSingleEvents
          

          public Boolean getSingleEvents()
          

          Whether to expand recurring events into instances and only return single one-off events and
     instances of recurring events, but not the underlying recurring events themselves. Optional. The
     default is False.
          

          • 

        




          

        • 

          setSingleEvents
          

          public Calendar.Events.Watch setSingleEvents(Boolean singleEvents)
          

          Whether to expand recurring events into instances and only return single one-off events and
 instances of recurring events, but not the underlying recurring events themselves.
 Optional. The default is False.
          

          • 

        




          

        • 

          getSyncToken
          

          public String getSyncToken()
          

          Token obtained from the nextSyncToken field returned on the last page of results from the previous
     list request. It makes the result of this list request contain only entries that have changed since
     then. All events deleted since the previous list request will always be in the result set and it is
     not allowed to set showDeleted to False. There are several query parameters that cannot be
     specified together with nextSyncToken to ensure consistency of the client state.

     These are: - iCalUID - orderBy - privateExtendedProperty - q - sharedExtendedProperty - timeMin -
     timeMax - updatedMin All other query parameters should be the same as for the initial
     synchronization to avoid undefined behavior. If the syncToken expires, the server will respond with
     a 410 GONE response code and the client should clear its storage and perform a full synchronization
     without any syncToken. Learn more about incremental synchronization. Optional. The default is to
     return all entries.
          

          • 

        




          

        • 

          setSyncToken
          

          public Calendar.Events.Watch setSyncToken(String syncToken)
          

          Token obtained from the nextSyncToken field returned on the last page of results from the
 previous list request. It makes the result of this list request contain only entries that
 have changed since then. All events deleted since the previous list request will always be
 in the result set and it is not allowed to set showDeleted to False. There are several
 query parameters that cannot be specified together with nextSyncToken to ensure consistency
 of the client state.

 These are: - iCalUID - orderBy - privateExtendedProperty - q - sharedExtendedProperty -
 timeMin - timeMax - updatedMin All other query parameters should be the same as for the
 initial synchronization to avoid undefined behavior. If the syncToken expires, the server
 will respond with a 410 GONE response code and the client should clear its storage and
 perform a full synchronization without any syncToken. Learn more about incremental
 synchronization. Optional. The default is to return all entries.
          

          • 

        




          

        • 

          getTimeMax
          

          public com.google.api.client.util.DateTime getTimeMax()
          

          Upper bound (exclusive) for an event's start time to filter by. Optional. The default is not to
     filter by start time. Must be an RFC3339 timestamp with mandatory time zone offset, for example,
     2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If
     timeMin is set, timeMax must be greater than timeMin.
          

          • 

        




          

        • 

          setTimeMax
          

          public Calendar.Events.Watch setTimeMax(com.google.api.client.util.DateTime timeMax)
          

          Upper bound (exclusive) for an event's start time to filter by. Optional. The default is
 not to filter by start time. Must be an RFC3339 timestamp with mandatory time zone offset,
 for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided
 but are ignored. If timeMin is set, timeMax must be greater than timeMin.
          

          • 

        




          

        • 

          getTimeMin
          

          public com.google.api.client.util.DateTime getTimeMin()
          

          Lower bound (exclusive) for an event's end time to filter by. Optional. The default is not to
     filter by end time. Must be an RFC3339 timestamp with mandatory time zone offset, for example,
     2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If
     timeMax is set, timeMin must be smaller than timeMax.
          

          • 

        




          

        • 

          setTimeMin
          

          public Calendar.Events.Watch setTimeMin(com.google.api.client.util.DateTime timeMin)
          

          Lower bound (exclusive) for an event's end time to filter by. Optional. The default is not
 to filter by end time. Must be an RFC3339 timestamp with mandatory time zone offset, for
 example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but
 are ignored. If timeMax is set, timeMin must be smaller than timeMax.
          

          • 

        




          

        • 

          getTimeZone
          

          public String getTimeZone()
          

          Time zone used in the response. Optional. The default is the time zone of the calendar.
          

          • 

        




          

        • 

          setTimeZone
          

          public Calendar.Events.Watch setTimeZone(String timeZone)
          

          Time zone used in the response. Optional. The default is the time zone of the calendar.
          

          • 

        




          

        • 

          getUpdatedMin
          

          public com.google.api.client.util.DateTime getUpdatedMin()
          

          Lower bound for an event's last modification time (as a RFC3339 timestamp) to filter by. When
     specified, entries deleted since this time will always be included regardless of showDeleted.
     Optional. The default is not to filter by last modification time.
          

          • 

        




          

        • 

          setUpdatedMin
          

          public Calendar.Events.Watch setUpdatedMin(com.google.api.client.util.DateTime updatedMin)
          

          Lower bound for an event's last modification time (as a RFC3339 timestamp) to filter by.
 When specified, entries deleted since this time will always be included regardless of
 showDeleted. Optional. The default is not to filter by last modification time.
          

          • 

        





        • 

      

      • 

    

    

    



    



    Skip navigation links
    





    

    




    


    

    



    



    


    Copyright © 2011–2024 Google. All rights reserved.




    © 2015 - 2024 Weber Informatics LLC | Privacy Policy