![]() |
![]() |
![]() |
GData Reference Manual | ![]() |
---|---|---|---|---|
Top | Description | Object Hierarchy | Properties |
#include <gdata/services/calendar/gdata-calendar-event.h> GDataCalendarEvent; GDataCalendarEventClass; GDataCalendarEvent * gdata_calendar_event_new (const gchar *id
); GList * gdata_calendar_event_get_people (GDataCalendarEvent *self
); void gdata_calendar_event_add_person (GDataCalendarEvent *self
,GDataGDWho *who
); GList * gdata_calendar_event_get_places (GDataCalendarEvent *self
); void gdata_calendar_event_add_place (GDataCalendarEvent *self
,GDataGDWhere *where
); GList * gdata_calendar_event_get_times (GDataCalendarEvent *self
); gboolean gdata_calendar_event_get_primary_time (GDataCalendarEvent *self
,GTimeVal *start_time
,GTimeVal *end_time
,GDataGDWhen **when
); void gdata_calendar_event_add_time (GDataCalendarEvent *self
,GDataGDWhen *when
); const gchar * gdata_calendar_event_get_recurrence (GDataCalendarEvent *self
); void gdata_calendar_event_set_recurrence (GDataCalendarEvent *self
,const gchar *recurrence
); void gdata_calendar_event_get_original_event_details (GDataCalendarEvent *self
,gchar **event_id
,gchar **event_uri
); gboolean gdata_calendar_event_is_exception (GDataCalendarEvent *self
); gboolean gdata_calendar_event_get_anyone_can_add_self (GDataCalendarEvent *self
); void gdata_calendar_event_set_anyone_can_add_self (GDataCalendarEvent *self
,gboolean anyone_can_add_self
); gboolean gdata_calendar_event_get_guests_can_invite_others (GDataCalendarEvent *self
); void gdata_calendar_event_set_guests_can_invite_others (GDataCalendarEvent *self
,gboolean guests_can_invite_others
); gboolean gdata_calendar_event_get_guests_can_modify (GDataCalendarEvent *self
); void gdata_calendar_event_set_guests_can_modify (GDataCalendarEvent *self
,gboolean guests_can_modify
); gboolean gdata_calendar_event_get_guests_can_see_guests (GDataCalendarEvent *self
); void gdata_calendar_event_set_guests_can_see_guests (GDataCalendarEvent *self
,gboolean guests_can_see_guests
); guint gdata_calendar_event_get_sequence (GDataCalendarEvent *self
); void gdata_calendar_event_set_sequence (GDataCalendarEvent *self
,guint sequence
); const gchar * gdata_calendar_event_get_status (GDataCalendarEvent *self
); void gdata_calendar_event_set_status (GDataCalendarEvent *self
,const gchar *status
); const gchar * gdata_calendar_event_get_transparency (GDataCalendarEvent *self
); void gdata_calendar_event_set_transparency (GDataCalendarEvent *self
,const gchar *transparency
); const gchar * gdata_calendar_event_get_uid (GDataCalendarEvent *self
); void gdata_calendar_event_set_uid (GDataCalendarEvent *self
,const gchar *uid
); const gchar * gdata_calendar_event_get_visibility (GDataCalendarEvent *self
); void gdata_calendar_event_set_visibility (GDataCalendarEvent *self
,const gchar *visibility
); void gdata_calendar_event_get_edited (GDataCalendarEvent *self
,GTimeVal *edited
);
"anyone-can-add-self" gboolean : Read / Write "edited" GDataTimeVal* : Read "guests-can-invite-others" gboolean : Read / Write "guests-can-modify" gboolean : Read / Write "guests-can-see-guests" gboolean : Read / Write "original-event-id" gchar* : Read "original-event-uri" gchar* : Read "recurrence" gchar* : Read / Write "sequence" guint : Read / Write "status" gchar* : Read / Write "transparency" gchar* : Read / Write "uid" gchar* : Read / Write "visibility" gchar* : Read / Write
GDataCalendarEvent is a subclass of GDataEntry to represent an event on a calendar from Google Calendar.
For more details of Google Calendar's GData API, see the online documentation.
typedef struct _GDataCalendarEvent GDataCalendarEvent;
All the fields in the GDataCalendarEvent structure are private and should never be accessed directly.
typedef struct { } GDataCalendarEventClass;
All the fields in the GDataCalendarEventClass structure are private and should never be accessed directly.
GDataCalendarEvent * gdata_calendar_event_new (const gchar *id
);
Creates a new GDataCalendarEvent with the given ID and default properties.
|
the event's ID, or NULL
|
Returns : |
a new GDataCalendarEvent; unref with g_object_unref()
|
GList * gdata_calendar_event_get_people (GDataCalendarEvent *self
);
Gets a list of the people attending the event.
|
a GDataCalendarEvent |
Returns : |
a GList of GDataGDWhos, or NULL . [element-type GData.GDWho][transfer none GData.GDWho]
|
Since 0.2.0
void gdata_calendar_event_add_person (GDataCalendarEvent *self
,GDataGDWho *who
);
Adds the person who
to the event as a guest (attendee, organiser, performer, etc.), and increments its reference count.
Duplicate people will not be added to the list.
|
a GDataCalendarEvent |
|
a GDataGDWho to add |
GList * gdata_calendar_event_get_places (GDataCalendarEvent *self
);
Gets a list of the locations associated with the event.
|
a GDataCalendarEvent |
Returns : |
a GList of GDataGDWheres, or NULL . [element-type GData.GDWhere][transfer none GData.GDWhere]
|
Since 0.2.0
void gdata_calendar_event_add_place (GDataCalendarEvent *self
,GDataGDWhere *where
);
Adds the place where
to the event as a location and increments its reference count.
Duplicate places will not be added to the list.
|
a GDataCalendarEvent |
|
a GDataGDWhere to add |
GList * gdata_calendar_event_get_times (GDataCalendarEvent *self
);
Gets a list of the time periods associated with the event.
|
a GDataCalendarEvent |
Returns : |
a GList of GDataGDWhens, or NULL . [element-type GData.GDWhen][transfer none GData.GDWhen]
|
Since 0.2.0
gboolean gdata_calendar_event_get_primary_time (GDataCalendarEvent *self
,GTimeVal *start_time
,GTimeVal *end_time
,GDataGDWhen **when
);
Gets the first time period associated with the event, conveniently returning just its start and end times if required.
If there are no time periods, or more than one time period, associated with the event, FALSE
will
be returned, and the parameters will remain unmodified.
|
a GDataCalendarEvent |
|
a GTimeVal for the start time, or NULL . [out caller-allocates]
|
|
a GTimeVal for the end time, or NULL . [out caller-allocates]
|
|
a GDataGDWhen for the primary time structure, or NULL . [out callee-allocates][transfer none callee-allocates]
|
Returns : |
TRUE if there is only one time period associated with the event, FALSE otherwise
|
Since 0.2.0
void gdata_calendar_event_add_time (GDataCalendarEvent *self
,GDataGDWhen *when
);
Adds when
to the event as a time period when the event happens, and increments its reference count.
Duplicate times will not be added to the list.
|
a GDataCalendarEvent |
|
a GDataGDWhen to add |
Since 0.2.0
const gchar * gdata_calendar_event_get_recurrence (GDataCalendarEvent *self
);
Gets the "recurrence" property.
|
a GDataCalendarEvent |
Returns : |
the event recurrence patterns, or NULL
|
Since 0.3.0
void gdata_calendar_event_set_recurrence (GDataCalendarEvent *self
,const gchar *recurrence
);
Sets the "recurrence" property to the new recurrence, recurrence
.
Set recurrence
to NULL
to unset the property in the event.
|
a GDataCalendarEvent |
|
a new event recurrence, or NULL . [allow-none]
|
Since 0.3.0
void gdata_calendar_event_get_original_event_details (GDataCalendarEvent *self
,gchar **event_id
,gchar **event_uri
);
Gets details of the original event, if this event is an exception to a recurring event. The original
event's ID and the URI of the event's XML are returned in event_id
and event_uri
, respectively.
If this event is not an exception to a recurring event, event_id
and event_uri
will be set to NULL
.
See gdata_calendar_event_is_exception()
to determine more simply whether an event is an exception to a
recurring event.
If both event_id
and event_uri
are NULL
, this function is a no-op. Otherwise, they should both be
freed with g_free()
.
|
a GDataCalendarEvent |
|
return location for the original event's ID, or NULL . [out callee-allocates][transfer full callee-allocates]
|
|
return location for the original event's URI, or NULL . [out callee-allocates][transfer full callee-allocates]
|
Since 0.3.0
gboolean gdata_calendar_event_is_exception (GDataCalendarEvent *self
);
Determines whether the event is an exception to a recurring event. If it is, details of the original event
can be retrieved using gdata_calendar_event_get_original_event_details()
.
|
a GDataCalendarEvent |
Returns : |
TRUE if the event is an exception, FALSE otherwise
|
Since 0.3.0
gboolean gdata_calendar_event_get_anyone_can_add_self
(GDataCalendarEvent *self
);
Gets the "anyone-can-add-self" property.
|
a GDataCalendarEvent |
Returns : |
TRUE if anyone can add themselves as an attendee to the event, FALSE otherwise
|
void gdata_calendar_event_set_anyone_can_add_self (GDataCalendarEvent *self
,gboolean anyone_can_add_self
);
Sets the "anyone-can-add-self" property to anyone_can_add_self
.
|
a GDataCalendarEvent |
|
TRUE if anyone can add themselves as an attendee to the event, FALSE otherwise
|
gboolean gdata_calendar_event_get_guests_can_invite_others
(GDataCalendarEvent *self
);
Gets the "guests-can-invite-others" property.
|
a GDataCalendarEvent |
Returns : |
TRUE if attendees can invite others to the event, FALSE otherwise
|
void gdata_calendar_event_set_guests_can_invite_others (GDataCalendarEvent *self
,gboolean guests_can_invite_others
);
Sets the "guests-can-invite-others" property to guests_can_invite_others
.
|
a GDataCalendarEvent |
|
TRUE if attendees can invite others to the event, FALSE otherwise
|
gboolean gdata_calendar_event_get_guests_can_modify
(GDataCalendarEvent *self
);
Gets the "guests-can-modify" property.
|
a GDataCalendarEvent |
Returns : |
TRUE if attendees can modify the original event, FALSE otherwise
|
void gdata_calendar_event_set_guests_can_modify (GDataCalendarEvent *self
,gboolean guests_can_modify
);
Sets the "guests-can-modify" property to guests_can_modify
.
|
a GDataCalendarEvent |
|
TRUE if attendees can modify the original event, FALSE otherwise
|
gboolean gdata_calendar_event_get_guests_can_see_guests
(GDataCalendarEvent *self
);
Gets the "guests-can-see-guests" property.
|
a GDataCalendarEvent |
Returns : |
TRUE if attendees can see who's attending the event, FALSE otherwise
|
void gdata_calendar_event_set_guests_can_see_guests (GDataCalendarEvent *self
,gboolean guests_can_see_guests
);
Sets the "guests-can-see-guests" property to guests_can_see_guests
.
|
a GDataCalendarEvent |
|
TRUE if attendees can see who's attending the event, FALSE otherwise
|
guint gdata_calendar_event_get_sequence (GDataCalendarEvent *self
);
Gets the "sequence" property.
|
a GDataCalendarEvent |
Returns : |
the event's sequence number |
void gdata_calendar_event_set_sequence (GDataCalendarEvent *self
,guint sequence
);
Sets the "sequence" property to the new sequence number, sequence
.
|
a GDataCalendarEvent |
|
a new sequence number, or NULL
|
const gchar * gdata_calendar_event_get_status (GDataCalendarEvent *self
);
Gets the "status" property.
|
a GDataCalendarEvent |
Returns : |
the event status, or NULL
|
Since 0.2.0
void gdata_calendar_event_set_status (GDataCalendarEvent *self
,const gchar *status
);
Sets the "status" property to the new status, status
.
Set status
to NULL
to unset the property in the event.
|
a GDataCalendarEvent |
|
a new event status, or NULL . [allow-none]
|
Since 0.2.0
const gchar * gdata_calendar_event_get_transparency
(GDataCalendarEvent *self
);
Gets the "transparency" property.
|
a GDataCalendarEvent |
Returns : |
the event transparency, or NULL
|
void gdata_calendar_event_set_transparency (GDataCalendarEvent *self
,const gchar *transparency
);
Sets the "transparency" property to the new transparency, transparency
.
Set transparency
to NULL
to unset the property in the event.
|
a GDataCalendarEvent |
|
a new event transparency, or NULL . [allow-none]
|
const gchar * gdata_calendar_event_get_uid (GDataCalendarEvent *self
);
Gets the "uid" property.
|
a GDataCalendarEvent |
Returns : |
the event's UID, or NULL
|
void gdata_calendar_event_set_uid (GDataCalendarEvent *self
,const gchar *uid
);
Sets the "uid" property to the new UID, uid
.
Set uid
to NULL
to unset the property in the event.
|
a GDataCalendarEvent |
|
a new event UID, or NULL . [allow-none]
|
const gchar * gdata_calendar_event_get_visibility (GDataCalendarEvent *self
);
Gets the "visibility" property.
|
a GDataCalendarEvent |
Returns : |
the event visibility, or NULL
|
void gdata_calendar_event_set_visibility (GDataCalendarEvent *self
,const gchar *visibility
);
Sets the "visibility" property to the new visibility, visibility
.
Set visibility
to NULL
to unset the property in the event.
|
a GDataCalendarEvent |
|
a new event visibility, or NULL . [allow-none]
|
void gdata_calendar_event_get_edited (GDataCalendarEvent *self
,GTimeVal *edited
);
Gets the "edited" property and puts it in edited
. If the property is unset,
both fields in the GTimeVal will be set to 0
.
|
a GDataCalendarEvent |
|
a GTimeVal. [out caller-allocates] |
"anyone-can-add-self"
property "anyone-can-add-self" gboolean : Read / Write
Indicates whether anyone can add themselves to the attendee list of the event.
Default value: FALSE
"edited"
property "edited" GDataTimeVal* : Read
The last time the event was edited. If the event has not been edited yet, the content indicates the time it was created.
For more information, see the Atom Publishing Protocol specification.
"guests-can-invite-others"
property "guests-can-invite-others" gboolean : Read / Write
Indicates whether event attendees may invite other people to the event.
For more information, see the GData specification.
Default value: FALSE
"guests-can-modify"
property "guests-can-modify" gboolean : Read / Write
Indicates whether event attendees may modify the original event, so that changes are visible to organizer and other attendees. Otherwise, any changes made by attendees will be restricted to that attendee's calendar.
For more information, see the GData specification.
Default value: FALSE
"guests-can-see-guests"
property "guests-can-see-guests" gboolean : Read / Write
Indicates whether event attendees can see other people invited to the event.
For more information, see the GData specification.
Default value: FALSE
"original-event-id"
property "original-event-id" gchar* : Read
The event ID for the original event, if this event is an exception to a recurring event.
Default value: NULL
Since 0.3.0
"original-event-uri"
property "original-event-uri" gchar* : Read
The event URI for the original event, if this event is an exception to a recurring event.
Default value: NULL
Since 0.3.0
"recurrence"
property "recurrence" gchar* : Read / Write
Represents the dates and times when a recurring event takes place. The returned string is in iCal format, as a list of properties.
For more information, see the GData specification.
Default value: NULL
Since 0.3.0
"sequence"
property "sequence" guint : Read / Write
The revision sequence number of the event as defined in Section 4.8.7.4 of RFC 2445.
Default value: 0
"status"
property "status" gchar* : Read / Write
The scheduling status of the event.
For more information, see the GData specification.
Default value: NULL
Since 0.2.0
"transparency"
property "transparency" gchar* : Read / Write
How the event is marked as consuming time on a calendar.
For more information, see the GData specification.
Default value: NULL
"uid"
property "uid" gchar* : Read / Write
The globally unique identifier (UID) of the event as defined in Section 4.8.4.7 of RFC 2445.
Default value: NULL
"visibility"
property "visibility" gchar* : Read / Write
The event's visibility to calendar users.
For more information, see the GData specification.
Default value: NULL