GData.GContactExternalID

g GData.Comparable GData.Comparable GData.GContactExternalID GData.GContactExternalID GData.Comparable->GData.GContactExternalID GData.Parsable GData.Parsable GData.Parsable->GData.GContactExternalID GObject.GInterface GObject.GInterface GObject.GInterface->GData.Comparable GObject.Object GObject.Object GObject.Object->GData.Parsable

Subclasses:

None

Methods

Inherited:

GData.Parsable (5), GObject.Object (37), GData.Comparable (1)

Structs:

GObject.ObjectClass (5)

class

new (value, relation_type, label)

get_label ()

get_relation_type ()

get_value ()

set_label (label)

set_relation_type (relation_type)

set_value (value)

Virtual Methods

Inherited:

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

Properties

Inherited:

GData.Parsable (1)

Name

Type

Flags

Short Description

label

str

r/w

A free-form string that identifies the type of external ID.

relation-type

str

r/w

A programmatic value that identifies the type of external ID.

value

str

r/w

The value of the external ID.

Signals

Inherited:

GObject.Object (1)

Fields

Inherited:

GObject.Object (1)

Name

Type

Access

Description

parent

GData.Parsable

r

Class Details

class GData.GContactExternalID(**kwargs)
Bases:

GData.Parsable, GData.Comparable

Abstract:

No

Structure:

GData.GContactExternalIDClass

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

New in version 0.7.0.

classmethod new(value, relation_type, label)
Parameters:
  • value (str) – the value of the external ID

  • relation_type (str or None) – the type of external ID, or None

  • label (str or None) – a free-form label for the external ID, or None

Returns:

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

Return type:

GData.GContactExternalID

Creates a new GData.GContactExternalID. 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 external ID, or None

Return type:

str

Gets the GData.GContactExternalID :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.GContactExternalID :relation-type property.

New in version 0.7.0.

get_value()
Returns:

the external ID’s value

Return type:

str

Gets the GData.GContactExternalID :value property.

New in version 0.7.0.

set_label(label)
Parameters:

label (str or None) – the new free-form label for the external ID, or None

Sets the GData.GContactExternalID :label property to label.

If label is None, the label will be unset. When the GData.GContactExternalID is used in a query, however, exactly one of GData.GContactExternalID :relation-type and GData.GContactExternalID :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 external ID, or None

Sets the GData.GContactExternalID :relation-type property to relation_type, such as GData.GCONTACT_EXTERNAL_ID_NETWORK or GData.GCONTACT_EXTERNAL_ID_ACCOUNT.

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

New in version 0.7.0.

set_value(value)
Parameters:

value (str) – the new value for the external ID

Sets the GData.GContactExternalID :value property to value.

New in version 0.7.0.

Property Details

GData.GContactExternalID.props.label
Name:

label

Type:

str

Default Value:

None

Flags:

READABLE, WRITABLE

A free-form string that identifies the type of external ID. It is mutually exclusive with GData.GContactExternalID :relation-type.

For more information, see the

gContact specification.

New in version 0.7.0.

GData.GContactExternalID.props.relation_type
Name:

relation-type

Type:

str

Default Value:

None

Flags:

READABLE, WRITABLE

A programmatic value that identifies the type of external ID. It is mutually exclusive with GData.GContactExternalID :label. Examples are GData.GCONTACT_EXTERNAL_ID_NETWORK or GData.GCONTACT_EXTERNAL_ID_ACCOUNT.

For more information, see the

gContact specification.

New in version 0.7.0.

GData.GContactExternalID.props.value
Name:

value

Type:

str

Default Value:

None

Flags:

READABLE, WRITABLE

The value of the external ID.

For more information, see the

gContact specification.

New in version 0.7.0.