| commit | author | age | ||
| a0a843 | 1 | // |
| H | 2 | // TWTROAuthSigning.h |
| 3 | // | |
| 4 | // Copyright (c) 2015 Twitter. All rights reserved. | |
| 5 | // | |
| 6 | ||
| 7 | #import <TwitterCore/TWTRCoreOAuthSigning.h> | |
| 8 | ||
| 9 | @class TWTRAuthConfig; | |
| 10 | @class TWTRSession; | |
| 11 | ||
| 12 | NS_ASSUME_NONNULL_BEGIN | |
| 13 | ||
| 14 | /** | |
| 15 | * This class provides tools to generate OAuth signatures. | |
| 16 | */ | |
| 17 | @interface TWTROAuthSigning : NSObject <TWTRCoreOAuthSigning> | |
| 18 | ||
| 19 | /** | |
| 20 | * @name Initialization | |
| 21 | */ | |
| 22 | ||
| 23 | /** | |
| 24 | * Instantiate a `TWTROAuthSigning` object with the parameters it needs to generate the OAuth signatures. | |
| 25 | * | |
| 26 | * @param authConfig (required) Encapsulates credentials required to authenticate a Twitter application. | |
| 27 | * @param authSession (required) Encapsulated credentials associated with a user session. | |
| 28 | * | |
| 29 | * @return An initialized `TWTROAuthSigning` object or nil if any of the parameters are missing. | |
| 30 | * | |
| 31 | * @note If you want to generate OAuth Echo headers to verify Digits' credentials, see `DGTOAuthSigning`. | |
| 32 | * | |
| 33 | * @see TWTRAuthConfig | |
| 34 | * @see TWTRSession | |
| 35 | */ | |
| 36 | - (instancetype)initWithAuthConfig:(TWTRAuthConfig *)authConfig authSession:(TWTRSession *)authSession NS_DESIGNATED_INITIALIZER; | |
| 37 | ||
| 38 | /** | |
| 39 | * Unavailable. Use `-initWithAuthConfig:authSession:` instead. | |
| 40 | */ | |
| 41 | - (instancetype)init NS_UNAVAILABLE; | |
| 42 | ||
| 43 | @end | |
| 44 | ||
| 45 | NS_ASSUME_NONNULL_END | |
