GData.GContactCalendar¶

Subclasses:: None

Methods¶

Inherited:: GData.Parsable (5), GObject.Object (37), GData.Comparable (1)
Structs:: GObject.ObjectClass (5)

class	`new` (uri, relation_type, label, is_primary)
	`get_label` ()
	`get_relation_type` ()
	`get_uri` ()
	`is_primary` ()
	`set_is_primary` (is_primary)
	`set_label` (label)
	`set_relation_type` (relation_type)
	`set_uri` (uri)

Virtual Methods¶

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

Properties¶

Inherited:: GData.Parsable (1)

Name	Type	Flags	Short Description
`is-primary`	`bool`	r/w	Indicates which calendar out of a group is primary.
`label`	`str`	r/w	A free-form string that identifies the type of calendar.
`relation-type`	`str`	r/w	A programmatic value that identifies the type of calendar.
`uri`	`str`	r/w	The URI of the calendar.

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access	Description
parent	`GData.Parsable`	r

Class Details¶

class GData.GContactCalendar(**kwargs)¶

Bases:: GData.Parsable, GData.Comparable
Abstract:: No
Structure:: GData.GContactCalendarClass

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

New in version 0.7.0.

classmethod new(uri, relation_type, label, is_primary)¶

Parameters:

uri (str) – the URI of the calendar
relation_type (str or None) – the type of calendar, or None
label (str or None) – a free-form label for the calendar, or None
is_primary (bool) – True if this calendar is its owner’s primary calendar, False otherwise

Returns:

a new GData.GContactCalendar; unref with GObject.Object.unref()

Return type:

GData.GContactCalendar

Creates a new GData.GContactCalendar. More information is available in the gContact specification.

Exactly one of relation_type and label should be provided; the other must be None.

New in version 0.7.0.

get_label()¶

Returns:: a free-form label for the calendar, or None
Return type:: str

Gets the GData.GContactCalendar :label property.

New in version 0.7.0.

get_relation_type()¶

Returns:: the type of the relation, or None
Return type:: str

Gets the GData.GContactCalendar :relation-type property.

New in version 0.7.0.

get_uri()¶

Returns:: the calendar’s URI
Return type:: str

Gets the GData.GContactCalendar :uri property.

New in version 0.7.0.

is_primary()¶

Returns:: True if this is the contact’s primary calendar, False otherwise
Return type:: bool

Gets the GData.GContactCalendar :is-primary property.

New in version 0.7.0.

set_is_primary(is_primary)¶

Parameters:: is_primary (bool) – True if this is the contact’s primary calendar, False otherwise

Sets the GData.GContactCalendar :is-primary property to is_primary.

New in version 0.7.0.

set_label(label)¶

Parameters:: label (str or None) – the new free-form label for the calendar, or None

Sets the GData.GContactCalendar :label property to label.

If label is None, the label will be unset. When the GData.GContactCalendar is used in a query, however, exactly one of GData.GContactCalendar :relation-type and GData.GContactCalendar :label must be None.

New in version 0.7.0.

set_relation_type(relation_type)¶

Parameters:: relation_type (str or None) – the new type for the calendar, or None

Sets the GData.GContactCalendar :relation-type property to relation_type, such as GData.GCONTACT_CALENDAR_HOME or GData.GCONTACT_CALENDAR_FREE_BUSY.

If relation_type is None, the relation type will be unset. When the GData.GContactCalendar is used in a query, however, exactly one of GData.GContactCalendar :relation-type and GData.GContactCalendar :label must be None.

New in version 0.7.0.

set_uri(uri)¶

Parameters:: uri (str) – the new URI for the calendar

Sets the GData.GContactCalendar :uri property to uri.

New in version 0.7.0.

Property Details¶

GData.GContactCalendar.props.is_primary¶

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

Indicates which calendar out of a group is primary.

For more information, see the

gContact specification.

New in version 0.7.0.

GData.GContactCalendar.props.label¶

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

A free-form string that identifies the type of calendar. It is mutually exclusive with GData.GContactCalendar :relation-type.

For more information, see the

gContact specification.

New in version 0.7.0.

GData.GContactCalendar.props.relation_type¶

Name:: relation-type
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE

A programmatic value that identifies the type of calendar. It is mutually exclusive with GData.GContactCalendar :label. Examples are GData.GCONTACT_CALENDAR_HOME or GData.GCONTACT_CALENDAR_FREE_BUSY.

For more information, see the

gContact specification.

New in version 0.7.0.

GData.GContactCalendar.props.uri¶

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

The URI of the calendar.

For more information, see the

gContact specification.

New in version 0.7.0.