Blame docs/reference/html/GDataCommentable.html

Packit 4b6dd7
Packit 4b6dd7
<html>
Packit 4b6dd7
<head>
Packit 4b6dd7
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
Packit 4b6dd7
<title>GDataCommentable: GData Reference Manual</title>
Packit 4b6dd7
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
Packit 4b6dd7
<link rel="home" href="index.html" title="GData Reference Manual">
Packit 4b6dd7
<link rel="up" href="ch06.html" title="Comment API">
Packit 4b6dd7
<link rel="prev" href="ch06.html" title="Comment API">
Packit 4b6dd7
<link rel="next" href="GDataComment.html" title="GDataComment">
Packit 4b6dd7
<meta name="generator" content="GTK-Doc V1.26.1 (XML mode)">
Packit 4b6dd7
<link rel="stylesheet" href="style.css" type="text/css">
Packit 4b6dd7
</head>
Packit 4b6dd7
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Top  | 
Packit 4b6dd7
                  Description  | 
Packit 4b6dd7
                  Object Hierarchy  | 
Packit 4b6dd7
                  Prerequisites  | 
Packit 4b6dd7
                  Known Implementations
Packit 4b6dd7
Packit 4b6dd7
Home
Packit 4b6dd7
Up
Packit 4b6dd7
Prev
Packit 4b6dd7
Next
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

GDataCommentable

Packit 4b6dd7

GDataCommentable — GData commentable interface

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Stability Level

Packit 4b6dd7
Packit 4b6dd7
develop applications to these interfaces, release them, and have confidence that
Packit 4b6dd7
they will run on all minor releases of the product (after the one in which the
Packit 4b6dd7
interface was introduced, and within the same major release). Even at a major
Packit 4b6dd7
release, incompatible changes are expected to be rare, and to have strong
Packit 4b6dd7
justifications.
Packit 4b6dd7
">Stable, unless otherwise indicated
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Functions

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
GDataFeed *
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_commentable_query_comments ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
void
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_commentable_query_comments_async ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
GDataFeed *
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_commentable_query_comments_finish ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
GDataComment *
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_commentable_insert_comment ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
void
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_commentable_insert_comment_async ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
GDataComment *
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_commentable_insert_comment_finish ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gboolean
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_commentable_delete_comment ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
void
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_commentable_delete_comment_async ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gboolean
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
gdata_commentable_delete_comment_finish ()
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Types and Values

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
 
Packit 4b6dd7
GDataCommentable
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
 
Packit 4b6dd7
GDataCommentableInterface
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Object Hierarchy

Packit 4b6dd7
    GInterface
Packit 4b6dd7
    ╰── GDataCommentable
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Prerequisites

Packit 4b6dd7

Packit 4b6dd7
GDataCommentable requires
Packit 4b6dd7
 GDataEntry.

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Known Implementations

Packit 4b6dd7

Packit 4b6dd7
GDataCommentable is implemented by
Packit 4b6dd7
 GDataPicasaWebFile and  GDataYouTubeVideo.

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Includes

Packit 4b6dd7
#include <gdata/gdata-commentable.h>
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Description

Packit 4b6dd7

GDataCommentable is an interface which can be implemented by commentable objects: objects which support having comments added to them by users,

Packit 4b6dd7
such as videos and photos.

Packit 4b6dd7

Comments may be queried, added and deleted. Note that they may not be edited.

Packit 4b6dd7

GDataCommentable objects may not support all operations on comments, on an instance-by-instance basis (i.e. it's an invalid assumption that if,

Packit 4b6dd7
for example, one GDataYouTubeVideo doesn't support adding comments all other GDataYouTubeVideos don't support adding comments either).
Packit 4b6dd7
Specific documentation for a particular type of GDataCommentable may state otherwise, though.

Packit 4b6dd7
Packit 4b6dd7

Example 10. Querying for Comments

Packit 4b6dd7
Packit 4b6dd7
  
Packit 4b6dd7
    
Packit 4b6dd7
      
Packit 4b6dd7
        
1
Packit 4b6dd7
2
Packit 4b6dd7
3
Packit 4b6dd7
4
Packit 4b6dd7
5
Packit 4b6dd7
6
Packit 4b6dd7
7
Packit 4b6dd7
8
Packit 4b6dd7
9
Packit 4b6dd7
10
Packit 4b6dd7
11
Packit 4b6dd7
12
Packit 4b6dd7
13
Packit 4b6dd7
14
Packit 4b6dd7
15
Packit 4b6dd7
16
Packit 4b6dd7
17
Packit 4b6dd7
18
Packit 4b6dd7
19
Packit 4b6dd7
20
Packit 4b6dd7
21
Packit 4b6dd7
22
Packit 4b6dd7
23
Packit 4b6dd7
24
Packit 4b6dd7
25
Packit 4b6dd7
26
Packit 4b6dd7
27
Packit 4b6dd7
28
Packit 4b6dd7
29
Packit 4b6dd7
30
Packit 4b6dd7
31
Packit 4b6dd7
32
Packit 4b6dd7
33
Packit 4b6dd7
34
Packit 4b6dd7
35
Packit 4b6dd7
36
Packit 4b6dd7
37
Packit 4b6dd7
38
Packit 4b6dd7
39
Packit 4b6dd7
40
Packit 4b6dd7
41
Packit 4b6dd7
42
Packit 4b6dd7
43
Packit 4b6dd7
44
Packit 4b6dd7
45
Packit 4b6dd7
46
Packit 4b6dd7
47
Packit 4b6dd7
48
Packit 4b6dd7
49
Packit 4b6dd7
50
Packit 4b6dd7
        
GDataService *service;
Packit 4b6dd7
GDataCommentable *commentable;
Packit 4b6dd7
Packit 4b6dd7
/* Create a service */
Packit 4b6dd7
service = create_service ();
Packit 4b6dd7
Packit 4b6dd7
/* Retrieve the GDataCommentable which is going to be queried. This may be, for example, a GDataYouTubeVideo. */
Packit 4b6dd7
commentable = get_commentable ();
Packit 4b6dd7
Packit 4b6dd7
/* Start the async. query for the comments. */
Packit 4b6dd7
gdata_commentable_query_comments_async (commentable, service, NULL, NULL, NULL, NULL, NULL, (GAsyncReadyCallback) query_comments_cb, NULL);
Packit 4b6dd7
Packit 4b6dd7
g_object_unref (service);
Packit 4b6dd7
g_object_unref (commentable);
Packit 4b6dd7
Packit 4b6dd7
static void
Packit 4b6dd7
query_comments_cb (GDataCommentable *commentable, GAsyncResult *result, gpointer user_data)
Packit 4b6dd7
{
Packit 4b6dd7
    GDataFeed *comment_feed;
Packit 4b6dd7
    GList *comments, *i;
Packit 4b6dd7
    GError *error = NULL;
Packit 4b6dd7
Packit 4b6dd7
    comment_feed = gdata_commentable_query_comments_finish (commentable, result, &error);
Packit 4b6dd7
Packit 4b6dd7
    if (error != NULL) {
Packit 4b6dd7
        /* Error! */
Packit 4b6dd7
        g_error ("Error querying comments: %s", error->message);
Packit 4b6dd7
        g_error_free (error);
Packit 4b6dd7
        return;
Packit 4b6dd7
    }
Packit 4b6dd7
Packit 4b6dd7
    /* Examine the comments. */
Packit 4b6dd7
    comments = gdata_feed_get_entries (comment_feed);
Packit 4b6dd7
    for (i = comments; i != NULL; i = i->next) {
Packit 4b6dd7
        /* Note that this will actually be a subclass of GDataComment,
Packit 4b6dd7
         * such as GDataYouTubeComment or GDataPicasaWebComment. */
Packit 4b6dd7
        GDataComment *comment = GDATA_COMMENT (i->data);
Packit 4b6dd7
        GDataAuthor *author;
Packit 4b6dd7
Packit 4b6dd7
        /* Note that in practice it might not always be safe to assume that a comment always has an author. */
Packit 4b6dd7
        author = GDATA_AUTHOR (gdata_entry_get_authors (GDATA_ENTRY (comment))->data);
Packit 4b6dd7
Packit 4b6dd7
        g_message ("Comment by %s (%s): %s",
Packit 4b6dd7
                   gdata_author_get_name (author),
Packit 4b6dd7
                   gdata_author_get_uri (author),
Packit 4b6dd7
                   gdata_entry_get_content (GDATA_ENTRY (comment)));
Packit 4b6dd7
    }
Packit 4b6dd7
Packit 4b6dd7
    g_object_unref (comment_feed);
Packit 4b6dd7
}
Packit 4b6dd7
      
Packit 4b6dd7
    
Packit 4b6dd7
  
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Functions

Packit 4b6dd7
Packit 4b6dd7

gdata_commentable_query_comments ()

Packit 4b6dd7
GDataFeed *
Packit 4b6dd7
gdata_commentable_query_comments (GDataCommentable *self,
Packit 4b6dd7
                                  GDataService *service,
Packit 4b6dd7
                                  GDataQuery *query,
Packit 4b6dd7
                                  GCancellable *cancellable,
Packit 4b6dd7
                                  GDataQueryProgressCallback progress_callback,
Packit 4b6dd7
                                  gpointer progress_user_data,
Packit 4b6dd7
                                  GError **error);
Packit 4b6dd7

Retrieves a GDataFeed containing the GDataComments representing the comments on the GDataCommentable which match the given query

Packit 4b6dd7
.

Packit 4b6dd7

If the GDataCommentable doesn't support commenting, NULL will be returned and error

Packit 4b6dd7
 will be set to GDATA_SERVICE_ERROR_FORBIDDEN. This is in
Packit 4b6dd7
contrast to if it does support commenting but hasn't had any comments added yet, in which case an empty GDataFeed will be returned and no error
Packit 4b6dd7
will be set.

Packit 4b6dd7
Packit 4b6dd7

Parameters

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

self

Packit 4b6dd7

a GDataCommentable

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

service

Packit 4b6dd7

a GDataService representing the service with which the object's comments will be manipulated

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

query

Packit 4b6dd7

a GDataQuery with query parameters, or NULL.

Packit 4b6dd7
[allow-none]
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

cancellable

Packit 4b6dd7

optional GCancellable object, or NULL.

Packit 4b6dd7
[allow-none]
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

progress_callback

Packit 4b6dd7

a GDataQueryProgressCallback to call when a comment is loaded, or NULL.

Packit 4b6dd7
[allow-none][scope call][closure progress_user_data]
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

progress_user_data

Packit 4b6dd7

data to pass to the progress_callback

Packit 4b6dd7
function. 

Packit 4b6dd7
[closure]
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

error

Packit 4b6dd7

a GError, or NULL

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Returns

Packit 4b6dd7

a GDataFeed of GDataComments, or NULL; unref with g_object_unref().

Packit 4b6dd7

[transfer full][allow-none]

Packit 4b6dd7
Packit 4b6dd7

Since: 0.10.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_commentable_query_comments_async ()

Packit 4b6dd7
void
Packit 4b6dd7
gdata_commentable_query_comments_async
Packit 4b6dd7
                               (GDataCommentable *self,
Packit 4b6dd7
                                GDataService *service,
Packit 4b6dd7
                                GDataQuery *query,
Packit 4b6dd7
                                GCancellable *cancellable,
Packit 4b6dd7
                                GDataQueryProgressCallback progress_callback,
Packit 4b6dd7
                                gpointer progress_user_data,
Packit 4b6dd7
                                GDestroyNotify destroy_progress_user_data,
Packit 4b6dd7
                                GAsyncReadyCallback callback,
Packit 4b6dd7
                                gpointer user_data);
Packit 4b6dd7

Retrieves a GDataFeed containing the GDataComments representing the comments on the GDataCommentable which match the given query

Packit 4b6dd7
.
Packit 4b6dd7
self
Packit 4b6dd7
, service
Packit 4b6dd7
 and query
Packit 4b6dd7
 are all reffed when this method is called, so can safely be freed after this method returns.

Packit 4b6dd7

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

Packit 4b6dd7

When the operation is finished, callback

Packit 4b6dd7
 will be called. You can then call gdata_commentable_query_comments_finish() to get the results of the
Packit 4b6dd7
operation.

Packit 4b6dd7
Packit 4b6dd7

Parameters

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

self

Packit 4b6dd7

a GDataCommentable

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

service

Packit 4b6dd7

a GDataService representing the service with which the object's comments will be manipulated

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

query

Packit 4b6dd7

a GDataQuery with query parameters, or NULL.

Packit 4b6dd7
[allow-none]
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

cancellable

Packit 4b6dd7

optional GCancellable object, or NULL.

Packit 4b6dd7
[allow-none]
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

progress_callback

Packit 4b6dd7

a GDataQueryProgressCallback to call when a comment is loaded,

Packit 4b6dd7
or NULL. 

Packit 4b6dd7
[allow-none][scope notified][closure progress_user_data]
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

progress_user_data

Packit 4b6dd7

data to pass to the progress_callback

Packit 4b6dd7
function. 

Packit 4b6dd7
[closure]
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

destroy_progress_user_data

Packit 4b6dd7

a function to call when progress_callback

Packit 4b6dd7
will not be called any more, or NULL; this function will be
Packit 4b6dd7
called with progress_user_data
Packit 4b6dd7
as a parameter and can be used to free any memory allocated for it. 

Packit 4b6dd7
[allow-none]
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

callback

Packit 4b6dd7

a GAsyncReadyCallback to call when the query is finished

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

user_data

Packit 4b6dd7

data to pass to the callback

Packit 4b6dd7
function. 

Packit 4b6dd7
[closure]
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Since: 0.10.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_commentable_query_comments_finish ()

Packit 4b6dd7
GDataFeed *
Packit 4b6dd7
gdata_commentable_query_comments_finish
Packit 4b6dd7
                               (GDataCommentable *self,
Packit 4b6dd7
                                GAsyncResult *result,
Packit 4b6dd7
                                GError **error);
Packit 4b6dd7

Finishes an asynchronous comment query operation started with gdata_commentable_query_comments_async().

Packit 4b6dd7
Packit 4b6dd7

Parameters

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

self

Packit 4b6dd7

a GDataCommentable

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

result

Packit 4b6dd7

a GAsyncResult

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

error

Packit 4b6dd7

a GError, or NULL

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Returns

Packit 4b6dd7

a GDataFeed of GDataComments, or NULL; unref with g_object_unref().

Packit 4b6dd7

[transfer full][allow-none]

Packit 4b6dd7
Packit 4b6dd7

Since: 0.10.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_commentable_insert_comment ()

Packit 4b6dd7
GDataComment *
Packit 4b6dd7
gdata_commentable_insert_comment (GDataCommentable *self,
Packit 4b6dd7
                                  GDataService *service,
Packit 4b6dd7
                                  GDataComment *comment_,
Packit 4b6dd7
                                  GCancellable *cancellable,
Packit 4b6dd7
                                  GError **error);
Packit 4b6dd7

Adds comment

Packit 4b6dd7
 to the GDataCommentable.

Packit 4b6dd7

If the GDataCommentable doesn't support commenting, NULL will be returned and error

Packit 4b6dd7
 will be set to GDATA_SERVICE_ERROR_FORBIDDEN.

Packit 4b6dd7
Packit 4b6dd7

Parameters

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

self

Packit 4b6dd7

a GDataCommentable

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

service

Packit 4b6dd7

a GDataService with which the comment will be added

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

comment_

Packit 4b6dd7

a new comment to be added to the GDataCommentable

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

cancellable

Packit 4b6dd7

optional GCancellable object, or NULL.

Packit 4b6dd7
[allow-none]
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

error

Packit 4b6dd7

a GError, or NULL

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Returns

Packit 4b6dd7

the added GDataComment, or NULL; unref with g_object_unref().

Packit 4b6dd7

[transfer full][allow-none]

Packit 4b6dd7
Packit 4b6dd7

Since: 0.10.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_commentable_insert_comment_async ()

Packit 4b6dd7
void
Packit 4b6dd7
gdata_commentable_insert_comment_async
Packit 4b6dd7
                               (GDataCommentable *self,
Packit 4b6dd7
                                GDataService *service,
Packit 4b6dd7
                                GDataComment *comment_,
Packit 4b6dd7
                                GCancellable *cancellable,
Packit 4b6dd7
                                GAsyncReadyCallback callback,
Packit 4b6dd7
                                gpointer user_data);
Packit 4b6dd7

Adds comment

Packit 4b6dd7
 to the GDataCommentable. self
Packit 4b6dd7
, service
Packit 4b6dd7
 and comment_
Packit 4b6dd7
 are all reffed when this method is called, so can safely be freed after this
Packit 4b6dd7
method returns.

Packit 4b6dd7

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

Packit 4b6dd7

When the operation is finished, callback

Packit 4b6dd7
 will be called. You can then call gdata_commentable_insert_comment_finish() to get the results of the
Packit 4b6dd7
operation.

Packit 4b6dd7
Packit 4b6dd7

Parameters

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

self

Packit 4b6dd7

a GDataCommentable

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

service

Packit 4b6dd7

a GDataService with which the comment will be added

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

comment_

Packit 4b6dd7

a new comment to be added to the GDataCommentable

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

cancellable

Packit 4b6dd7

optional GCancellable object, or NULL.

Packit 4b6dd7
[allow-none]
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

callback

Packit 4b6dd7

a GAsyncReadyCallback to call when the operation is finished

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

user_data

Packit 4b6dd7

data to pass to the callback

Packit 4b6dd7
function. 

Packit 4b6dd7
[closure]
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Since: 0.10.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_commentable_insert_comment_finish ()

Packit 4b6dd7
GDataComment *
Packit 4b6dd7
gdata_commentable_insert_comment_finish
Packit 4b6dd7
                               (GDataCommentable *self,
Packit 4b6dd7
                                GAsyncResult *result,
Packit 4b6dd7
                                GError **error);
Packit 4b6dd7

Finishes an asynchronous comment insertion operation started with gdata_commentable_insert_comment_async().

Packit 4b6dd7
Packit 4b6dd7

Parameters

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

self

Packit 4b6dd7

a GDataCommentable

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

result

Packit 4b6dd7

a GAsyncResult

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

error

Packit 4b6dd7

a GError, or NULL

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Returns

Packit 4b6dd7

the added GDataComment, or NULL; unref with g_object_unref().

Packit 4b6dd7

[transfer full][allow-none]

Packit 4b6dd7
Packit 4b6dd7

Since: 0.10.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_commentable_delete_comment ()

Packit 4b6dd7
gboolean
Packit 4b6dd7
gdata_commentable_delete_comment (GDataCommentable *self,
Packit 4b6dd7
                                  GDataService *service,
Packit 4b6dd7
                                  GDataComment *comment_,
Packit 4b6dd7
                                  GCancellable *cancellable,
Packit 4b6dd7
                                  GError **error);
Packit 4b6dd7

Deletes comment

Packit 4b6dd7
 from the GDataCommentable.

Packit 4b6dd7

If the given comment

Packit 4b6dd7
 isn't deletable (either because the service doesn't support deleting comments at all, or because this particular comment
Packit 4b6dd7
is not deletable due to having insufficient permissions), GDATA_SERVICE_ERROR_FORBIDDEN will be set in error
Packit 4b6dd7
 and FALSE will be returned.

Packit 4b6dd7
Packit 4b6dd7

Parameters

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

self

Packit 4b6dd7

a GDataCommentable

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

service

Packit 4b6dd7

a GDataService with which the comment will be deleted

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

comment_

Packit 4b6dd7

a comment to be deleted

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

cancellable

Packit 4b6dd7

optional GCancellable object, or NULL.

Packit 4b6dd7
[allow-none]
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

error

Packit 4b6dd7

a GError, or NULL

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Returns

Packit 4b6dd7

TRUE if the comment was successfully deleted, FALSE otherwise

Packit 4b6dd7
Packit 4b6dd7

Since: 0.10.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_commentable_delete_comment_async ()

Packit 4b6dd7
void
Packit 4b6dd7
gdata_commentable_delete_comment_async
Packit 4b6dd7
                               (GDataCommentable *self,
Packit 4b6dd7
                                GDataService *service,
Packit 4b6dd7
                                GDataComment *comment_,
Packit 4b6dd7
                                GCancellable *cancellable,
Packit 4b6dd7
                                GAsyncReadyCallback callback,
Packit 4b6dd7
                                gpointer user_data);
Packit 4b6dd7

Deletes comment

Packit 4b6dd7
 from the GDataCommentable. self
Packit 4b6dd7
, service
Packit 4b6dd7
 and comment_
Packit 4b6dd7
 are all reffed when this method is called, so can safely be freed after
Packit 4b6dd7
this method returns.

Packit 4b6dd7

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

Packit 4b6dd7

When the operation is finished, callback

Packit 4b6dd7
 will be called. You can then call gdata_commentable_delete_comment_finish() to get the results of the
Packit 4b6dd7
operation.

Packit 4b6dd7
Packit 4b6dd7

Parameters

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

self

Packit 4b6dd7

a GDataCommentable

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

service

Packit 4b6dd7

a GDataService with which the comment will be deleted

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

comment_

Packit 4b6dd7

a comment to be deleted

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

cancellable

Packit 4b6dd7

optional GCancellable object, or NULL.

Packit 4b6dd7
[allow-none]
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

callback

Packit 4b6dd7

a GAsyncReadyCallback to call when the operation is finished

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

user_data

Packit 4b6dd7

data to pass to the callback

Packit 4b6dd7
function. 

Packit 4b6dd7
[closure]
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Since: 0.10.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

gdata_commentable_delete_comment_finish ()

Packit 4b6dd7
gboolean
Packit 4b6dd7
gdata_commentable_delete_comment_finish
Packit 4b6dd7
                               (GDataCommentable *self,
Packit 4b6dd7
                                GAsyncResult *result,
Packit 4b6dd7
                                GError **error);
Packit 4b6dd7

Finishes an asynchronous comment deletion operation started with gdata_commentable_delete_comment_async().

Packit 4b6dd7
Packit 4b6dd7

Parameters

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

self

Packit 4b6dd7

a GDataCommentable

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

result

Packit 4b6dd7

a GAsyncResult

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

error

Packit 4b6dd7

a GError, or NULL

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Returns

Packit 4b6dd7

TRUE if the comment was successfully deleted, FALSE otherwise

Packit 4b6dd7
Packit 4b6dd7

Since: 0.10.0

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Types and Values

Packit 4b6dd7
Packit 4b6dd7

GDataCommentable

Packit 4b6dd7
typedef struct _GDataCommentable GDataCommentable;
Packit 4b6dd7

All the fields in the GDataCommentable structure are private and should never be accessed directly

Packit 4b6dd7

Since: 0.10.0

Packit 4b6dd7
Packit 4b6dd7

Packit 4b6dd7
Packit 4b6dd7

GDataCommentableInterface

Packit 4b6dd7
typedef struct {
Packit 4b6dd7
	GTypeInterface parent;
Packit 4b6dd7
Packit 4b6dd7
	GType comment_type;
Packit 4b6dd7
Packit 4b6dd7
	GDataAuthorizationDomain *(*get_authorization_domain) (GDataCommentable *self);
Packit 4b6dd7
Packit 4b6dd7
	gchar *(*get_query_comments_uri) (GDataCommentable *self);
Packit 4b6dd7
	gchar *(*get_insert_comment_uri) (GDataCommentable *self, GDataComment *comment);
Packit 4b6dd7
	gboolean (*is_comment_deletable) (GDataCommentable *self, GDataComment *comment);
Packit 4b6dd7
} GDataCommentableInterface;
Packit 4b6dd7
Packit 4b6dd7

The interface structure for the GDataCommentable interface.

Packit 4b6dd7
Packit 4b6dd7

Members

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

GTypeInterface parent;

Packit 4b6dd7

the parent type

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

GType comment_type;

Packit 4b6dd7

the GType of the comment class (subclass of GDataComment) to use for query results from this commentable object

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

get_authorization_domain ()

Packit 4b6dd7

a function to return the GDataAuthorizationDomain to be used for all operations on the comments

Packit 4b6dd7
belonging to this commentable object; not implementing this function is equivalent to returning NULL from it, which signifies that operations on the
Packit 4b6dd7
comments don't require authorization. 

Packit 4b6dd7
[allow-none]
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

get_query_comments_uri ()

Packit 4b6dd7

a function that returns the URI of a GDataFeed of comments from a commentable object, or NULL if the given commentable

Packit 4b6dd7
object doesn't support commenting; free with g_free()

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

get_insert_comment_uri ()

Packit 4b6dd7

a function that returns the URI to add new comments to the commentable object, or NULL if the given commentable object

Packit 4b6dd7
doesn't support adding comments; free with g_free()

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

is_comment_deletable ()

Packit 4b6dd7

a function that returns TRUE if the given comment may be deleted, FALSE otherwise

Packit 4b6dd7
 
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Since: 0.10.0

Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7
Packit 4b6dd7

Generated by GTK-Doc V1.26.1
Packit 4b6dd7
</body>
Packit 4b6dd7
</html>