react-native-zendesk-sunshine

React Native wrapper for Zendesk Sunshine Conversations (aka Smooch).

Disclaimer: This project is a improvement and a hardening of William Bell's version (https://github.com/billnbell/react-native-sunshine-conversations) to use at Pier Digital.

This React Native module was built and tested with version 0.66.3 of React Native. Since React Native is not mature yet, there might be some breaking changes which will break our module. Therefore, if you find a problem, please open an issue.

   "react": "17.0.2,
   "react-native": "^0.66.4",

At the moment, this wrapper only covers the most commonly used features of the Smooch SDK. We encourage you to add to this wrapper or make any feature requests you need. Pull requests most definitely welcome!

Please contact Smooch for any questions.

Installing Smooch on React Native

First, make sure you've signed up for Smooch

If you don't already have a React Native application setup, follow the instructions here to create one. Make sure you use 0.66.3+.

For React Native 0.60+ you do not need to add anything - it autolinks!

 "dependencies": {
   "react-native-zendesk-sunshine": "git+https://github.com/pier-digital/react-native-zendesk-sunshine.git#1.0.39",
   ...
 }

yarn install

IOS

• This uses Smooch IOS SDK v11.0.0

• You must also have your React dependencies defined in your Podfile as described here, for example:

• Install pods by cd ios and running pod install.

• Open your project's .xcworkspace file in XCode and initialize Smooch with your app id inside of applicationDidFinishLaunchingWithOptions. Or in your App directory/AppDelegate.m file

#import <Smooch/Smooch.h>

...

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    // Initialize Smooch - these instructions are also available on [app.smooch.io](https://app.smooch.io)
    SKTSettings *customSettings = [SKTSettings settingsWithIntegrationId:@"YOUR_IOS_INT_ID"];
    [Smooch initWithSettings:customSettings completionHandler:^(NSError * _Nullable error, NSDictionary * _Nullable userInfo) {
        NSLog(@"Smooch initWithSettings");
        // Your code after init is complete
    }];
}

You're now ready to start interacting with Smooch in your React Native app.

Android

• this uses Smooch Android SDK v9.0.0+

• You can easily add a binding to the Smooch Android SDK in your React Native application by following the instructions below.

• Add Smooch.init to the onCreate method of your Application class.

import io.smooch.core.Settings;
import io.smooch.core.Smooch;
import io.smooch.core.SmoochCallback;
import io.smooch.core.InitializationStatus;

public class MainApplication extends Application implements ReactApplication {
    ...
    @Override
    public void onCreate() {
      super.onCreate();
      SoLoader.init(this, /* native exopackage */ false);
      String integrationId = (BuildConfig.APP_ENV == "PROD") ? BuildConfig.PROD_SMOOCH_INTEGRATION_ID_ANDROID : BuildConfig.STAGE_SMOOCH_INTEGRATION_ID_ANDROID;
      Smooch.init(this, new Settings(integrationId), new SmoochCallback<InitializationStatus>() {
        @Override
        public void run(Response<InitializationStatus> response) {
          // Handle init result
          Log.d("SmoothInit", String.valueOf(response));
        }
      });
      initializeFlipper(this, getReactNativeHost().getReactInstanceManager());
    }
    ...
}

You're now ready to start interacting with Smooch in your React Native app.

Using Smooch in your React Native App

Require the module

import { Smooch } from 'react-native-zendesk-sunshine';

Show the conversation screen

Smooch.show();

Login to Smooch

Smooch.login(smoochUserId, smoochJwt)
  .then(() => {
    console.log('logged in');
  });

Set the user's first name

Smooch.setFirstName("Kurt");

Set the user's last name

Smooch.setLastName("Osiander");

Set the user's email address

Smooch.setEmail("[email protected]");

Set the user's sign up date -- not tested

Smooch.setSignedUpAt((new Date).getTime());

Associate key/value pairs with the user

Smooch.setUserProperties({"whenDidYouFsckUp": "aLongTimeAgo"});

s.d.ts (typescript)

declare module 'react-native-zendesk-sunshine' {
  class Smooch {
    login(externalId: string, jwt: string): Promise<void>;
    logout(): Promise<void>;
    setNotificationCategory(): Promise<void>;
    setFirstName(firstName: string): void;
    setLastName(lastName: string): void;
    setEmail(email: string): void;
    setUserProperties(props: Map<string, object>): void;
    show(enableMultiConversation: boolean): void;
    close(): void;
    getUnreadCount(): Promise<number>;
    setFirebaseCloudMessagingToken(token: string): void;
    isLoggedIn(): Promise<boolean>;
    sendMessage(text: string, metadata: Map<string, object>, 
      conversationId: string, conversationName: string): Promise<void>;
    sendHiddenMessage(metadata: Map<string, object>, 
      conversationId: string, conversationName: string): Promise<void>;
  }
  const s = new Smooch();
  export { s as Smooch };
}