Package org.springframework.social.google.api.calendar

Class Event

    • Constructor Detail

      • Event

        protected Event()
        Constructor protected so instances must be retrieved from Google Calendar itself. Only some of the possible modifications are currently implemented.

    • Method Detail

      • getStatus

        public EventStatus getStatus()
        The status of this event.
        Returns:
        the value or null if none.

      • setStatus

        public Event setStatus​(EventStatus status)
        Sets the status of this event.
        Parameters:
        status - the new status, or null for none.
        Returns:
        this event, for chaining.

      • getHtmlLink

        public String getHtmlLink()
        An absolute link to this event in the Google Calendar Web UI.
        Returns:
        the value or null if none.

      • getCreated

        public Date getCreated()
        The creation time of this event.
        Returns:
        the value or null if none.

      • getUpdated

        public Date getUpdated()
        The last modification time of this event.
        Returns:
        the value or null if none.

      • getSummary

        public String getSummary()
        The title of this event.
        Returns:
        the value or null if none.

      • setSummary

        public Event setSummary​(String summary)
        Sets the title of this event.
        Parameters:
        summary - the new title.
        Returns:
        this event, to allow chaining.

      • getDescription

        public String getDescription()
        The description of this event.
        Returns:
        the value or null if none.

      • getLocation

        public String getLocation()
        The geographic location of this event as free-form text.
        Returns:
        the value or null if none.

      • setLocation

        public Event setLocation​(String location)
        Sets the location of this event.
        Parameters:
        location - the new location, or null for none.
        Returns:
        this event, to allow chaining.

      • getColorId

        public String getColorId()
        The colour of this event.
        Returns:
        the value or null if none.

      • getCreator

        public Event.Creator getCreator()
        The creator of this event.
        Returns:
        the value or null if none.

      • getOrganizer

        public Event.Organizer getOrganizer()
        The organizer of this event. If the organizer is also an attendee, this is indicated with a separate entry in attendees with the organizer field set to True.
        Returns:
        the value or null if none.

      • getStart

        public Event.DateTimeTimezone getStart()
        The (inclusive) start time of this event. For a recurring event, this is the start time of the first instance.
        Returns:
        the value or null if none.

      • getEnd

        public Event.DateTimeTimezone getEnd()
        The (exclusive) end time of this event. For a recurring event, this is the end time of the first instance.
        Returns:
        the value or null if none.

      • isEndTimeUnspecified

        public Boolean isEndTimeUnspecified()
        Whether the end time is actually unspecified. An end time is still provided for compatibility reasons, even if this attribute is set to true. If true, the end time should be disregarded.
        Returns:
        the value or null if none.

      • getRecurringEventId

        public String getRecurringEventId()
        For an instance of a recurring event, return this event ID of the recurring event itself.
        Returns:
        the value or null if none.

      • getOriginalStartTime

        public Event.DateTimeTimezone getOriginalStartTime()
        For an instance of a recurring event, return the time at which this event would start according to the recurrence data in the recurring event identified by recurringEventId.
        Returns:
        the value or null if none.

      • getTransparency

        public Transparency getTransparency()
        Whether this event blocks time on the calendar.
        Returns:
        the value or null if none.

      • getVisibility

        public Visibility getVisibility()
        The visibility of this event.
        Returns:
        the value or null if none.

      • getiCalUid

        public String getiCalUid()
        This event's ID in the iCalendar format.
        Returns:
        the value or null if none.

      • getSequence

        public Integer getSequence()
        The sequence number as per iCalendar.
        Returns:
        the value or null if none.

      • isAttendeesOmitted

        public Boolean isAttendeesOmitted()
        Whether attendees may have been omitted from this event's representation. When retrieving an event, this may be due to a restriction specified by the maxAttendee query parameter.
        Returns:
        the value or null if none.

      • getHangoutLink

        public String getHangoutLink()
        An absolute link to the Google+ hangout associated with this event.
        Returns:
        the value or null if none.

      • isAnyoneCanAddSelf

        public Boolean isAnyoneCanAddSelf()
        Whether anyone can invite themselves to this event.
        Returns:
        the value or null if none.

      • isGuestsCanInviteOthers

        public Boolean isGuestsCanInviteOthers()
        Whether attendees other than the organizer can invite others to this event.
        Returns:
        the value or null if none.

      • isGuestsCanModify

        public Boolean isGuestsCanModify()
        Whether attendees other than the organizer can modify this event.
        Returns:
        the value or null if none.

      • isGuestsCanSeeOtherGuests

        public Boolean isGuestsCanSeeOtherGuests()
        Whether attendees other than the organizer can see who this event's attendees are.
        Returns:
        the value or null if none.

      • isPrivateCopy

        public Boolean isPrivateCopy()
        Whether this is a private event copy where changes are not shared with other copies on other calendars.
        Returns:
        the value or null if none.

      • isLocked

        public Boolean isLocked()
        Whether this is a locked event copy where no changes can be made to the main event fields "summary", "description", "location", "start", "end" or "recurrence".
        Returns:
        the value or null if none.

      • getRecurrence

        public List<String> getRecurrence()
        A list of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event. This field is omitted for single events or instances of recurring events.
        Returns:
        the value or null if none.

      • setRecurrence

        public Event setRecurrence​(List<String> list)
        Replaces the list of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event.
        Parameters:
        list - the new list, or null for none.
        Returns:
        this event, to allow chaining.

      • getAttendees

        public List<Event.Attendee> getAttendees()
        The attendees of this event.
        Returns:
        the value or null if none.

      • getExtendedProperties

        public Event.ExtendedProperties getExtendedProperties()
        The extended properties of this event.
        Returns:
        the value or null if none.

      • getGadget

        public Event.Gadget getGadget()
        A gadget that extends this event.
        Returns:
        the value or null if none.

      • getReminders

        public Event.Reminders getReminders()
        Information about this event's reminders for the authenticated user.
        Returns:
        the value or null if none.

      • getSource

        public Event.Source getSource()
        The source of an event from which this event was created; for example a web page, an email message or any document identifiable by an URL using HTTP/HTTPS protocol. Accessible only by the creator of this event.
        Returns:
        the value or null if none.

      • setGuestsCanInviteOthers

        public Event setGuestsCanInviteOthers​(Boolean guestsCanInviteOthers)
        Sets whether attendees other than the organizer can invite others to the event.
        Parameters:
        guestsCanInviteOthers - the new value.
        Returns:
        this event, to allow chaining.

      • setGuestsCanSeeOtherGuests

        public Event setGuestsCanSeeOtherGuests​(Boolean guestsCanSeeOtherGuests)
        Sets whether attendees other than the organizer can see who the event's attendees are.
        Parameters:
        guestsCanSeeOtherGuests - the new value.
        Returns:
        this event, to allow chaining.