GData.FreebaseService¶

Subclasses:: None

Methods¶

Inherited:: GData.Service (27), GObject.Object (37)
Structs:: GObject.ObjectClass (5)

class	`get_primary_authorization_domain` ()
class	`new` (developer_key, authorizer)
	`get_image` (value, cancellable, max_width, max_height)
	`get_topic` (query, cancellable)
	`get_topic_async` (query, cancellable, callback, *user_data)
	`query` (query, cancellable)
	`query_async` (query, cancellable, callback, *user_data)
	`search` (query, cancellable)
	`search_async` (query, cancellable, callback, *user_data)

Virtual Methods¶

Inherited:: GData.Service (2), GObject.Object (7)

Properties¶

Inherited:: GData.Service (5)

Name	Type	Flags	Short Description
`developer-key`	`str`	d/r/w/co	Your Freebase developer API key. `deprecated`

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access	Description
parent	`GData.Service`	r

Class Details¶

class GData.FreebaseService(**kwargs)¶

Bases:: GData.Service
Abstract:: No
Structure:: GData.FreebaseServiceClass

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

New in version 0.15.1.

classmethod get_primary_authorization_domain()¶

Returns:: the service’s authorization domain
Return type:: GData.AuthorizationDomain

The primary GData.AuthorizationDomain for interacting with Freebase. This will not normally need to be used, as it’s used internally by the GData.FreebaseService methods. However, if using the plain GData.Service methods to implement custom queries or requests which libgdata does not support natively, then this domain may be needed to authorize the requests.

The domain never changes, and is interned so that pointer comparison can be used to differentiate it from other authorization domains.

New in version 0.15.1.

Deprecated since version 0.17.7: Google Freebase has been permanently shut down.

classmethod new(developer_key, authorizer)¶

Parameters:

developer_key (str or None) – developer key to use the API, or None
authorizer (GData.Authorizer or None) – a GData.Authorizer to authorize the service’s requests, or None

Returns:

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

Return type:

GData.FreebaseService

Creates a new GData.FreebaseService using the given GData.Authorizer. If authorizer is None, all requests are made as an unauthenticated user. Having both developer_key and authorizer set to None is allowed, but this should be reserved for debugging situations, as there is a certain key-less quota for those purposes. If this service is used on any code intended to be deployed, one or both of developer_key and authorizer should be non-None and valid.

New in version 0.15.1.

Deprecated since version 0.17.7: Google Freebase has been permanently shut down.

get_image(value, cancellable, max_width, max_height)¶

Parameters:

value (GData.FreebaseTopicValue) – a GData.FreebaseTopicValue from a topic result
cancellable (Gio.Cancellable or None) – optional Gio.Cancellable object, or None
max_width (int) – maximum width of the image returned, or 0
max_height (int) – maximum height of the image returned, or 0

Raises:

GLib.Error

Returns:

a Gio.InputStream opened to the image; unref with GObject.Object.unref()

Return type:

Gio.InputStream

Creates an input stream to an image object returned in a topic query. If max_width and max_height are unspecified (i.e. set to 0), the image returned will be the smallest available.

New in version 0.15.1.

Deprecated since version 0.17.7: Google Freebase has been permanently shut down.

get_topic(query, cancellable)¶

Parameters:

query (GData.FreebaseTopicQuery) – a GData.FreebaseTopicQuery containing the topic ID
cancellable (Gio.Cancellable or None) – optional Gio.Cancellable object, or None

Raises:

GLib.Error

Returns:

a GData.FreebaseTopicResult containing information about the topic; unref with GObject.Object.unref()

Return type:

GData.FreebaseTopicResult

Queries information about a topic, identified through a Freebase ID. You can find out more about topic queries in the

online documentation.

New in version 0.15.1.

Deprecated since version 0.17.7: Google Freebase has been permanently shut down.

get_topic_async(query, cancellable, callback, *user_data)¶

Parameters:

query (GData.FreebaseTopicQuery) – a GData.FreebaseQuery with the MQL query
cancellable (Gio.Cancellable or None) – optional Gio.Cancellable object, or None
callback (Gio.AsyncReadyCallback or None) – a Gio.AsyncReadyCallback to call when authentication is finished
user_data (object or None) – data to pass to the callback function

Queries information about a topic, identified through a Freebase ID. self and query are all reffed when this function is called, so can safely be unreffed after this function returns. When the query is replied, or fails, callback will be executed, and the result can be obtained through GData.Service.query_single_entry_finish().

For more details, see GData.FreebaseService.get_topic(), which is the synchronous version of this function.

New in version 0.15.1.

Deprecated since version 0.17.7: Google Freebase has been permanently shut down.

query(query, cancellable)¶

Parameters:

query (GData.FreebaseQuery) – a GData.FreebaseQuery with the MQL query
cancellable (Gio.Cancellable or None) – optional Gio.Cancellable object, or None

Raises:

GLib.Error

Returns:

a GData.FreebaseResult containing the query result; unref with GObject.Object.unref()

Return type:

GData.FreebaseResult

Performs a MQL query on the service, you can find out more about MQL in the online MQL documentation.

New in version 0.15.1.

Deprecated since version 0.17.7: Google Freebase has been permanently shut down.

query_async(query, cancellable, callback, *user_data)¶

Parameters:

query (GData.FreebaseQuery) – a GData.FreebaseQuery with the MQL query
cancellable (Gio.Cancellable or None) – optional Gio.Cancellable object, or None
callback (Gio.AsyncReadyCallback or None) – a Gio.AsyncReadyCallback to call when authentication is finished
user_data (object or None) – data to pass to the callback function

Performs a MQL query on the service. self and query are all reffed when this function is called, so can safely be unreffed after this function returns. When the query is replied, or fails, callback will be executed, and the result can be obtained through GData.Service.query_single_entry_finish().

For more details, see GData.FreebaseService.query(), which is the synchronous version of this function.

New in version 0.15.1.

Deprecated since version 0.17.7: Google Freebase has been permanently shut down.

search(query, cancellable)¶

Parameters:

query (GData.FreebaseSearchQuery) – a GData.FreebaseSearchQuery containing the topic ID
cancellable (Gio.Cancellable or None) – optional Gio.Cancellable object, or None

Raises:

GLib.Error

Returns:

a GData.FreebaseSearchResult containing the results for the given search query; unref with GObject.Object.unref()

Return type:

GData.FreebaseSearchResult

Performs a search for any given search term, filters can be set on query to narrow down the results. The results returned are ordered by relevance. You can find out more about topic queries in the

online documentation.

New in version 0.15.1.

Deprecated since version 0.17.7: Google Freebase has been permanently shut down.

search_async(query, cancellable, callback, *user_data)¶

Parameters:

query (GData.FreebaseSearchQuery) – a GData.FreebaseQuery with the MQL query
cancellable (Gio.Cancellable or None) – optional Gio.Cancellable object, or None
callback (Gio.AsyncReadyCallback or None) – a Gio.AsyncReadyCallback to call when authentication is finished
user_data (object or None) – data to pass to the callback function

Performs a search for any given search term. self and query are all reffed when this function is called, so can safely be unreffed after this function returns.

For more details, see GData.FreebaseService.search(), which is the synchronous version of this function.

New in version 0.15.1.

Deprecated since version 0.17.7: Google Freebase has been permanently shut down.

Property Details¶

GData.FreebaseService.props.developer_key¶

Name:: developer-key
Type:: str
Default Value:: None
Flags:: DEPRECATED, READABLE, WRITABLE, CONSTRUCT_ONLY

The developer key your application has registered with the Freebase API. For more information, see the online documentation.

New in version 0.15.1.

Deprecated since version 0.17.7: Google Freebase has been permanently shut down.