認可処理を実行するクラスの抽象親クラス [詳細]

#import <MixiAuthorizer.h>

MixiAuthorizerに対する継承グラフ

Public メソッド
(BOOL)	- authorize:
	認可を実行
(BOOL)	- authorizeForPermission:
	認可を実行
(BOOL)	- authorizeForPermissions:
	認可を実行
(void)	- checkPermissions:
	有効なパーミッションかどうかを確認
(BOOL)	- refreshAccessToken
	リフレッシュトークンを使用してアクセストークンを同期的にリフレッシュ
(BOOL)	- refreshAccessTokenWithError:
	リフレッシュトークンを使用してアクセストークンを同期的にリフレッシュ
(NSURLConnection *)	- refreshAccessTokenWithDelegate:
(BOOL)	- isAuthorized
	アクセストークンを取得済みかどうか
(BOOL)	- isAccessTokenExpired
	アクセストークンが期限切れかどうか
(BOOL)	- isRefreshTokenExpired
	リフレッシュトークンが期限切れかどうか
(void)	- setPropertiesFromDictionary:
	辞書オブジェクトでプロパティをまとめて設定
(void)	- store
	インスタンスの情報を保持
(BOOL)	- restore
	インスタンスの情報を復帰
(void)	- clear
	端末が保持する認可情報クリア
(void)	- logout
	ログアウト
(BOOL)	- revoke
	認可状態を解除します。
(BOOL)	- revokeWithError:
	認可状態を解除します。
Protected 変数
Mixi *	mixi_
	Mixiオブジェクト
MixiUserDefaults *	userDefaults_
	設定値保存用
NSString *	accessToken_
	アクセストークン
NSString *	refreshToken_
	リフレッシュトークン
NSString *	expiresIn_
	アクセストークンの有効期間
NSString *	state_
	任意
NSDate *	accessTokenExpiryDate_
	アクセストークンの有効期限
プロパティ
Mixi *	mixi
NSString *	accessToken
NSString *	refreshToken
NSString *	expiresIn
NSString *	state
NSDate *	accessTokenExpiryDate

説明

認可処理を実行するクラスの抽象親クラス

関数

- (BOOL) authorize:	(NSString*)	permission
,		...

認可を実行

引数:

permission 要求するパーミッション。可変長。最後の引数は必ずnilにすること

戻り値:: 認可処理の起動に成功したらYESを返します。

- (BOOL) authorizeForPermission: (NSString*) permission

認可を実行

引数:

permission 要求するパーミッション。複数指定する場合は","区切りすること

戻り値:: 認可処理の起動に成功したらYESを返します。

- (BOOL) authorizeForPermissions: (NSArray*) permissions

認可を実行

引数:

permissions 要求するパーミッション

戻り値:: 認可処理の起動に成功したらYESを返します。

- (void) checkPermissions: (NSArray*) permissions

有効なパーミッションかどうかを確認

引数:

permissions 要求するパーミッション

例外:

パーミッションが不正

- (BOOL) isAccessTokenExpired

アクセストークンが期限切れかどうか

戻り値:: アクセストークンが期限切れかどうか

- (BOOL) isAuthorized

アクセストークンを取得済みかどうか

戻り値:: アクセストークンを取得済みかどうか

- (BOOL) isRefreshTokenExpired

リフレッシュトークンが期限切れかどうか

戻り値:: リフレッシュトークンが期限切れかどうか

- (void) logout

ログアウト

SDKが端末上に保持している情報をクリアします。

- (BOOL) refreshAccessToken

リフレッシュトークンを使用してアクセストークンを同期的にリフレッシュ

戻り値:: 成功したらYES、そうでなければNOを返します

- (NSURLConnection *) refreshAccessTokenWithDelegate: (id<MixiDelegate>) delegate

リフレッシュトークンを使用してアクセストークンを非同期にリフレッシュ

引数:

delegate 結果を受け取るデリゲート

戻り値:: コネクション。nilの場合は接続に失敗しています。

- (BOOL) refreshAccessTokenWithError: (NSError**) error

リフレッシュトークンを使用してアクセストークンを同期的にリフレッシュ

引数:

error エラー

戻り値:: 成功したらYES、そうでなければNOを返します

- (BOOL) restore

インスタンスの情報を復帰

戻り値:: 成功したらYES、そうでなければNOを返します

- (BOOL) revoke

認可状態を解除します。

戻り値:: 呼び出しに成功したらYESを返します。公式アプリ経由で処理を実行する場合はYESを返しても解除が成功しているとは限りません。

- (BOOL) revokeWithError: (NSError**) error

認可状態を解除します。

引数:

error エラー

戻り値:: 呼び出しに成功したらYESを返します。公式アプリ経由で処理を実行する場合はYESを返しても解除が成功しているとは限りません。

- (void) setPropertiesFromDictionary: (NSDictionary*) dict

辞書オブジェクトでプロパティをまとめて設定

引数:

dict	有効なキーは"access_token"、"refresh_token"、"expires_in"、"state"

このクラスの説明は次のファイルから生成されました:

Authorize/MixiAuthorizer.h
Authorize/MixiAuthorizer.m

Public メソッド

Protected 変数

プロパティ

説明

関数