GData.GContactEvent¶

Subclasses:: None

Methods¶

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

class	`new` (date, relation_type, label)
	`get_date` ()
	`get_label` ()
	`get_relation_type` ()
	`set_date` (date)
	`set_label` (label)
	`set_relation_type` (relation_type)

Virtual Methods¶

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

Properties¶

Inherited:: GData.Parsable (1)

Name	Type	Flags	Short Description
`date`	`GLib.Date`	r/w	The date of the event.
`label`	`str`	r/w	A simple string value used to name this event.
`relation-type`	`str`	r/w	A programmatic value that identifies the type of website.

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access	Description
parent	`GData.Parsable`	r

Class Details¶

class GData.GContactEvent(**kwargs)¶

Bases:: GData.Parsable
Abstract:: No
Structure:: GData.GContactEventClass

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

New in version 0.7.0.

classmethod new(date, relation_type, label)¶

Parameters:

date (GLib.Date) – the date of the event
relation_type (str or None) – the relationship between the event and its owner, or None
label (str or None) – a human-readable label for the event, or None

Returns:

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

Return type:

GData.GContactEvent

Creates a new GData.GContactEvent. 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_date()¶

Returns:: return location for the date of the event
Return type:: date: GLib.Date

Gets the GData.GContactEvent :date property.

New in version 0.7.0.

get_label()¶

Returns:: the event’s label, or None
Return type:: str

Gets the GData.GContactEvent :label property.

New in version 0.7.0.

get_relation_type()¶

Returns:: the event’s relation type, or None
Return type:: str

Gets the GData.GContactEvent :relation-type property.

New in version 0.7.0.

set_date(date)¶

Parameters:: date (GLib.Date) – the new date for the event

Sets the GData.GContactEvent :date property to date.

New in version 0.7.0.

set_label(label)¶

Parameters:: label (str or None) – the new label for the event, or None

Sets the GData.GContactEvent :label property to label.

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

New in version 0.7.0.

set_relation_type(relation_type)¶

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

Sets the GData.GContactEvent :relation-type property to relation_type such as GData.GCONTACT_EVENT_ANNIVERSARY or GData.GCONTACT_EVENT_OTHER.

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

New in version 0.7.0.

Property Details¶

GData.GContactEvent.props.date¶

Name:: date
Type:: GLib.Date
Default Value:: None
Flags:: READABLE, WRITABLE

The date of the event.

For more information, see the

GContact specification.

New in version 0.7.0.

GData.GContactEvent.props.label¶

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

A simple string value used to name this event. It is mutually exclusive with GData.GContactEvent :relation-type. It allows UIs to display a label such as “Wedding anniversary”.

For more information, see the

gContact specification.

New in version 0.7.0.

GData.GContactEvent.props.relation_type¶

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

A programmatic value that identifies the type of event. It is mutually exclusive with GData.GContactEvent :label. Examples are GData.GCONTACT_EVENT_ANNIVERSARY or GData.GCONTACT_EVENT_OTHER.

For more information, see the

gContact specification.

New in version 0.7.0.