OAuth

public class OAuth: NSObject

A class for OAuth-ing with Twitter.

Note

You can obtain Twitter OAuth Acess Token like this:

let session = Session(consumerKey: <#consumerKey#>, consumerSecret: <#consumerSecret#>)
OAuth.requestRequestToken(session: session, completionHandler: { (<#requestToken#>, <#requestTokenSecret#>, <#error#>) in
    var urlComponents = URLComponents(url: OAuth.authorizeURL)
    urlComponents.query = "oauth_token=\(<#requestToken#>)"

    let authorizeURL = urlComponents.url

    // Open authorizeURL on WebView or anything. and get OAuth verifier

    OAuth.requestAccessToken(session: session, requestToken: <#requestToken#>, requestTokenSecret: <#requestTokenSecret#>, oauthVerifier: <#oauthVerifier#>, completionHandler: { (<#accessToken#>, <#accessTokenSecret#>, <#userID#>, <#screenName#>, <#error#>) in
        // Implementation
    })
})

xAuthMode
XAuth mode for OAuth requests.
See more
Declaration
Swift

public enum xAuthMode: UInt


                    
                    
                    RequestAccessTokenCompletionHandler

Request Access-Token Completion Handler

Parameters:
- accessToken: A access token that returned
- accessTokenSecret: A access secret token that returned
- userID: A user ID that returned
- screenName: A screen name that returned
- error: A error that returned

Declaration

Swift

public typealias RequestAccessTokenCompletionHandler = (_ accessToken: String?, _ accessTokenSecret: String?, _ userID: Int64, _ screenName: String?, _ error: Swift.Error?) -> Void

Parameters

`accessToken`	A access token that returned
`accessTokenSecret`	A access secret token that returned
`userID`	A user ID that returned
`screenName`	A screen name that returned
`error`	A error that returned

authorizeURL
A URL for authorize endpoint. Desktop applications must use this endpoint.

Seealso
Twitter Developer Documentation
Declaration
Swift

public static var authorizeURL: URL
authenticateURL
A URL for authenticate endpoint.

Seealso
Twitter Developer Documentation
Declaration
Swift

public static var authenticateURL: URL


                    
                    
                    requestRequestToken(session:callback:completionHandler:)

Request Request-Token from Twitter OAuth 1.0a

Parameters:
- session: A session for request.
- callback: OAuth callback string. The value you specify here will be used as the URL a user is redirected to should they approve your application’s access to their account. Set this to oob for out-of-band pin mode. This is also how you specify custom callbacks for use in desktop/mobile applications.
- completionHandler: A handler that will be called after completion.
- requestToken: A request token that returned
- requestTokenSecret: A request secret token that returned
- error: A error that returned

Declaration

Swift

@objc public class func requestRequestToken(session: Session, callback: String = "oob", completionHandler: @escaping (_ requestToken: String?, _ requestTokenSecret: String?, _ error: Swift.Error?) -> Void)

Parameters

`session`	A session for request.
`callback`	OAuth callback string. The value you specify here will be used as the URL a user is redirected to should they approve your application’s access to their account. Set this to `oob` for out-of-band pin mode. This is also how you specify custom callbacks for use in desktop/mobile applications.
`completionHandler`	A handler that will be called after completion.
`requestToken`	A request token that returned
`requestTokenSecret`	A request secret token that returned
`error`	A error that returned


                    
                    
                    requestRequestTokenForxAuthReverse(session:completionHandler:)

Request Request-Token from Twitter OAuth 1.0a for Reverse Auth

Parameters:
- session: A session for request.
- completionHandler: A handler that will be called after completion.
- response: A string that returned for access token
- error: A error that returned

Declaration

Swift

@objc public class func requestRequestTokenForxAuthReverse(session: Session, completionHandler: @escaping (_ response: String?, _ error: Swift.Error?) -> Void)

Parameters

`session`	A session for request.
`completionHandler`	A handler that will be called after completion.
`response`	A string that returned for access token
`error`	A error that returned


                    
                    
                    requestAccessToken(session:requestToken:requestTokenSecret:xAuthMode:xAuthUsername:xAuthPassword:oauthVerifier:completionHandler:)

Request Access-Token from Twitter OAuth 1.0a

Parameters:
- session: A session for request.
- requestToken: A request token.
- requestTokenSecret: A request token secret.
- xAuthMode: xAuth mode. For possible values, see xAuthMode.
- xAuthUsername: A username for xAuth ClientAuth.
- xAuthPassword: A password for xAuth ClientAuth.
- oauthVerifier: A verifier from oauth/authentication.
- completionHandler: A handler that will be called after completion.

Declaration

Swift

@objc public class func requestAccessToken(session: Session, requestToken: String, requestTokenSecret: String, xAuthMode: xAuthMode = .None, xAuthUsername: String? = nil, xAuthPassword: String? = nil, oauthVerifier: String? = nil, completionHandler: @escaping RequestAccessTokenCompletionHandler)

Parameters

`session`	A session for request.
`requestToken`	A request token.
`requestTokenSecret`	A request token secret.
`xAuthMode`	xAuth mode. For possible values, see xAuthMode.
`xAuthUsername`	A username for xAuth ClientAuth.
`xAuthPassword`	A password for xAuth ClientAuth.
`oauthVerifier`	A verifier from oauth/authentication.
`completionHandler`	A handler that will be called after completion.


                    
                    
                    requestAccessToken(session:accountForxAuthReverse:requestResponse:completionHandler:)

Request Access-Token from Twitter OAuth 1.0a

Parameters:
- session: A session for request.
- account: A account from ACAccountStore for request
- requestResponse: A request response.
- completionHandler: A handler that will be called after completion.

Declaration

Swift

@objc public class func requestAccessToken(session: Session, accountForxAuthReverse account: ACAccount, requestResponse: String, completionHandler: @escaping RequestAccessTokenCompletionHandler)

Parameters

`session`	A session for request.
`account`	A account from ACAccountStore for request
`requestResponse`	A request response.
`completionHandler`	A handler that will be called after completion.