Class: Google::Apis::CalendarV3::Event

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
generated/google/apis/calendar_v3/classes.rb,
generated/google/apis/calendar_v3/representations.rb,
generated/google/apis/calendar_v3/representations.rb

Defined Under Namespace

Classes: Creator, ExtendedProperties, Gadget, Organizer, Reminders, Source

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Google::Apis::Core::JsonObjectSupport

#to_json

Methods included from Google::Apis::Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Event

Returns a new instance of Event.


897
898
899
# File 'generated/google/apis/calendar_v3/classes.rb', line 897

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#anyone_can_add_selfBoolean Also known as: anyone_can_add_self?

Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False. Corresponds to the JSON property anyoneCanAddSelf

Returns:

  • (Boolean)

644
645
646
# File 'generated/google/apis/calendar_v3/classes.rb', line 644

def anyone_can_add_self
  @anyone_can_add_self
end

#attachmentsArray<Google::Apis::CalendarV3::EventAttachment>

File attachments for the event. Currently only Google Drive attachments are supported. In order to modify attachments the supportsAttachments request parameter should be set to true. There can be at most 25 attachments per event, Corresponds to the JSON property attachments


654
655
656
# File 'generated/google/apis/calendar_v3/classes.rb', line 654

def attachments
  @attachments
end

#attendeesArray<Google::Apis::CalendarV3::EventAttendee>

The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. Corresponds to the JSON property attendees


660
661
662
# File 'generated/google/apis/calendar_v3/classes.rb', line 660

def attendees
  @attendees
end

#attendees_omittedBoolean Also known as: attendees_omitted?

Whether attendees may have been omitted from the event's representation. When retrieving an event, this may be due to a restriction specified by the maxAttendee query parameter. When updating an event, this can be used to only update the participant's response. Optional. The default is False. Corresponds to the JSON property attendeesOmitted

Returns:

  • (Boolean)

668
669
670
# File 'generated/google/apis/calendar_v3/classes.rb', line 668

def attendees_omitted
  @attendees_omitted
end

#color_idString

The color of the event. This is an ID referring to an entry in the event section of the colors definition (see the colors endpoint). Optional. Corresponds to the JSON property colorId

Returns:

  • (String)

675
676
677
# File 'generated/google/apis/calendar_v3/classes.rb', line 675

def color_id
  @color_id
end

#createdDateTime

Creation time of the event (as a RFC3339 timestamp). Read-only. Corresponds to the JSON property created

Returns:

  • (DateTime)

680
681
682
# File 'generated/google/apis/calendar_v3/classes.rb', line 680

def created
  @created
end

#creatorGoogle::Apis::CalendarV3::Event::Creator

The creator of the event. Read-only. Corresponds to the JSON property creator


685
686
687
# File 'generated/google/apis/calendar_v3/classes.rb', line 685

def creator
  @creator
end

#descriptionString

Description of the event. Optional. Corresponds to the JSON property description

Returns:

  • (String)

690
691
692
# File 'generated/google/apis/calendar_v3/classes.rb', line 690

def description
  @description
end

#endGoogle::Apis::CalendarV3::EventDateTime

The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance. Corresponds to the JSON property end


696
697
698
# File 'generated/google/apis/calendar_v3/classes.rb', line 696

def end
  @end
end

#end_time_unspecifiedBoolean Also known as: end_time_unspecified?

Whether the end time is actually unspecified. An end time is still provided for compatibility reasons, even if this attribute is set to True. The default is False. Corresponds to the JSON property endTimeUnspecified

Returns:

  • (Boolean)

703
704
705
# File 'generated/google/apis/calendar_v3/classes.rb', line 703

def end_time_unspecified
  @end_time_unspecified
end

#etagString

ETag of the resource. Corresponds to the JSON property etag

Returns:

  • (String)

709
710
711
# File 'generated/google/apis/calendar_v3/classes.rb', line 709

def etag
  @etag
end

#extended_propertiesGoogle::Apis::CalendarV3::Event::ExtendedProperties

Extended properties of the event. Corresponds to the JSON property extendedProperties


714
715
716
# File 'generated/google/apis/calendar_v3/classes.rb', line 714

def extended_properties
  @extended_properties
end

#gadgetGoogle::Apis::CalendarV3::Event::Gadget

A gadget that extends this event. Corresponds to the JSON property gadget


719
720
721
# File 'generated/google/apis/calendar_v3/classes.rb', line 719

def gadget
  @gadget
end

#guests_can_invite_othersBoolean Also known as: guests_can_invite_others?

Whether attendees other than the organizer can invite others to the event. Optional. The default is True. Corresponds to the JSON property guestsCanInviteOthers

Returns:

  • (Boolean)

725
726
727
# File 'generated/google/apis/calendar_v3/classes.rb', line 725

def guests_can_invite_others
  @guests_can_invite_others
end

#guests_can_modifyBoolean Also known as: guests_can_modify?

Whether attendees other than the organizer can modify the event. Optional. The default is False. Corresponds to the JSON property guestsCanModify

Returns:

  • (Boolean)

732
733
734
# File 'generated/google/apis/calendar_v3/classes.rb', line 732

def guests_can_modify
  @guests_can_modify
end

#guests_can_see_other_guestsBoolean Also known as: guests_can_see_other_guests?

Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True. Corresponds to the JSON property guestsCanSeeOtherGuests

Returns:

  • (Boolean)

739
740
741
# File 'generated/google/apis/calendar_v3/classes.rb', line 739

def guests_can_see_other_guests
  @guests_can_see_other_guests
end

An absolute link to the Google+ hangout associated with this event. Read-only. Corresponds to the JSON property hangoutLink

Returns:

  • (String)

745
746
747
# File 'generated/google/apis/calendar_v3/classes.rb', line 745

def hangout_link
  @hangout_link
end

An absolute link to this event in the Google Calendar Web UI. Read-only. Corresponds to the JSON property htmlLink

Returns:

  • (String)

750
751
752
# File 'generated/google/apis/calendar_v3/classes.rb', line 750

def html_link
  @html_link
end

#i_cal_uidString

Event unique identifier as defined in RFC5545. It is used to uniquely identify events accross calendaring systems and must be supplied when importing events via the import method. Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs. Corresponds to the JSON property iCalUID

Returns:

  • (String)

761
762
763
# File 'generated/google/apis/calendar_v3/classes.rb', line 761

def i_cal_uid
  @i_cal_uid
end

#idString

Opaque identifier of the event. When creating new single or recurring events, you can specify their IDs. Provided IDs must follow these rules:

  • characters allowed in the ID are those used in base32hex encoding, i.e. lowercase letters a-v and digits 0-9, see section 3.1.2 in RFC2938
  • the length of the ID must be between 5 and 1024 characters
  • the ID must be unique per calendar Due to the globally distributed nature of the system, we cannot guarantee that ID collisions will be detected at event creation time. To minimize the risk of collisions we recommend using an established UUID algorithm such as one described in RFC4122. If you do not specify an ID, it will be automatically generated by the server. Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs. Corresponds to the JSON property id

Returns:

  • (String)

779
780
781
# File 'generated/google/apis/calendar_v3/classes.rb', line 779

def id
  @id
end

#kindString

Type of the resource ("calendar#event"). Corresponds to the JSON property kind

Returns:

  • (String)

784
785
786
# File 'generated/google/apis/calendar_v3/classes.rb', line 784

def kind
  @kind
end

#locationString

Geographic location of the event as free-form text. Optional. Corresponds to the JSON property location

Returns:

  • (String)

789
790
791
# File 'generated/google/apis/calendar_v3/classes.rb', line 789

def location
  @location
end

#lockedBoolean Also known as: locked?

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". The default is False. Read-Only. Corresponds to the JSON property locked

Returns:

  • (Boolean)

796
797
798
# File 'generated/google/apis/calendar_v3/classes.rb', line 796

def locked
  @locked
end

#organizerGoogle::Apis::CalendarV3::Event::Organizer

The organizer of the event. If the organizer is also an attendee, this is indicated with a separate entry in attendees with the organizer field set to True. To change the organizer, use the move operation. Read-only, except when importing an event. Corresponds to the JSON property organizer


805
806
807
# File 'generated/google/apis/calendar_v3/classes.rb', line 805

def organizer
  @organizer
end

#original_start_timeGoogle::Apis::CalendarV3::EventDateTime

For an instance of a recurring event, this is the time at which this event would start according to the recurrence data in the recurring event identified by recurringEventId. Immutable. Corresponds to the JSON property originalStartTime


812
813
814
# File 'generated/google/apis/calendar_v3/classes.rb', line 812

def original_start_time
  @original_start_time
end

#private_copyBoolean Also known as: private_copy?

Whether this is a private event copy where changes are not shared with other copies on other calendars. Optional. Immutable. The default is False. Corresponds to the JSON property privateCopy

Returns:

  • (Boolean)

818
819
820
# File 'generated/google/apis/calendar_v3/classes.rb', line 818

def private_copy
  @private_copy
end

#recurrenceArray<String>

List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event, as specified in RFC5545. Note that DTSTART and DTEND lines are not allowed in this field; event start and end times are specified in the start and end fields. This field is omitted for single events or instances of recurring events. Corresponds to the JSON property recurrence

Returns:

  • (Array<String>)

828
829
830
# File 'generated/google/apis/calendar_v3/classes.rb', line 828

def recurrence
  @recurrence
end

#recurring_event_idString

For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable. Corresponds to the JSON property recurringEventId

Returns:

  • (String)

834
835
836
# File 'generated/google/apis/calendar_v3/classes.rb', line 834

def recurring_event_id
  @recurring_event_id
end

#remindersGoogle::Apis::CalendarV3::Event::Reminders

Information about the event's reminders for the authenticated user. Corresponds to the JSON property reminders


839
840
841
# File 'generated/google/apis/calendar_v3/classes.rb', line 839

def reminders
  @reminders
end

#sequenceFixnum

Sequence number as per iCalendar. Corresponds to the JSON property sequence

Returns:

  • (Fixnum)

844
845
846
# File 'generated/google/apis/calendar_v3/classes.rb', line 844

def sequence
  @sequence
end

#sourceGoogle::Apis::CalendarV3::Event::Source

Source from which the event was created. For example, a web page, an email message or any document identifiable by an URL with HTTP or HTTPS scheme. Can only be seen or modified by the creator of the event. Corresponds to the JSON property source


851
852
853
# File 'generated/google/apis/calendar_v3/classes.rb', line 851

def source
  @source
end

#startGoogle::Apis::CalendarV3::EventDateTime

The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance. Corresponds to the JSON property start


857
858
859
# File 'generated/google/apis/calendar_v3/classes.rb', line 857

def start
  @start
end

#statusString

Status of the event. Optional. Possible values are:

  • "confirmed" - The event is confirmed. This is the default status.
  • "tentative" - The event is tentatively confirmed.
  • "cancelled" - The event is cancelled. Corresponds to the JSON property status

Returns:

  • (String)

865
866
867
# File 'generated/google/apis/calendar_v3/classes.rb', line 865

def status
  @status
end

#summaryString

Title of the event. Corresponds to the JSON property summary

Returns:

  • (String)

870
871
872
# File 'generated/google/apis/calendar_v3/classes.rb', line 870

def summary
  @summary
end

#transparencyString

Whether the event blocks time on the calendar. Optional. Possible values are:

  • "opaque" - The event blocks time on the calendar. This is the default value.
  • "transparent" - The event does not block time on the calendar. Corresponds to the JSON property transparency

Returns:

  • (String)

877
878
879
# File 'generated/google/apis/calendar_v3/classes.rb', line 877

def transparency
  @transparency
end

#updatedDateTime

Last modification time of the event (as a RFC3339 timestamp). Read-only. Corresponds to the JSON property updated

Returns:

  • (DateTime)

882
883
884
# File 'generated/google/apis/calendar_v3/classes.rb', line 882

def updated
  @updated
end

#visibilityString

Visibility of the event. Optional. Possible values are:

  • "default" - Uses the default visibility for events on the calendar. This is the default value.
  • "public" - The event is public and event details are visible to all readers of the calendar.
  • "private" - The event is private and only event attendees may view event details.
  • "confidential" - The event is private. This value is provided for compatibility reasons. Corresponds to the JSON property visibility

Returns:

  • (String)

895
896
897
# File 'generated/google/apis/calendar_v3/classes.rb', line 895

def visibility
  @visibility
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
# File 'generated/google/apis/calendar_v3/classes.rb', line 902

def update!(**args)
  @anyone_can_add_self = args[:anyone_can_add_self] if args.key?(:anyone_can_add_self)
  @attachments = args[:attachments] if args.key?(:attachments)
  @attendees = args[:attendees] if args.key?(:attendees)
  @attendees_omitted = args[:attendees_omitted] if args.key?(:attendees_omitted)
  @color_id = args[:color_id] if args.key?(:color_id)
  @created = args[:created] if args.key?(:created)
  @creator = args[:creator] if args.key?(:creator)
  @description = args[:description] if args.key?(:description)
  @end = args[:end] if args.key?(:end)
  @end_time_unspecified = args[:end_time_unspecified] if args.key?(:end_time_unspecified)
  @etag = args[:etag] if args.key?(:etag)
  @extended_properties = args[:extended_properties] if args.key?(:extended_properties)
  @gadget = args[:gadget] if args.key?(:gadget)
  @guests_can_invite_others = args[:guests_can_invite_others] if args.key?(:guests_can_invite_others)
  @guests_can_modify = args[:guests_can_modify] if args.key?(:guests_can_modify)
  @guests_can_see_other_guests = args[:guests_can_see_other_guests] if args.key?(:guests_can_see_other_guests)
  @hangout_link = args[:hangout_link] if args.key?(:hangout_link)
  @html_link = args[:html_link] if args.key?(:html_link)
  @i_cal_uid = args[:i_cal_uid] if args.key?(:i_cal_uid)
  @id = args[:id] if args.key?(:id)
  @kind = args[:kind] if args.key?(:kind)
  @location = args[:location] if args.key?(:location)
  @locked = args[:locked] if args.key?(:locked)
  @organizer = args[:organizer] if args.key?(:organizer)
  @original_start_time = args[:original_start_time] if args.key?(:original_start_time)
  @private_copy = args[:private_copy] if args.key?(:private_copy)
  @recurrence = args[:recurrence] if args.key?(:recurrence)
  @recurring_event_id = args[:recurring_event_id] if args.key?(:recurring_event_id)
  @reminders = args[:reminders] if args.key?(:reminders)
  @sequence = args[:sequence] if args.key?(:sequence)
  @source = args[:source] if args.key?(:source)
  @start = args[:start] if args.key?(:start)
  @status = args[:status] if args.key?(:status)
  @summary = args[:summary] if args.key?(:summary)
  @transparency = args[:transparency] if args.key?(:transparency)
  @updated = args[:updated] if args.key?(:updated)
  @visibility = args[:visibility] if args.key?(:visibility)
end