GData.GContactWebsite¶

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 website out of a group is primary.
`label`	`str`	r/w	A simple string value used to name this website.
`relation-type`	`str`	r/w	A programmatic value that identifies the type of website.
`uri`	`str`	r/w	The URI of the website.

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access	Description
parent	`GData.Parsable`	r

Class Details¶

class GData.GContactWebsite(**kwargs)¶

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

All the fields in the GData.GContactWebsite 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 website URI
relation_type (str) – the relationship between the website and its owner, or None
label (str or None) – a human-readable label for the website, or None
is_primary (bool) – True if this website is its owner’s primary website, False otherwise

Returns:

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

Return type:

GData.GContactWebsite

Creates a new GData.GContactWebsite. 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:: the website’s label, or None
Return type:: str

Gets the GData.GContactWebsite :label property.

New in version 0.7.0.

get_relation_type()¶

Returns:: the website’s relation type
Return type:: str

Gets the GData.GContactWebsite :relation-type property.

New in version 0.7.0.

get_uri()¶

Returns:: the URI of the website
Return type:: str

Gets the GData.GContactWebsite :uri property.

New in version 0.7.0.

is_primary()¶

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

Gets the GData.GContactWebsite :is-primary property.

New in version 0.7.0.

set_is_primary(is_primary)¶

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

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

New in version 0.7.0.

set_label(label)¶

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

Sets the GData.GContactWebsite :label property to label.

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

New in version 0.7.0.

set_relation_type(relation_type)¶

Parameters:: relation_type (str) – the new relation type for the website

Sets the GData.GContactWebsite :relation-type property to relation_type such as GData.GCONTACT_WEBSITE_HOME_PAGE or GData.GCONTACT_WEBSITE_FTP.

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

New in version 0.7.0.

set_uri(uri)¶

Parameters:: uri (str) – the new website URI

Sets the GData.GContactWebsite :uri property to uri.

New in version 0.7.0.

Property Details¶

GData.GContactWebsite.props.is_primary¶

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

Indicates which website out of a group is primary.

For more information, see the

gContact specification.

New in version 0.7.0.

GData.GContactWebsite.props.label¶

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

A simple string value used to name this website. It allows UIs to display a label such as “Work”, “Travel blog”, “Personal blog”, etc. It is mutually exclusive with GData.GContactWebsite :relation-type.

For more information, see the

gContact specification.

New in version 0.7.0.

GData.GContactWebsite.props.relation_type¶

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

A programmatic value that identifies the type of website. Examples are GData.GCONTACT_WEBSITE_HOME_PAGE or GData.GCONTACT_WEBSITE_FTP. It is mutually exclusive with GData.GContactWebsite :label.

For more information, see the

gContact specification.

New in version 0.7.0.

GData.GContactWebsite.props.uri¶

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

The URI of the website.

For more information, see the

gContact specification.

New in version 0.7.0.