GData.CalendarCalendar¶

Subclasses:: None

Methods¶

Inherited:: GData.Entry (24), GData.Parsable (5), GObject.Object (37), GData.AccessHandler (2)
Structs:: GObject.ObjectClass (5)

class	`new` (id)
	`get_access_level` ()
	`get_color` ()
	`get_edited` ()
	`get_times_cleaned` ()
	`get_timezone` ()
	`is_hidden` ()
	`is_selected` ()
	`set_color` (color)
	`set_is_hidden` (is_hidden)
	`set_is_selected` (is_selected)
	`set_timezone` (_timezone)

Virtual Methods¶

Inherited:: GData.Parsable (9), GObject.Object (7), GData.AccessHandler (1)

Properties¶

Inherited:: GData.Entry (10), GData.Parsable (1)

Name	Type	Flags	Short Description
`access-level`	`str`	r	Indicates the access level the current user has to the calendar.
`color`	`GData.Color`	r/w	The background color used to highlight the calendar in the user’s browser.
`edited`	`int`	d/r	The last time the calendar was edited. `deprecated`
`is-hidden`	`bool`	r/w	Indicates whether the calendar is visible.
`is-selected`	`bool`	r/w	Indicates whether the calendar is selected.
`times-cleaned`	`int`	d/r	The number of times the calendar has been cleared of events. `deprecated`
`timezone`	`str`	r/w	The timezone in which the calendar’s times are given.

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access	Description
parent	`GData.Entry`	r

Class Details¶

class GData.CalendarCalendar(**kwargs)¶

Bases:: GData.Entry, GData.AccessHandler
Abstract:: No
Structure:: GData.CalendarCalendarClass

All the fields in the GData.CalendarCalendar structure are private and should never be accessed directly.

classmethod new(id)¶

Parameters:: id (str or None) – the calendar’s ID, or None
Returns:: a new GData.CalendarCalendar; unref with GObject.Object.unref()
Return type:: GData.CalendarCalendar

Creates a new GData.CalendarCalendar with the given ID and default properties.

get_access_level()¶

Returns:: the authenticated user’s access level to the calendar, or None
Return type:: str

Gets the GData.CalendarCalendar :access-level property.

get_color()¶

Returns:: a GData.Color
Return type:: color: GData.Color

Gets the GData.CalendarCalendar :color property and puts it in color.

get_edited()¶

Returns:: the UNIX timestamp for the time the calendar was last edited, or -1
Return type:: int

Gets the GData.CalendarCalendar :edited property. If the property is unset, -1 will be returned.

Deprecated since version 0.17.2: Unsupported by the online API any more. There is no replacement; this will always return -1.

get_times_cleaned()¶

Returns:: the number of times the calendar has been totally emptied
Return type:: int

Gets the GData.CalendarCalendar :times-cleaned property.

Deprecated since version 0.17.2: Unsupported by the online API any more. There is no replacement; this will always return 0.

get_timezone()¶

Returns:: the calendar’s timezone, or None
Return type:: str

Gets the GData.CalendarCalendar :timezone property.

is_hidden()¶

Returns:: True if the calendar is hidden, False otherwise
Return type:: bool

Gets the GData.CalendarCalendar :is-hidden property.

New in version 0.2.0.

is_selected()¶

Returns:: True if the calendar is selected, False otherwise
Return type:: bool

Gets the GData.CalendarCalendar :is-selected property.

New in version 0.2.0.

set_color(color)¶

Parameters:: color (GData.Color) – a new GData.Color

Sets the GData.CalendarCalendar :color property to color.

set_is_hidden(is_hidden)¶

Parameters:: is_hidden (bool) – True to hide the calendar, False otherwise

Sets the GData.CalendarCalendar :is-hidden property to is_hidden.

New in version 0.2.0.

set_is_selected(is_selected)¶

Parameters:: is_selected (bool) – True to select the calendar, False otherwise

Sets the GData.CalendarCalendar :is-selected property to is_selected.

New in version 0.2.0.

set_timezone(_timezone)¶

Parameters:: _timezone (str or None) – a new timezone, or None

Sets the GData.CalendarCalendar :timezone property to the new timezone, _timezone.

Set _timezone to None to unset the property in the calendar.

Property Details¶

GData.CalendarCalendar.props.access_level¶

Name:: access-level
Type:: str
Default Value:: None
Flags:: READABLE

Indicates the access level the current user has to the calendar. For example: GData.CALENDAR_ACCESS_ROLE_READ or GData.CALENDAR_ACCESS_ROLE_FREE_BUSY. The “current user” is the one authenticated against the service’s GData.Service :authorizer, or the guest user.

GData.CalendarCalendar.props.color¶

Name:: color
Type:: GData.Color
Default Value:: None
Flags:: READABLE, WRITABLE

The background color used to highlight the calendar in the user’s browser. This used to be restricted to a limited set of colours, but since 0.17.2 may be any RGB colour.

GData.CalendarCalendar.props.edited¶

Name:: edited
Type:: int
Default Value:: -1
Flags:: DEPRECATED, READABLE

The last time the calendar was edited. If the calendar has not been edited yet, the content indicates the time it was created.

For more information, see the Atom Publishing Protocol specification.

Deprecated since version 0.17.2: Unsupported by the online API any more. There is no replacement; this will always return -1.

GData.CalendarCalendar.props.is_hidden¶

Name:: is-hidden
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE

Indicates whether the calendar is visible.

New in version 0.2.0.

GData.CalendarCalendar.props.is_selected¶

Name:: is-selected
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE

Indicates whether the calendar is selected.

New in version 0.2.0.

GData.CalendarCalendar.props.times_cleaned¶

Name:: times-cleaned
Type:: int
Default Value:: 0
Flags:: DEPRECATED, READABLE

The number of times the calendar has been cleared of events.

Deprecated since version 0.17.2: Unsupported by the online API any more. There is no replacement; this will always return 0.

GData.CalendarCalendar.props.timezone¶

Name:: timezone
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE

The timezone in which the calendar’s times are given. This is a timezone name in tz database notation: reference.