[gnome-online-accounts] doc: Add goa_oauth2_provider_process_redirect_url



commit 85a92ab166496c07a52f0b6520bc69154d1e6f4f
Author: Debarshi Ray <debarshir gnome org>
Date:   Mon Jan 13 15:43:55 2014 +0100

    doc: Add goa_oauth2_provider_process_redirect_url
    
    https://bugzilla.gnome.org/show_bug.cgi?id=704564

 doc/goa-sections.txt               |    1 +
 src/goabackend/goaoauth2provider.c |   22 +++++++++++++++++++++-
 2 files changed, 22 insertions(+), 1 deletions(-)
---
diff --git a/doc/goa-sections.txt b/doc/goa-sections.txt
index 5e10d7c..67b90d0 100644
--- a/doc/goa-sections.txt
+++ b/doc/goa-sections.txt
@@ -483,6 +483,7 @@ goa_oauth2_provider_get_use_external_browser
 goa_oauth2_provider_add_account_key_values
 goa_oauth2_provider_get_identity_sync
 goa_oauth2_provider_get_access_token_sync
+goa_oauth2_provider_process_redirect_url
 <SUBSECTION Standard>
 GOA_OAUTH2_PROVIDER
 GOA_OAUTH2_PROVIDER_CLASS
diff --git a/src/goabackend/goaoauth2provider.c b/src/goabackend/goaoauth2provider.c
index 928771f..46de712 100644
--- a/src/goabackend/goaoauth2provider.c
+++ b/src/goabackend/goaoauth2provider.c
@@ -1,6 +1,6 @@
 /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
 /*
- * Copyright (C) 2011, 2012, 2013 Red Hat, Inc.
+ * Copyright (C) 2011, 2012, 2013, 2014 Red Hat, Inc.
  *
  * This library is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Lesser General Public
@@ -291,6 +291,26 @@ goa_oauth2_provider_build_authorization_uri (GoaOAuth2Provider  *provider,
                                                                                     escaped_scope);
 }
 
+/**
+ * goa_oauth2_provider_process_redirect_url:
+ * @provider: A #GoaOAuth2Provider.
+ * @redirect_url: A redirect URI from the web browser
+ * @authorization_code: (out): Return location for access token
+ * @error: Return location for error or %NULL
+ *
+ * Certain OAuth2-like, but not exactly <ulink
+ * url="http://tools.ietf.org/html/draft-ietf-oauth-v2-15";>OAuth2</ulink>,
+ * providers do not follow the standard mechanisms for extracting the
+ * access token or auth code from the redirect URI. They use some
+ * non-standard technique to do so. This is a provider specific hook
+ * to accommodate them and will only be used if implemented.
+ *
+ * This is a pure virtual method - a subclass must provide an
+ * implementation if needed.
+ *
+ * Returns: %TRUE if @provider could process @redirect_url, %FALSE
+ * otherwise.
+ */
 gboolean
 goa_oauth2_provider_process_redirect_url (GoaOAuth2Provider  *provider,
                                           const gchar        *redirect_url,


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]