iOS SDKリファレンス

クラス

LineSDKAPI

クラス

Social APIを呼び出すためのユーティリティクラスです。

スーパークラス

NSObject

宣言されているファイル

LineSDKAPI.h

メソッド

initWithConfiguration
- (instancetype)initWithConfiguration:(LineSDKConfiguration *)configuration NS_DESIGNATED_INITIALIZER;

LineSDKConfigurationを使ってLineSDKAPIを初期化します。

currentAccessToken
- (nullable LineSDKAccessToken *)currentAccessToken;

SDKで使用されている、ユーザーのアクセストークンを取得します。

戻り値

アクセストークンがある場合は、アクセストークンを含むLineSDKAccessTokenを返します。アクセストークンがない場合は、nilを返します。

getProfileWithCallbackQueue:completion
- (void)getProfileWithCallbackQueue:(dispatch_queue_t)queue completion:(LineSDKAPIGetProfileCompletion)completion NS_SWIFT_NAME(getProfile(queue:completion:));

ユーザーのプロフィール情報を取得します。完了ブロックを実行するディスパッチキューを指定するには、queueパラメータに指定します。

パラメータ
パラメータ 説明
queue 完了ブロックを実行するキューです。このパラメータがnilの場合、完了ブロックはメインキューで実行されます。
completion ユーザーのプロフィール情報が返されたときに呼び出される完了ブロックです。
完了ブロックの引数
引数 説明
profile ユーザーのプロフィール情報です。
error APIコールにより返されるエラーです。成功した場合はnilです。
getProfileWithCompletion
- (void)getProfileWithCompletion:(void(^)(LineSDKProfile * _Nullable profile, NSError * _Nullable error))completion NS_SWIFT_NAME(getProfile(completion:));

ユーザーのプロフィール情報を取得します。完了ブロックはメインキューで実行されます。

パラメータ
パラメータ 説明
completion ユーザーのプロフィール情報が返されたときに呼び出される完了ブロックです。
完了ブロックの引数
引数 説明
profile ユーザーのプロフィール情報です。
error APIコールにより返されるエラーです。成功した場合はnilです。
logoutWithCallbackQueue:completion
- (void)logoutWithCallbackQueue:(dispatch_queue_t)queue completion:(LineSDKAPILogoutCompletion)completion NS_SWIFT_NAME(logout(queue:completion:));

アクセストークンを取り消します。完了ブロックを実行するディスパッチキューを指定するには、queueパラメータに指定します。

パラメータ
パラメータ 説明
queue 完了ブロックを実行するキューです。このパラメータがnilの場合、完了ブロックはメインキューで実行されます。
completion ログアウトが完了したときに呼び出される完了ブロックです。
完了ブロックの引数
引数 説明
success ログアウトが成功した場合はYESです。失敗した場合はNOです。
error APIコールにより返されるエラーです。成功した場合はnilです。
logoutWithCompletion
- (void)logoutWithCompletion:(void(^)(BOOL success, NSError * _Nullable error))completion;

アクセストークンを取り消します。完了ブロックはメインキューで実行されます。

パラメータ
パラメータ 説明
completion ログアウトが完了したときに呼び出される完了ブロックです。
完了ブロックの引数
引数 説明
success ログアウトが成功した場合はYESです。失敗した場合はNOです。
error APIコールにより返されるエラーです。成功した場合はnilです。
refreshTokenWithCallbackQueue:completion
- (void)refreshTokenWithCallbackQueue:(dispatch_queue_t)queue completion:(LineSDKAPITokenRefreshCompletion)completion NS_SWIFT_NAME(refreshToken(queue:completion:));

SDKで使用されている、ユーザーのアクセストークンを更新します。完了ブロックを実行するディスパッチキューを指定するには、queueパラメータに指定します。

パラメータ
パラメータ 説明
queue 完了ブロックを実行するキューです。このパラメータがnilの場合、完了ブロックはメインキューで実行されます。
completion アクセストークンが更新されたときに呼び出される完了ブロックです。
完了ブロックの引数
引数 説明
accessToken 更新されたアクセストークンです。
error APIコールにより返されるエラーです。成功した場合はnilです。
refreshTokenWithCompletion
- (void)refreshTokenWithCompletion:(void(^)(LineSDKAccessToken * _Nullable accessToken, NSError * _Nullable error))completion;

SDKで使用されている、ユーザーのアクセストークンを更新します。完了ブロックはメインキューで実行されます。

パラメータ
パラメータ 説明
completion アクセストークンが更新されたときに呼び出される完了ブロックです。
完了ブロックの引数
引数 説明
accessToken 更新されたアクセストークンです。
error APIコールにより返されるエラーです。成功した場合はnilです。
verifyTokenWithCallbackQueue:Completion
- (void)verifyTokenWithCallbackQueue:(dispatch_queue_t)queue completion:(LineSDKAPIVerifyTokenCompletion)completion NS_SWIFT_NAME(verifyToken(queue:completion));

SDKで使用されている、ユーザーのアクセストークンが有効かどうかを確認します。完了ブロックを実行するディスパッチキューを指定するには、queueパラメータに指定します。

パラメータ
パラメータ 説明
queue 完了ブロックを実行するキューです。このパラメータがnilの場合、完了ブロックはメインキューで実行されます。
completion ユーザーのトークンが検証されたときに呼び出される完了ブロックです。
完了ブロックの引数
引数 説明
result 検証コールの結果です。
error APIコールにより返されるエラーです。成功した場合はnilです。
verifyTokenWithCompletion
- (void)verifyTokenWithCompletion:(void(^)(LineSDKVerifyResult * _Nullable result, NSError * _Nullable error))completion;

SDKで使用されている、ユーザーのアクセストークンが有効かどうかを確認します。完了ブロックはメインキューで実行されます。

パラメータ
パラメータ 説明
completion ユーザーのトークンが検証されたときに呼び出される完了ブロックです。
完了ブロックの引数
引数 説明
result 検証コールの結果です。
error APIコールにより返されるエラーです。成功した場合はnilです。

LineSDKAccessToken

クラス

Social APIを呼び出すために使うアクセストークンを表します。

スーパークラス

NSObject

宣言されているファイル

LineSDKAccessToken.h

プロパティ

accessToken
@property (nonatomic, copy, readonly) NSString *accessToken;

アクセストークンです。

expiresIn
@property (nonatomic, readonly) NSTimeInterval expiresIn;

アクセストークンの有効期限が切れるまでの時間です。単位はミリ秒です。

メソッド

estimatedExpiredDate
- (NSDate *)estimatedExpiredDate;

アクセストークンの有効期限が切れると予測されるUNIXタイムです。クライアントにキャッシュされている日時を使って計算されるため、このメソッドで返される有効期限は正確ではありません。

戻り値

アクセストークンの有効期限が切れると予測されるUNIXタイムです。

LineSDKCredential

クラス

Social APIへのアクセス権を付与するために使用される資格情報を表します。

スーパークラス

NSObject

宣言されているファイル

LineSDKAPI.h

プロパティ

accessToken
@property (nonatomic, strong, readonly, nullable) LineSDKAccessToken *accessToken;

アクセストークンです。

権限
@property (nonatomic, strong, readonly) NSOrderedSet<NSString *> *permissions;

アクセストークンが保持する権限のセットです。権限コードのリストは以下のとおりです。

権限コード 説明
P トークンを使ってユーザーのプロフィール情報を取得できます。

LineSDKLogin

クラス

LINEログインの実行に使われるメソッドを提供します。

スーパークラス

NSObject

宣言されているファイル

LineSDKLogin.h

プロトコル

LineSDKLoginDelegate

プロパティ

configuration
@property (nonatomic, strong, readonly) LineSDKConfiguration *configuration;

チャネルIDやアクセストークンなど、LINE SDKのさまざまな設定値を含みます。

メソッド

canLoginWithLineApp
- (BOOL)canLoginWithLineApp;

LINEアプリを使ってログインできるかどうかを確認します。

戻り値

LINEアプリを使ってログインできる場合はYES、できない場合はNOです。NOが返される場合は、LINEアプリがデバイスにインストールされていないことを意味します。

handleOpenURL
- (BOOL)handleOpenURL:(NSURL *)aURL;

アプリ連携認証の処理中にLINEアプリから返されるデータを制御します。以下の例のように、あなたのアプリのopenURLメソッドでhandleOpenUrlメソッドを呼び出す必要があります。

openURLの例
- (BOOL)application:(UIApplication *)app openURL:(NSURL *)url options:(NSDictionary<UIApplicationOpenURLOptionsKey,id> *)options
{
return [[LineSDKLogin sharedInstance] handleOpenURL:url];
}
パラメータ
パラメータ 説明
aURL openURLの呼び出しに渡されるURLです。
戻り値

SDKによりURLが正しく処理された場合はYES、処理されなかった場合はNOです。

installLineApp
- (void)installLineApp;

LINEアプリをインストールするためにアプリストアに遷移します。

isAuthorized
- (BOOL)isAuthorized;

ユーザーがログイン済みでアクセストークンを持っているかどうかを確認します。

戻り値

SDKがユーザーのアクセストークンを保有している場合はYESです。これはユーザーがログイン済みであることを表します。SDKがアクセストークンを保有していない場合はNOです。

isAuthorizing
- (BOOL)isAuthorizing;

ログイン処理が進行中であるかどうかを確認します。

戻り値

ログイン処理が進行中であればYESです。そうでなければNOです。

sharedInstance
+ (instancetype)sharedInstance;

LineSDKLoginのシングルトンインスタンスを返します。

startLogin
- (void)startLogin;

ログイン処理を開始します。LINEアプリがインストール済みの場合は、アプリ連携認証が使用されます。インストール済みでない場合は、ブラウザを使用してログインが実行されます。

startWebLoginWithSafariViewController
- (void)startWebLoginWithSafariViewController:(BOOL)useSafariViewControllerIfAvailable;

ログイン処理を開始します。このメソッドでは、ブラウザまたはSafariのview controllerを使用してログインします。アプリ連携認証は使用しません。

パラメータ
パラメータ 説明
useSafariViewControllerIfAvailable YESの場合は、Safariのview controlleを使ってログインを実行します。NOの場合は、ブラウザを使用してログインを実行します。

LineSDKConfiguration

クラス

SDKの初期化に必要な設定を含みます。

スーパークラス

NSObject

宣言されているファイル

LineSDKConfiguration.h

プロパティ

channelID
@property (nonatomic, strong, readonly) NSString *channelID;

アプリケーションで使用されるチャネルIDです。この値は、アプリケーションのInfo.plistLineSDKConfigセクションから読み取られます。

メソッド

currentAccessToken
- (nullable LineSDKAccessToken *)currentAccessToken;

SDKにより格納されるアクセストークンを返します。

LineSDKProfile

クラス

Social APIでのユーザーのLINEプロフィールを表します。

スーパークラス

NSObject

宣言されているファイル

LineSDKProfile.h

プロパティ

displayName
@property (nonatomic, copy, readonly) NSString *displayName;

ユーザーの表示名です。

pictureURL
@property (nonatomic, copy, readonly, nullable) NSURL *pictureURL;

ユーザーのプロフィールメディアURLです。

statusMessage
@property (nonatomic, copy, readonly, nullable) NSString *statusMessage;

ユーザーのステータスメッセージです。

userId
@property (nonatomic, copy, readonly) NSString *userID;

ユーザーIDです。

LineSDKVerifyResult

クラス

アクセストークンの検証を試行した結果を記述します。

スーパークラス

NSObject

宣言されているファイル

LineSDKVerifyResult.h

プロパティ

channelID

@property (nonatomic, copy, readonly) NSString *channelID;

アプリケーションで使用されるチャネルIDです。

expiresIn

@property (nonatomic, readonly) NSTimeInterval expiresIn;

ユーザーのアクセストークンの有効期限が切れるまでの時間です。単位はミリ秒です。

権限

@property (nonatomic, copy, readonly, nullable) NSOrderedSet<NSString *> *permissions;

ユーザーのアクセストークンが保持する権限のセットです。権限コードのリストは以下のとおりです。

権限コード 説明
P トークンを使ってユーザーのプロフィール情報を取得できます。

プロトコル

LineSDKLoginDelegate

プロトコル

LineSDKLoginのオブジェクトからイベント通知を受信するために使用するメソッドを定義します。

拡張プロトコル

NSObject

宣言されているファイル

LineSDKLogin.h

メソッド

didLogin
- (void)didLogin:(LineSDKLogin *)login
credential:(nullable LineSDKCredential *)credential
profile:(nullable LineSDKProfile *)profile
error:(nullable NSError *)error;
パラメータ
パラメータ 説明
login ログインを要求するために使用されるLineSDKLoginオブジェクトです。
credential ログイン要求により付与される資格情報です。
profile ユーザーのプロフィール情報です。
error ログイン要求が失敗した場合は、エラーの情報です。ログインが成功した場合はnilです。