summaryrefslogtreecommitdiff
path: root/gfbgraph
diff options
context:
space:
mode:
authorÁlvaro Peña <alvaropg@gmail.com>2013-05-07 18:46:22 +0200
committerÁlvaro Peña <alvaropg@gmail.com>2013-05-07 18:46:22 +0200
commit3925f13448439779c10e7372cce23f54c3d64f52 (patch)
tree94daa3567f0f364e364fa058de08109fe2719f4e /gfbgraph
parent6b3b9e36d55a394e2666ad00f085af8d42764bfe (diff)
downloadlibgfbgraph-3925f13448439779c10e7372cce23f54c3d64f52.tar.gz
More documentation (copied from libzapojit :)
Diffstat (limited to 'gfbgraph')
-rw-r--r--gfbgraph/gfbgraph-authorizer.h13
1 files changed, 11 insertions, 2 deletions
diff --git a/gfbgraph/gfbgraph-authorizer.h b/gfbgraph/gfbgraph-authorizer.h
index c6bcbac..c85c0f4 100644
--- a/gfbgraph/gfbgraph-authorizer.h
+++ b/gfbgraph/gfbgraph-authorizer.h
@@ -29,13 +29,22 @@ G_BEGIN_DECLS
#define GFBGRAPH_TYPE_AUTHORIZER (gfbgraph_authorizer_get_type ())
#define GFBGRAPH_AUTHORIZER(o) (G_TYPE_CHECK_INSTANCE_CAST ((o), GFBGRAPH_TYPE_AUTHORIZER, GFBGraphAuthorizer))
-#define GFBGRAPH_AUTHORIZER_CLASS(k) (G_TYPE_CHECK_CLASS_CAST((k), GFBGRAPH_TYPE_AUTHORIZER, GFBGraphAuthorizerInterface))
#define GFBGRAPH_IS_AUTHORIZER(o) (G_TYPE_CHECK_INSTANCE_TYPE ((o), GFBGRAPH_TYPE_AUTHORIZER))
#define GFBGRAPH_AUTHORIZER_GET_IFACE(o) (G_TYPE_INSTANCE_GET_INTERFACE ((o), GFBGRAPH_TYPE_AUTHORIZER, GFBGraphAuthorizerInterface))
typedef struct _GFBGraphAuthorizer GFBGraphAuthorizer;
typedef struct _GFBGraphAuthorizerInterface GFBGraphAuthorizerInterface;
+/**
+ * GFBGraphAuthorizerInterface:
+ * @parent: The parent interface.
+ * @process_call: A method to append authorization headers to a a #RestProxyCall.
+ * @process_message: A method to append authorization headers to a #SoupMessage.
+ * @refresh_authorization: A synchronous method to force a refresh of any authorization
+ * tokes held by the authorizer. It should return %TRUE on succes.
+ *
+ * Interface structure for #GFBGraphAuthorizer. All methos should be thread safe.
+ **/
struct _GFBGraphAuthorizerInterface {
GTypeInterface parent;
@@ -48,7 +57,7 @@ struct _GFBGraphAuthorizerInterface {
GError **error);
};
-GType gfbgraph_authorizer_get_type (void) G_GNUC_CONST;
+GType gfbgraph_authorizer_get_type (void) G_GNUC_CONST;
void gfbgraph_authorizer_process_call (GFBGraphAuthorizer *iface,
RestProxyCall *call);