サイトのトップへ戻る

Twitter 開発者 ドキュメント日本語訳

サイト内検索

TWTRAPIClient クラスのリファレンス

Twitter REST APIを使用するためのクライアント。カスタムリクエストを作成して送信する機能と同様に、一般的なAPIリクエストを扱うメソッドも用意されています。

継承元 NSObject
宣言場所 TWTRAPIClient.h


Tasks

初期化

– initWithConsumerKey:consumerSecret:

リクエストを作成する

– URLRequestWithMethod:URL:parameters:error:
– sendTwitterRequest:completion:

一般的なAPI 動作

– loadUserWithID:completion:
– loadTweetWithID:completion:
– loadTweetsWithIDs:completion:



インスタンスメソッド



URLRequestWithMethod:URL:parameters:error:

署名済みのURLリクエストを戻り値として返します。

- (NSURLRequest *)URLRequestWithMethod:(NSString *)method URL:(NSString *)URLString parameters:(NSDictionary *)parameters error:(NSError **)error
パラメータ

method

GET, POST, PUT, DELETE, などのリクエストメソッド。

parameters

リクエストパラメータ。

error

リクエストの署名でエラーが発生した場合に設定されるエラー。

URL

リクエストURL。これは Twitter APIのフルURLです。 例えば、 https://api.twitter.com/1.1/statuses/user_timeline.json
宣言場所

TWTRAPIClient.h

頭に国コードが付いた、ユーザーから提供された電話番号(例えば +15554443322)。

@property (nonatomic, copy, readonly) NSString *phoneNumber


initWithConsumerKey:consumerSecret:

Designated initializer.

- (instancetype)initWithConsumerKey:(NSString *)consumerKey consumerSecret:(NSString *)consumerSecret
パラメータ

consumerKey

Twitter アプリケーションのコンシューマキー.

consumerSecret

Twitter アプリケーションのコンシューマ秘密情報。
宣言場所

TWTRAPIClient.h



loadTweetWithID:completion:

ネットワークもしくはキャッシュから、ツイートを一つ読み込む。

- (void)loadTweetWithID:(NSString *)tweetIDString completion:(TWTRLoadTweetCompletion)completion
パラメータ

tweetIDString

読み込むツイートのID。

completion

応答時に呼び出されるCompletion ブロック。メインキューで呼び出されます。
宣言場所

TWTRAPIClient.h



loadTweetsWithIDs:completion:

Loads a series of Tweets in a batch. The completion block will be passed an array of zero or more Tweets that loaded successfully. If some Tweets fail to load the array will contain less Tweets than number of requested IDs. If any Tweets fail to load, the IDs of the Tweets that did not load will be provided in the userInfo dictionary property of the error parameter under TWTRTweetsNotLoadedKey.

- (void)loadTweetsWithIDs:(NSArray *)tweetIDStrings completion:(TWTRLoadTweetsCompletion)completion
Parameters

tweetIDStrings

An array of Tweet IDs.

completion

Completion block to be called on response. Called on main queue.
Declared In

TWTRAPIClient.h



loadUserWithID:completion:

Loads a Twitter User.

- (void)loadUserWithID:(NSString *)userIDString completion:(TWTRLoadUserCompletion)completion
Parameters

userIDString

The Twitter user ID of the desired user.

completion

Completion block to be called on response. Called on main queue.
Declared In

TWTRAPIClient.h



sendTwitterRequest:completion:

Sends a Twitter request.

- (void)sendTwitterRequest:(NSURLRequest *)request completion:(TWTRNetworkCompletion)completion
Parameters

request

The Twitter user ID of the desired user.

completion

Completion block to be called on response. Called on main queue.
Declared In

TWTRAPIClient.h




エンジェル戦記