oauth_proxy_new ()

RestProxy *
oauth_proxy_new (const char *consumer_key,
                 const char *consumer_secret,
                 const gchar *url_format,
                 gboolean binding_required);

Create a new OAuthProxy for the specified endpoint url_format , using the specified API key and secret.

This proxy won't have the Token or Token Secret set so as such will be unauthorised. If the tokens are unknown then oauth_proxy_request_token() and oauth_proxy_access_token() should be called to do the OAuth authorisation, or the tokens should be set using oauth_proxy_set_token() and oauth_proxy_set_token_secret().

Set binding_required to TRUE if the URL contains string formatting operations (for example "http://foo.com/%s". These must be expanded using rest_proxy_bind() before invoking the proxy.

oauth_proxy_new_echo_proxy ()

RestProxy *
oauth_proxy_new_echo_proxy (OAuthProxy *proxy,
                            const char *service_url,
                            const gchar *url_format,
                            gboolean binding_required);

Create a new OAuth Echo proxy.

oauth_proxy_new_with_token ()

RestProxy *
oauth_proxy_new_with_token (const char *consumer_key,
                            const char *consumer_secret,
                            const char *token,
                            const char *token_secret,
                            const gchar *url_format,
                            gboolean binding_required);

Create a new OAuthProxy for the specified endpoint url_format , using the specified API key and secret.

token and token_secret are used for the Access Token and Token Secret, so if they are still valid then this proxy is authorised.

Set binding_required to TRUE if the URL contains string formatting operations (for example "http://foo.com/%s". These must be expanded using rest_proxy_bind() before invoking the proxy.

OAuthProxyAuthCallback ()

void
(*OAuthProxyAuthCallback) (OAuthProxy *proxy,
                           const GError *error,
                           GObject *weak_object,
                           gpointer userdata);

Callback from oauth_proxy_request_token_async() and oauth_proxy_access_token_async().

oauth_proxy_auth_step ()

gboolean
oauth_proxy_auth_step (OAuthProxy *proxy,
                       const char *function,
                       GError **error);

Perform an OAuth authorisation step. This calls function and then updates the token and token secret in the proxy.

proxy must not require binding, the function will be invoked using rest_proxy_call_set_function().

oauth_proxy_auth_step_async ()

gboolean
oauth_proxy_auth_step_async (OAuthProxy *proxy,
                             const char *function,
                             OAuthProxyAuthCallback callback,
                             GObject *weak_object,
                             gpointer user_data,
                             GError **error_out);

Perform an OAuth authorisation step. This calls function and then updates the token and token secret in the proxy.

proxy must not require binding, the function will be invoked using rest_proxy_call_set_function().

oauth_proxy_request_token ()

gboolean
oauth_proxy_request_token (OAuthProxy *proxy,
                           const char *function,
                           const char *callback_uri,
                           GError **error);

Perform the Request Token phase of OAuth, invoking function (defaulting to "request_token" if function is NULL).

The value of callback depends on whether you wish to use OAuth 1.0 or 1.0a. If you wish to use 1.0 then callback must be NULL. To use 1.0a then callback should either be your callback URI, or "oob" (out-of-band).

oauth_proxy_request_token_async ()

gboolean
oauth_proxy_request_token_async (OAuthProxy *proxy,
                                 const char *function,
                                 const char *callback_uri,
                                 OAuthProxyAuthCallback callback,
                                 GObject *weak_object,
                                 gpointer user_data,
                                 GError **error);

Perform the Request Token phase of OAuth, invoking function (defaulting to "request_token" if function is NULL).

The value of callback depends on whether you wish to use OAuth 1.0 or 1.0a. If you wish to use 1.0 then callback must be NULL. To use 1.0a then callback should either be your callback URI, or "oob" (out-of-band).

This method will return once the method has been queued, callback will be invoked when it has completed.

oauth_proxy_is_oauth10a ()

gboolean
oauth_proxy_is_oauth10a (OAuthProxy *proxy);

Determines if the server supports OAuth 1.0a with this proxy. This is only valid after oauth_proxy_request_token() or oauth_proxy_request_token_async() has been called.

oauth_proxy_access_token ()

gboolean
oauth_proxy_access_token (OAuthProxy *proxy,
                          const char *function,
                          const char *verifier,
                          GError **error);

Perform the Access Token phase of OAuth, invoking function (defaulting to "access_token" if function is NULL).

verifier is only used if you are using OAuth 1.0a. This is either the "oauth_verifier" parameter that was passed to your callback URI, or a string that the user enters in some other manner (for example in a popup dialog) if "oob" was passed to oauth_proxy_request_token(). For OAuth 1.0, pass NULL.

oauth_proxy_access_token_async ()

gboolean
oauth_proxy_access_token_async (OAuthProxy *proxy,
                                const char *function,
                                const char *verifier,
                                OAuthProxyAuthCallback callback,
                                GObject *weak_object,
                                gpointer user_data,
                                GError **error);

Perform the Access Token phase of OAuth, invoking function (defaulting to "access_token" if function is NULL).

verifier is only used if you are using OAuth 1.0a. This is either the "oauth_verifier" parameter that was passed to your callback URI, or a string that the user enters in some other manner (for example in a popup dialog) if "oob" was passed to oauth_proxy_request_token(). For OAuth 1.0, pass NULL.

This method will return once the method has been queued, callback will be invoked when it has completed.

oauth_proxy_get_token ()

const char *
oauth_proxy_get_token (OAuthProxy *proxy);

Get the current request or access token.

oauth_proxy_set_token ()

void
oauth_proxy_set_token (OAuthProxy *proxy,
                       const char *token);

Set the access token.

oauth_proxy_get_token_secret ()

const char *
oauth_proxy_get_token_secret (OAuthProxy *proxy);

Get the current request or access token secret.

oauth_proxy_set_token_secret ()

void
oauth_proxy_set_token_secret (OAuthProxy *proxy,
                              const char *token_secret);

Set the access token secret.

oauth_proxy_get_signature_host ()

const char *
oauth_proxy_get_signature_host (OAuthProxy *proxy);

Get the signature hostname used when creating a signature base string.

oauth_proxy_set_signature_host ()

void
oauth_proxy_set_signature_host (OAuthProxy *proxy,
                                const char *signature_host);

Set the signature hostname used when creating a signature base string.

OAuthProxy

typedef struct _OAuthProxy OAuthProxy;

OAuthProxy has no publicly available members.

enum OAuthSignatureMethod

The signature method to use when signing method calls. PLAINTEXT is only recommended for testing, in general HMAC_SHA1 is well supported and more secure.

The “consumer-key” property

  “consumer-key”             char *

The consumer key.

Owner: OAuthProxy

Flags: Read / Write / Construct Only

Default value: NULL

The “consumer-secret” property

  “consumer-secret”          char *

The consumer secret.

Owner: OAuthProxy

Flags: Read / Write / Construct Only

Default value: NULL

The “signature-host” property

  “signature-host”           char *

The base URL used in the signature string.

Owner: OAuthProxy

Flags: Read / Write

Default value: NULL

The “signature-method” property

  “signature-method”         OAuthSignatureMethod

Signature method used.

Owner: OAuthProxy

Flags: Read / Write

Default value: HMAC_SHA1

The “token” property

  “token”                    char *

The request or access token.

Owner: OAuthProxy

Flags: Read / Write

Default value: NULL

The “token-secret” property

  “token-secret”             char *

The request or access token secret.

Owner: OAuthProxy

Flags: Read / Write

Default value: NULL