LINE SDK wrapper for React Native 🚀

• LINE SDK v5 for iOS, wrapped with Swift.
• LINE SDK v5 for Android, wrapped with Kotlin.

Requirements

• Android minSdkVersion must be 24 or higher.
• iOS deploymentTarget must be 15.1 or higher.
• A LINE developer account and a configured channel are required.

[!IMPORTANT] @xmartlabs/react-native-line v6 is a TurboModule and requires the new architecture to be enabled.

• To use v6, enable the new architecture in your app (see how to enable the new architecture).
• If you cannot enable the new architecture yet, use @xmartlabs/react-native-line v4 instead.

Installation

With Expo

1. Install the package:

   npx expo install @xmartlabs/react-native-line

2. Add the expo-build-properties and @xmartlabs/react-native-line plugins to your app.json:

   "plugins": [
     [
       "expo-build-properties",
       {
         "ios": {
           "useFrameworks": "static"
         }
       }
     ],
     "@xmartlabs/react-native-line"
   ]

With React Native CLI

1. Install the package:

   npm install @xmartlabs/react-native-line
   # or
   yarn add @xmartlabs/react-native-line

2. Install the iOS native dependencies:

   cd ios && pod install

3. Update your AppDelegate to forward URL callbacks to the LINE SDK:

   Objective-C

   #import "react_native_line-Swift.h"
   
   ...
   
   - (BOOL)application:(UIApplication *)application openURL:(NSURL *)url options:(NSDictionary<UIApplicationOpenURLOptionsKey,id> *)options
   {
     return [LineLogin application:application open:url options:options];
   }

   Swift

   import react_native_line
   
   ...
   
   override func application(_ application: UIApplication, open url: URL, options: [UIApplication.OpenURLOptionsKey : Any] = [:]) -> Bool {
     return LineLogin.application(application, open: url, options: options)
   }

4. Add the following entries to your Info.plist just before the closing </dict> tag (reference):

   <key>CFBundleURLTypes</key>
   <array>
       <dict>
           <key>CFBundleTypeRole</key>
           <string>Editor</string>
           <key>CFBundleURLSchemes</key>
           <array>
               <string>line3rdp.$(PRODUCT_BUNDLE_IDENTIFIER)</string>
           </array>
       </dict>
   </array>
   <key>LSApplicationQueriesSchemes</key>
   <array>
       <string>lineauth2</string>
   </array>

Migration Guide

See the Migration Guide for upgrade instructions between versions.

Usage

1. Import the module and any enums you need:

   import Line, { Scope, BotPrompt } from '@xmartlabs/react-native-line'

2. Initialize the SDK with the setup method. Call this once when your app starts:

   useEffect(() => {
     Line.setup({ channelId: 'YOUR_CHANNEL_ID' })
   }, [])

3. Log in with the login method:

   // Default login — requests the profile scope only
   Line.login({})
   
   // Explicit scopes and bot prompt
   Line.login({
     scopes: [Scope.Profile, Scope.OpenId],
     botPrompt: BotPrompt.Normal,
   })

Web

On web, login() opens a popup window to LINE's OAuth consent page and uses PKCE (Proof Key for Code Exchange) to exchange the authorization code client-side — no server-side proxy or channel secret is required.

[!IMPORTANT]

• The browser must allow popups for your site.
• redirectUri must be registered as a Callback URL in your LINE Developer Console and be same-origin with the calling page.

The full web flow:

1. Call setup() with your channel ID and redirectUri. The redirect URI must be registered as a Callback URL in your LINE Developer Console and must be same-origin with the calling page:

   Line.setup({
     channelId: 'YOUR_CHANNEL_ID',
     redirectUri: 'https://yourapp.com',
   })

2. Call login() and await the result. A popup opens, the user authenticates, and the promise resolves with a LoginResult once LINE redirects back:

   const result = await Line.login({ scopes: [Scope.Profile, Scope.OpenId] })
   console.log(result.userProfile?.displayName)

3. After login, all other SDK methods (getProfile(), getCurrentAccessToken(), refreshAccessToken(), etc.) work normally.

API

Methods

| Method | Description | | --- | --- | | setup(params: SetupParams): Promise<void> | Initializes the LINE SDK. Must be called before any other method. | | login(params: LoginParams): Promise<LoginResult> | Starts the LINE login flow. Opens the LINE app if installed, otherwise falls back to the browser. | | logout(): Promise<void> | Revokes the current user's access token and clears the local session. | | getCurrentAccessToken(): Promise<AccessToken> | Returns the locally cached access token for the current user, without a network call. | | refreshAccessToken(): Promise<AccessToken> | Exchanges the current access token for a fresh one using the stored refresh token. | | verifyAccessToken(): Promise<VerifyResult> | Validates the current access token against the LINE server and returns its metadata. | | getProfile(): Promise<UserProfile> | Returns the current user's LINE profile. Requires Scope.Profile. | | getFriendshipStatus(): Promise<FriendshipStatus> | Returns whether the current user has added the channel's linked LINE Official Account as a friend. Requires bot linkage to be configured. |

Types

SetupParams

| Field | Type | Description | | --- | --- | --- | | channelId | string | Your LINE Login channel ID. | | universalLinkUrl | string? | Universal link URL registered for your channel. iOS only. | | redirectUri | string? | The URL LINE redirects back to after login. Must be same-origin with the calling page and registered as a Callback URL in the LINE Developer Console. Required on web. iOS/Android ignore this field. |

LoginParams

| Field | Type | Default | Description | | --- | --- | --- | --- | | scopes | Scope[] | [Scope.Profile] | OAuth scopes to request. | | onlyWebLogin | boolean | false | Skip the LINE app and use the browser-based login flow. | | botPrompt | BotPrompt? | — | Controls the bot friend-add prompt shown during login. Only applicable when a LINE Official Account is linked to your channel. |

Scope (enum)

| Value | String | Description | | --- | --- | --- | | Scope.Profile | 'profile' | Access to the user's display name, picture URL, status message, and user ID. | | Scope.OpenId | 'openid' | Issues an OpenID Connect ID token. Required to receive idToken. | | Scope.Email | 'email' | Access to the user's email address. Requires channel approval from LINE. |

BotPrompt (enum)

| Value | String | Description | | --- | --- | --- | | BotPrompt.Normal | 'normal' | Adds an inline "Add friend" option in the consent screen. | | BotPrompt.Aggressive | 'aggressive' | Shows a standalone friend-add screen after the consent screen. |

AccessToken

| Field | Type | Description | | --- | --- | --- | | accessToken | string | Bearer token used to authorize LINE API calls. | | expiresIn | number | Seconds until the token expires (OAuth standard expires_in). | | idToken | string? | Raw OpenID Connect ID token. Present only when Scope.OpenId was requested. |

LoginResult

| Field | Type | Description | | --- | --- | --- | | accessToken | AccessToken | The access token issued for this login session. | | scope | string | Space-separated list of granted scopes (e.g. "profile openid"). | | userProfile | UserProfile? | The user's profile. Present only when Scope.Profile was requested. | | friendshipStatusChanged | boolean? | Whether the user's friendship status with the linked LINE Official Account changed during this login. | | idTokenNonce | string? | Nonce for ID token verification. Present only when Scope.OpenId was requested. |

UserProfile

| Field | Type | Description | | --- | --- | --- | | userId | string | The user's LINE user ID. Stable across logins for the same channel. | | displayName | string | The user's LINE display name. | | pictureUrl | string? | URL of the user's profile picture. | | statusMessage | string? | The user's LINE status message. |

FriendshipStatus

| Field | Type | Description | | --- | --- | --- | | friendFlag | boolean | true if the user has added the linked LINE Official Account as a friend. |

VerifyResult

| Field | Type | Description | | --- | --- | --- | | channelId | string | The channel ID the access token was issued for. | | expiresIn | number | Seconds until the token expires. | | scope | string | Space-separated list of scopes granted to the token. |

Example

Check the example app for a complete working implementation. To run it locally, navigate to the example folder and run npm install, then npm run ios or npm run android.

License

@xmartlabs/react-native-line is available under the MIT license. See the LICENSE file for details.