Line SDK wrapper for React Native 🚀
- LINE SDK v5 for iOS, wrapped with Swift.
- LINE SDK v5 for Android, wrapped with Kotlin.
- Android
minSdkVersionneeds to be at least version24. - iOS
deploymentTargetneeds to be at least version15.1. - LINE developer account needs to be created and also a channel.
Important
@xmartlabs/react-native-line v5 is now a TurboModule and requires the new architecture to be enabled.
- If you want to use @xmartlabs/react-native-line v5, you will need to enable the new architecture in your app (see how to enable the new architecture for apps).
- If you cannot enable the new architecture yet, downgrade to @xmartlabs/react-native-line v4 for now.
-
Install the JavaScript side with:
npx expo install @xmartlabs/react-native-line
-
Add the plugins
expo-build-propertiesand@xmartlabs/react-native-lineto yourapp.json:"plugins": [ [ "expo-build-properties", { "ios": { "useFrameworks": "static" } } ], "@xmartlabs/react-native-line" ]
-
Install library:
npm install @xmartlabs/react-native-line # --- or --- yarn add @xmartlabs/react-native-line -
Link iOS native code:
cd ios && pod install
-
Change your
AppDelegateto match the following:#import "RNLine-Swift.h" ... - (BOOL)application:(UIApplication *)application openURL:(NSURL *)url options:(NSDictionary<UIApplicationOpenURLOptionsKey,id> *)options { return [LineLogin application:application open:url options:options]; }
#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]; }
import RNLine ... override func application(_ application: UIApplication, open url: URL, options: [UIApplication.OpenURLOptionsKey : Any] = [:]) -> Bool { return LineLogin.application(application, open: url, options: options) }
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) }
-
Insert the following snippet in your
Info.plistjust before the last</dict>tag:<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>
You can find the migration guide in the linked document.
-
Import the
Linemodule:import Line from '@xmartlabs/react-native-line'
-
Initialize the module with the
setupmethod:useEffect(() => { Line.setup({ channelId: 'YOUR_CHANNEL_ID' }) }, [])
-
Log in with the
loginmethod:Line.login({})
| Method | Description |
|---|---|
login(params: LoginParams): Promise<LoginResult> | Starts the login flow of Line's SDK (Opens the apps if it's installed and defaults to the browser otherwise). It accepts the same argumements as the LineSDK, in an object { key: value }, defaults the same way as LineSDK too. |
getCurrentAccessToken(): Promise<AccessToken> | Returns the access token of the current user. |
getProfile(): Promise<UserProfile> | Returns the current user profile information. |
logout(): Promise<void> | Revokes the access token of the current user. |
refreshAccessToken(): Promise<AccessToken> | Refreshes the access token of the current user. |
setup(params: SetupParams): Promise<void> | Initializes the Line SDK. |
verifyAccessToken(): Promise<VerifyResult> | Checks whether the access token of the current user is valid. |
getFriendshipStatus(): Promise<FriendshipStatus> | Gets the friendship status between the LINE Official Account (which is linked to the current channel) and the user if configured. |
If you want to see @xmartlabs/react-native-line in action, just move into the example folder and run npm install and then npm run ios/npm run android. By seeing its source code, you will have a better understanding of the library usage.
@xmartlabs/react-native-line is available under the MIT license. See the LICENCE file for more info.
Created with ❤️ by Xmartlabs