GData.DocumentsProperty¶

Subclasses:: None

Methods¶

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

class	`new` (key)
	`get_etag` ()
	`get_key` ()
	`get_value` ()
	`get_visibility` ()
	`set_value` (value)
	`set_visibility` (visibility)

Virtual Methods¶

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

Properties¶

Inherited:: GData.Parsable (1)

Name	Type	Flags	Short Description
`etag`	`str`	r/w/co	ETag of the property.
`key`	`str`	r/w	The key of this property.
`value`	`str`	r/w	The value of this property.
`visibility`	`str`	r/w	The visibility of this property.

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access	Description
parent	`GData.Parsable`	r

Class Details¶

class GData.DocumentsProperty(**kwargs)¶

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

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

New in version 0.17.11.

classmethod new(key)¶

Parameters:: key (str) – the property’s key
Returns:: a new GData.DocumentsProperty; unref with GObject.Object.unref()
Return type:: GData.DocumentsProperty

Creates a new GData.Entry with the given ID and default properties.

New in version 0.17.11.

get_etag()¶

Returns:: the property’s ETag. The ETag will never be empty; it’s either None or a valid ETag.
Return type:: str

Returns the ETag of the property.

New in version 0.17.11.

get_key()¶

Returns:: the property’s key
Return type:: str

Returns the key of the property. This will never be None or an empty string (“”).

New in version 0.17.11.

get_value()¶

Returns:: the property’s value. This can be None or empty.
Return type:: str or None

Returns the value of the property.

In the case that this value is None, the Property Resource corresponding to self will be deleted from the properties array on a file’s metadata, whereas in the case that it’s empty string (“”), it will be set as it is.

New in version 0.17.11.

get_visibility()¶

Returns:: GData.DOCUMENTS_PROPERTY_VISIBILITY_PUBLIC if the GData.DocumentsProperty is publicly visible to other apps, GData.DOCUMENTS_PROPERTY_VISIBILITY_PRIVATE if the GData.DocumentsProperty is restricted to the application which created it.
Return type:: str

Returns the visibility status of the property.

New in version 0.17.11.

set_value(value)¶

Parameters:: value (str or None) – the new value of the property

Sets GData.DocumentsProperty :value to value, corresponding to the key.

In the case that value is None, the Property Resource corresponding to self will be deleted from the properties array on a file’s metadata, whereas in the case that it’s empty string (“”), it will be set as it is.

New in version 0.17.11.

set_visibility(visibility)¶

Parameters:: visibility (str) – the new visibility status of the property

Sets GData.DocumentsProperty :visibility to GData.DOCUMENTS_PROPERTY_VISIBILITY_PUBLIC for public properties and GData.DOCUMENTS_PROPERTY_VISIBILITY_PRIVATE for private properties (default).

New in version 0.17.11.

Property Details¶

GData.DocumentsProperty.props.etag¶

Name:: etag
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

ETag of the property.

For more information, see the Properties Resource

New in version 0.17.11.

GData.DocumentsProperty.props.key¶

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

The key of this property.

For more information, see the Properties Resource

New in version 0.17.11.

GData.DocumentsProperty.props.value¶

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

The value of this property. By default, it takes the an empty string (“”).

For more information, see the Properties Resource

New in version 0.17.11.

GData.DocumentsProperty.props.visibility¶

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

The visibility status of this property. The default value of visibility is PRIVATE on a Drive Properties Resource object, hence GData.DocumentsProperty :visibility is GData.DOCUMENTS_PROPERTY_VISIBILITY_PRIVATE by default. A private property restricts its visibility to only the app which created it.

For more information, see the Properties Resource

New in version 0.17.11.