imokhles-react-native-snapchat-kit

React-Native SnapchatKit

• 1. Change Log
• 2. Installation
• 3. Project configuration
• 4. Usage

1. Change Log

• v1.0.0 :
  • Brand new React Native Snaps

2. SDK Instalation

From your project folder:

yarn

$ yarn add git+https://github.com/QuentinbTahi/react-snap-kit.git -- save

npm

$ npm install git+https://github.com/QuentinbTahi/react-snap-kit.git -- save

3. Project configuration

3.2 iOS configuration

3.2.1 Change min iOS version :

Edit your Podfile min version to 10 : platform :ios, '10.0'

3.2.2 Run $ pod install from iOS folder :

$ cd ios && pod install

or

$ react-native link react-native-snapchat-kit`

3.2.3 Edit info.plist file :

Add to Info.plist

<key>SCSDKClientId</key>
<string>YOUR CLIENT ID</string>

<key>SCSDKRedirectUrl</key>
<string>YOUR REDIRECT URL</string>

<key>SCSDKScopes</key>
<array>
     <string>https://auth.snapchat.com/oauth2/api/user.display_name</string>
    <string>https://auth.snapchat.com/oauth2/api/user.bitmoji.avatar</string>
</array>

<key>LSApplicationQueriesSchemes</key>
<array>
    <string>snapchat</string>
    <string>bitmoji-sdk</string>
    <string>itms-apps</string>
</array>

REMEMBER Add the app url to your URL Types on Xcode config.

3.2.4 Update the AppDelegate.m (Login only) :

#import <SCSDKLoginKit/SCSDKLoginKit.h>

- (BOOL)application:(UIApplication *)application
            openURL:(NSURL *)url
            options:(NSDictionary<UIApplicationOpenURLOptionsKey, id> *)options {
  if ([SCSDKLoginClient application:application openURL:url options:options]) {
    return YES;
  }
  
  return NO;
}

3.3 Android configuration

3.3.1 Update build.gradle :

Update android/build.gradle with the min SDK Version :

minSdkVersion = 19

and add to your repositories list :

maven {
    url "https://storage.googleapis.com/snap-kit-build/maven"
}

3.3.2 Update AndroidManifest.xml :

Add the INTERNET permission

<uses-permission android:name="android.permission.INTERNET" />

Add this to your application

<meta-data android:name="com.snapchat.kit.sdk.clientId" android:value="YOUR CLIENT ID" />
<meta-data android:name="com.snapchat.kit.sdk.redirectUrl" android:value="YOUR REDIRECT URL" />
<meta-data android:name="com.snapchat.kit.sdk.scopes" android:resource="@array/snap_connect_scopes" />

<activity android:name="com.snapchat.kit.sdk.SnapKitActivity" android:launchMode="singleTask">
    <intent-filter>
        <action android:name="android.intent.action.VIEW" />
        <category android:name="android.intent.category.DEFAULT" />
        <category android:name="android.intent.category.BROWSABLE" />
        <!--
            Enter the parts of your redirect url below
            e.g., if your redirect url is myapp://snap-kit/oauth2
                android:scheme="myapp"
                android:host="snap-kit"
                android:path="/oauth2"
        !-->
        <data
            android:scheme="the scheme of your redirect url"
            android:host="the host of your redirect url"
            android:path="the path of your redirect url"
        />
    </intent-filter>
</activity>

3.3.3 Create a new file values/arrays.xml :

<?xml version="1.0" encoding="utf-8"?>
<resources>
    <string-array name="snap_connect_scopes">
        <item>https://auth.snapchat.com/oauth2/api/user.display_name</item>
        <item>https://auth.snapchat.com/oauth2/api/user.bitmoji.avatar</item>
    </string-array>
</resources>

3.3.4 Set up your FileProvider to share media files to Snapchat (creative kit only):

To share any media or sticker content to Snapchat, follow the protocol specified by FileProvider API. Once you have set this up, your AndroidManifest.xml will contain the following under <application>:

<provider
    android:authorities="${applicationId}.fileprovider"
    android:name="android.support.v4.content.FileProvider"
    android:exported="false"
    android:grantUriPermissions="true">
    <meta-data
        android:name="android.support.FILE_PROVIDER_PATHS"
        android:resource="@xml/file_paths"
        />
</provider>

Note: The authority used by the SDK is explicitly <your-package-name>.fileprovider. Please ensure you follow this convention when setting the value. If you have different package names for debug and production builds, the ${applicationId} should resolve to it appropriately.

4. Usage

4.1 Login

import SnapchatKit from 'react-native-snapchat-kit';

SnapchatKit.login() 
SnapchatKit.isLogged()
SnapchatKit.logout()
SnapchatKit.getUserInfo()

4.1 Creative

import SnapchatKit from 'react-native-snapchat-kit';

SnapchatKit.sharePhoto(photoImageSourceOrUrl, stickerImageSourceOrUrl, stickerPosX, stickerPosY, attachmentUrl, caption);
SnapchatKit.shareVideoAtUrl(videoUrl, stickerImageSourceOrUrl, stickerPosX, stickerPosY, attachmentUrl, caption);

4.1.1 Notes on creative kit :

• Media Size and Length Restrictions

  • Shared media must be 100 MB or smaller.
  • Videos must be 60 seconds or shorter.

• Suggested Media Parameters:

  • Aspect ratio - 9:16
  • Preferred file types:
  • Image - .jpg or .png
  • Video - .mp4
  • Dimensions - 1080px x 1920px
  • Video Bitrate - 1080p at 8mbps or 720p at 5mbps