TWTRCoreOAuthSigning Protocol Reference

Conforms to NSObject
Declared in TWTRCoreOAuthSigning.h

OAuth Echo

– OAuthEchoHeadersForRequestMethod:URLString:parameters:error: required method

OAuth Echo is a means to securely delegate OAuth authorization to a third party while interacting with an API. For example, you may wish to verify a user’s credentials from your app’s server (the third party) rather than your app. This method provides you with the OAuth signature to add to the third party’s request to URLString, as well as the formed URL with the query string to send that request to. This is equivalent to calling -URLRequestWithMethod:URL:parameters:error: and getting the URL and the Authorization HTTP header out of the request.

- (NSDictionary *)OAuthEchoHeadersForRequestMethod:(NSString *)method URLString:(NSString *)URLString parameters:(nullable NSDictionary *)parameters error:(NSError **)error

Parameters

method

Request method, GET, POST, PUT, DELETE, etc.

URLString

The full URL of the Twitter endpoint you plan to send a request to. E.g. https://api.twitter.com/1.1/account/verify_credentials.json

parameters

Request parameters.

error

Error in the TWTRErrorDomain domain. The code will be TWTRErrorCodeInvalidURL if the URLString’s host is not api.twitter.com

Return Value

nil if there’s an error or a missing required parameter, or a dictionary with the fully formed request URL under TWTROAuthEchoRequestURLStringKey (NSString), and the Authorization header in TWTROAuthEchoAuthorizationHeaderKey (NSString), to be used to sign the request.

See Also

Declared In

TWTRCoreOAuthSigning.h

– OAuthEchoHeadersToVerifyCredentials required method

This method provides you with the OAuth signature, as well as the formed URL with the query string, to send a request to verify_credentials.

- (NSDictionary *)OAuthEchoHeadersToVerifyCredentials

Return Value

A dictionary with the fully formed Request URL under TWTROAuthEchoRequestURLStringKey (NSString), and the Authorization header in TWTROAuthEchoAuthorizationHeaderKey (NSString), to be used to sign the request.

See Also

Declared In

TWTRCoreOAuthSigning.h