GData.GDWho¶

Subclasses:: None

Methods¶

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

class	`new` (relation_type, value_string, email_address)
	`get_email_address` ()
	`get_relation_type` ()
	`get_value_string` ()
	`set_email_address` (email_address)
	`set_relation_type` (relation_type)
	`set_value_string` (value_string)

Virtual Methods¶

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

Properties¶

Inherited:: GData.Parsable (1)

Name	Type	Flags	Short Description
`email-address`	`str`	r/w	The e-mail address of the person represented by the `GData.GDWho`.
`relation-type`	`str`	r/w	Specifies the relationship between the container and the containee.
`value-string`	`str`	r/w	A simple string representation of this person.

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access	Description
parent	`GData.Parsable`	r

Class Details¶

class GData.GDWho(**kwargs)¶

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

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

New in version 0.2.0.

classmethod new(relation_type, value_string, email_address)¶

Parameters:

relation_type (str or None) – the relationship between the item and this person, or None
value_string (str or None) – a string to represent the person, or None
email_address (str or None) – the person’s e-mail address, or None

Returns:

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

Return type:

GData.GDWho

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

Currently, entryLink functionality is not implemented in GData.GDWho.

New in version 0.2.0.

get_email_address()¶

Returns:: the e-mail address, or None
Return type:: str

Gets the GData.GDWho :email-address property.

New in version 0.4.0.

get_relation_type()¶

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

Gets the GData.GDWho :relation-type property.

New in version 0.4.0.

get_value_string()¶

Returns:: the value string, or None
Return type:: str

Gets the GData.GDWho :value-string property.

New in version 0.4.0.

set_email_address(email_address)¶

Parameters:: email_address (str or None) – the new e-mail address, or None

Sets the GData.GDWho :email-address property to email_address.

Set email_address to None to unset the property.

New in version 0.4.0.

set_relation_type(relation_type)¶

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

Sets the GData.GDWho :relation-type property to relation_type.

Set relation_type to None to unset the property.

New in version 0.4.0.

set_value_string(value_string)¶

Parameters:: value_string (str or None) – the new value string, or None

Sets the GData.GDWho :value-string property to value_string.

Set value_string to None to unset the property.

New in version 0.4.0.

Property Details¶

GData.GDWho.props.email_address¶

Name:: email-address
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE

The e-mail address of the person represented by the GData.GDWho.

For more information, see the

GData specification.

New in version 0.4.0.

GData.GDWho.props.relation_type¶

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

Specifies the relationship between the containing entity and the contained person. For example: GData.GD_WHO_EVENT_PERFORMER or GData.GD_WHO_EVENT_ATTENDEE.

For more information, see the

GData specification.

New in version 0.4.0.

GData.GDWho.props.value_string¶

Name:: value-string
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE

A simple string representation of this person.

For more information, see the

GData specification.

New in version 0.4.0.