GData.Commentable

Implementations:

GData.PicasaWebFile, GData.YouTubeVideo

Methods

	delete_comment (service, comment_, cancellable)
	delete_comment_async (service, comment_, cancellable, callback, *user_data)
	delete_comment_finish (result)
	insert_comment (service, comment_, cancellable)
	insert_comment_async (service, comment_, cancellable, callback, *user_data)
	insert_comment_finish (result)
	query_comments (service, query, cancellable, progress_callback, *progress_user_data)
	query_comments_async (service, query, cancellable, progress_callback, progress_user_data, callback, *user_data)
	query_comments_finish (result)

Virtual Methods

	do_get_insert_comment_uri (comment)
	do_get_query_comments_uri ()
	do_is_comment_deletable (comment)

Properties

None

Signals

None

Fields

None

Class Details

class GData.Commentable

Bases:

GObject.GInterface

Structure:

GData.CommentableInterface

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

New in version 0.10.0.

delete_comment(service, comment_, cancellable)

Parameters:

• service (GData.Service) – a GData.Service with which the comment will be deleted

• comment (GData.Comment) – a comment to be deleted

• cancellable (Gio.Cancellable or None) – optional Gio.Cancellable object, or None

Raises:

GLib.Error

Returns:

True if the comment was successfully deleted, False otherwise

Return type:

bool

Deletes comment from the GData.Commentable.

If the given comment isn’t deletable (either because the service doesn’t support deleting comments at all, or because this particular comment is not deletable due to having insufficient permissions), GData.ServiceError.FORBIDDEN will be set in error and False will be returned.

New in version 0.10.0.

delete_comment_async(service, comment_, cancellable, callback, *user_data)

Parameters:

• service (GData.Service) – a GData.Service with which the comment will be deleted

• comment (GData.Comment) – a comment to be deleted

• cancellable (Gio.Cancellable or None) – optional Gio.Cancellable object, or None

• callback (Gio.AsyncReadyCallback or None) – a Gio.AsyncReadyCallback to call when the operation is finished

• user_data (object or None) – data to pass to the callback function

Deletes comment from the GData.Commentable. self, service and comment_ are all reffed when this method is called, so can safely be freed after this method returns.

For more details, see GData.Commentable.delete_comment(), which is the synchronous version of this method.

When the operation is finished, callback will be called. You can then call GData.Commentable.delete_comment_finish() to get the results of the operation.

New in version 0.10.0.

delete_comment_finish(result)

Parameters:

result (Gio.AsyncResult) – a Gio.AsyncResult

Raises:

GLib.Error

Returns:

True if the comment was successfully deleted, False otherwise

Return type:

bool

Finishes an asynchronous comment deletion operation started with GData.Commentable.delete_comment_async().

New in version 0.10.0.

insert_comment(service, comment_, cancellable)

Parameters:

• service (GData.Service) – a GData.Service with which the comment will be added

• comment (GData.Comment) – a new comment to be added to the GData.Commentable

• cancellable (Gio.Cancellable or None) – optional Gio.Cancellable object, or None

Raises:

GLib.Error

Returns:

the added GData.Comment, or None; unref with GObject.Object.unref()

Return type:

GData.Comment or None

Adds comment to the GData.Commentable.

If the GData.Commentable doesn’t support commenting, None will be returned and error will be set to GData.ServiceError.FORBIDDEN.

New in version 0.10.0.

insert_comment_async(service, comment_, cancellable, callback, *user_data)

Parameters:

• service (GData.Service) – a GData.Service with which the comment will be added

• comment (GData.Comment) – a new comment to be added to the GData.Commentable

• cancellable (Gio.Cancellable or None) – optional Gio.Cancellable object, or None

• callback (Gio.AsyncReadyCallback or None) – a Gio.AsyncReadyCallback to call when the operation is finished

• user_data (object or None) – data to pass to the callback function

Adds comment to the GData.Commentable. self, service and comment_ are all reffed when this method is called, so can safely be freed after this method returns.

For more details, see GData.Commentable.insert_comment(), which is the synchronous version of this method.

When the operation is finished, callback will be called. You can then call GData.Commentable.insert_comment_finish() to get the results of the operation.

New in version 0.10.0.

insert_comment_finish(result)

Parameters:

result (Gio.AsyncResult) – a Gio.AsyncResult

Raises:

GLib.Error

Returns:

the added GData.Comment, or None; unref with GObject.Object.unref()

Return type:

GData.Comment or None

Finishes an asynchronous comment insertion operation started with GData.Commentable.insert_comment_async().

New in version 0.10.0.

query_comments(service, query, cancellable, progress_callback, *progress_user_data)

Parameters:

• service (GData.Service) – a GData.Service representing the service with which the object’s comments will be manipulated

• query (GData.Query or None) – a GData.Query with query parameters, or None

• cancellable (Gio.Cancellable or None) – optional Gio.Cancellable object, or None

• progress_callback (GData.QueryProgressCallback or None) – a GData.QueryProgressCallback to call when a comment is loaded, or None

• progress_user_data (object or None) – data to pass to the progress_callback function

Raises:

GLib.Error

Returns:

a GData.Feed of GData.Comments, or None; unref with GObject.Object.unref()

Return type:

GData.Feed or None

Retrieves a GData.Feed containing the GData.Comments representing the comments on the GData.Commentable which match the given query.

If the GData.Commentable doesn’t support commenting, None will be returned and error will be set to GData.ServiceError.FORBIDDEN. This is in contrast to if it does support commenting but hasn’t had any comments added yet, in which case an empty GData.Feed will be returned and no error will be set.

New in version 0.10.0.

query_comments_async(service, query, cancellable, progress_callback, progress_user_data, callback, *user_data)

Parameters:

• service (GData.Service) – a GData.Service representing the service with which the object’s comments will be manipulated

• query (GData.Query or None) – a GData.Query with query parameters, or None

• cancellable (Gio.Cancellable or None) – optional Gio.Cancellable object, or None

• progress_callback (GData.QueryProgressCallback or None) – a GData.QueryProgressCallback to call when a comment is loaded, or None

• progress_user_data (object or None) – data to pass to the progress_callback function

• callback (Gio.AsyncReadyCallback or None) – a Gio.AsyncReadyCallback to call when the query is finished

• user_data (object or None) – data to pass to the callback function

Retrieves a GData.Feed containing the GData.Comments representing the comments on the GData.Commentable which match the given query. self, service and query are all reffed when this method is called, so can safely be freed after this method returns.

For more details, see GData.Commentable.query_comments(), which is the synchronous version of this method.

When the operation is finished, callback will be called. You can then call GData.Commentable.query_comments_finish() to get the results of the operation.

New in version 0.10.0.

query_comments_finish(result)

Parameters:

result (Gio.AsyncResult) – a Gio.AsyncResult

Raises:

GLib.Error

Returns:

a GData.Feed of GData.Comments, or None; unref with GObject.Object.unref()

Return type:

GData.Feed or None

Finishes an asynchronous comment query operation started with GData.Commentable.query_comments_async().

New in version 0.10.0.

do_get_insert_comment_uri(comment) virtual

Parameters:

comment (GData.Comment) –

Return type:

str

a function that returns the URI to add new comments to the commentable object, or None if the given commentable object doesn’t support adding comments; free with GLib.free()

do_get_query_comments_uri() virtual

Return type:

str

a function that returns the URI of a GData.Feed of comments from a commentable object, or None if the given commentable object doesn’t support commenting; free with GLib.free()

do_is_comment_deletable(comment) virtual

Parameters:

comment (GData.Comment) –

Return type:

bool

a function that returns True if the given comment may be deleted, False otherwise