GData.GDIMAddress¶

Subclasses:: None

Methods¶

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

class	`new` (address, protocol, relation_type, label, is_primary)
	`get_address` ()
	`get_label` ()
	`get_protocol` ()
	`get_relation_type` ()
	`is_primary` ()
	`set_address` (address)
	`set_is_primary` (is_primary)
	`set_label` (label)
	`set_protocol` (protocol)
	`set_relation_type` (relation_type)

Virtual Methods¶

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

Properties¶

Inherited:: GData.Parsable (1)

Name	Type	Flags	Short Description
`address`	`str`	r/w	The IM address itself.
`is-primary`	`bool`	r/w	Indicates which IM address out of a group is primary.
`label`	`str`	r/w	A simple string value used to name this IM address.
`protocol`	`str`	r/w	Identifies the IM network.
`relation-type`	`str`	r/w	A programmatic value that identifies the type of IM address.

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access	Description
parent	`GData.Parsable`	r

Class Details¶

class GData.GDIMAddress(**kwargs)¶

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

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

New in version 0.2.0.

classmethod new(address, protocol, relation_type, label, is_primary)¶

Parameters:

address (str) – the IM address
protocol (str or None) – a URI identifying the IM protocol, or None
relation_type (str or None) – the relationship between the IM address and its owner, or None
label (str or None) – a human-readable label for the IM address, or None
is_primary (bool) – True if this IM address is its owner’s primary address, False otherwise

Returns:

a new GData.GDIMAddress, or None; unref with GObject.Object.unref()

Return type:

GData.GDIMAddress

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

New in version 0.2.0.

get_address()¶

Returns:: the IM address itself, or None
Return type:: str

Gets the GData.GDIMAddress :address property.

New in version 0.4.0.

get_label()¶

Returns:: the IM address’ label, or None
Return type:: str

Gets the GData.GDIMAddress :label property.

New in version 0.4.0.

get_protocol()¶

Returns:: the IM address’ protocol, or None
Return type:: str

Gets the GData.GDIMAddress :protocol property.

New in version 0.4.0.

get_relation_type()¶

Returns:: the IM address’ relation type, or None
Return type:: str

Gets the GData.GDIMAddress :relation-type property.

New in version 0.4.0.

is_primary()¶

Returns:: True if this is the primary IM address, False otherwise
Return type:: bool

Gets the GData.GDIMAddress :is-primary property.

New in version 0.4.0.

set_address(address)¶

Parameters:: address (str) – the new IM address

Sets the GData.GDIMAddress :address property to address.

New in version 0.4.0.

set_is_primary(is_primary)¶

Parameters:: is_primary (bool) – True if this is the primary IM address, False otherwise

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

New in version 0.4.0.

set_label(label)¶

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

Sets the GData.GDIMAddress :label property to label.

Set label to None to unset the property in the IM address.

New in version 0.4.0.

set_protocol(protocol)¶

Parameters:: protocol (str or None) – the new IM protocol, or None

Sets the GData.GDIMAddress :protocol property to protocol.

New in version 0.4.0.

set_relation_type(relation_type)¶

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

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

Set relation_type to None to unset the property in the IM address.

New in version 0.4.0.

Property Details¶

GData.GDIMAddress.props.address¶

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

The IM address itself.

For more information, see the

GData specification.

New in version 0.4.0.

GData.GDIMAddress.props.is_primary¶

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

Indicates which IM address out of a group is primary.

For more information, see the

GData specification.

New in version 0.4.0.

GData.GDIMAddress.props.label¶

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

A simple string value used to name this IM address. It allows UIs to display a label such as “Work”, “Personal”, “Preferred”, etc.

For more information, see the

GData specification.

New in version 0.4.0.

GData.GDIMAddress.props.protocol¶

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

Identifies the IM network. For example: GData.GD_IM_PROTOCOL_JABBER or GData.GD_IM_PROTOCOL_GOOGLE_TALK.

For more information, see the

GData specification.

New in version 0.4.0.

GData.GDIMAddress.props.relation_type¶

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

A programmatic value that identifies the type of IM address. For example: GData.GD_IM_ADDRESS_HOME or GData.GD_IM_ADDRESS_WORK.

For more information, see the

GData specification.

New in version 0.4.0.