npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

react-native-marketingcloudsdk-taqtile

v7.5.4

Published

A React Native component to access the native Salesforce Marketing Cloud MobilePush SDKs

Downloads

74

Readme

Salesforce Marketing Cloud React Native

Use this module to implement the Marketing Cloud MobilePush SDK for your iOS and Android applications.

Release Notes

Release notes for the plugin can be found here

Installation

  • Plugin has a version dependency on React Native v0.60+

1. Add plugin to your application via npm

npm install react-native-marketingcloudsdk --save

Android Setup

1. Add Marketing Cloud SDK repository

android/build.gradle

allprojects {
    repositories {
        maven { url "https://salesforce-marketingcloud.github.io/MarketingCloudSDK-Android/repository" }
        //... Other repos
    }
}

2. Provide FCM credentials

  1. To enable push support for the Android platform you will need to include the google-services.json file. Download the file from your Firebase console and place it into the android/app directory

  2. Include the Google Services plugin in your build android/build.gradle

buildscript {
  repositories {
    google()  // Google's Maven repository
  }

  dependencies {
    // ...
    // Add the following line:
    classpath 'com.google.gms:google-services:4.2.0'
  }
}
  1. Apply the plugin android/app/build.gradle
// Add the following line to the bottom of the file:
apply plugin: 'com.google.gms.google-services

3. Configure the SDK in your MainApplication.java class

@Override
public void onCreate() {
    super.onCreate();

    MarketingCloudSdk.init(this,
            MarketingCloudConfig.builder()
                    .setApplicationId("{MC_APP_ID}")
                    .setAccessToken("{MC_ACCESS_TOKEN}")
                    .setSenderId("{FCM_SENDER_ID_FOR_MC_APP}")
                    .setMarketingCloudServerUrl("{MC_APP_SERVER_URL}")
                    .setNotificationCustomizationOptions(NotificationCustomizationOptions.create(R.drawable.ic_notification))
                    .setAnalyticsEnabled(true)
                    .build(this),
            initializationStatus -> Log.e("INIT", initializationStatus.toString()));

    // ... The rest of the onCreate method    
}

iOS Setup

1. Install pod for Marketing Cloud SDK

cd ios
pod install

2. Configure the SDK in your AppDelegate.m class

// Add this import at the top (before #if RCT_NEW_ARCH_ENABLED)
#import <MarketingCloudSDK/MarketingCloudSDK.h>
// Other imports ...

- (BOOL)application:(UIApplication *)application
    didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {

    MarketingCloudSDKConfigBuilder *mcsdkBuilder = [MarketingCloudSDKConfigBuilder new];
    [mcsdkBuilder sfmc_setApplicationId:@"{MC_APP_ID}"];
    [mcsdkBuilder sfmc_setAccessToken:@"{MC_ACCESS_TOKEN}"];
    [mcsdkBuilder sfmc_setAnalyticsEnabled:@(YES)];
    [mcsdkBuilder sfmc_setMarketingCloudServerUrl:@"{MC_APP_SERVER_URL}"];

    NSError *error = nil;
    BOOL success =
        [[MarketingCloudSDK sharedInstance] sfmc_configureWithDictionary:[mcsdkBuilder sfmc_build]
                                                                   error:&error];

    // ... The rest of the didFinishLaunchingWithOptions method  
}

3. Enable Push

Follow these instructions to enable push for iOS.

API Reference

Kind: global class

MCReactModule.isPushEnabled() ⇒ Promise.<boolean>

The current state of the pushEnabled flag in the native Marketing Cloud SDK.

Kind: static method of MCReactModule
Returns: Promise.<boolean> - A promise to the boolean representation of whether push is enabled.
See

MCReactModule.enablePush()

Enables push messaging in the native Marketing Cloud SDK.

Kind: static method of MCReactModule
See

MCReactModule.disablePush()

Disables push messaging in the native Marketing Cloud SDK.

Kind: static method of MCReactModule
See

MCReactModule.getSystemToken() ⇒ Promise.<?string>

Returns the token used by the Marketing Cloud to send push messages to the device.

Kind: static method of MCReactModule
Returns: Promise.<?string> - A promise to the system token string.
See

MCReactModule.getAttributes() ⇒ Promise.<Object.<string, string>>

Returns the maps of attributes set in the registration.

Kind: static method of MCReactModule
Returns: Promise.<Object.<string, string>> - A promise to the key/value map of attributes set in the registration.
See

MCReactModule.setAttribute(key, value)

Sets the value of an attribute in the registration.

Kind: static method of MCReactModule
See

| Param | Type | Description | | --- | --- | --- | | key | string | The name of the attribute to be set in the registration. | | value | string | The value of the key attribute to be set in the registration. |

MCReactModule.clearAttribute(key)

Clears the value of an attribute in the registration.

Kind: static method of MCReactModule
See

| Param | Type | Description | | --- | --- | --- | | key | string | The name of the attribute whose value should be cleared from the registration. |

MCReactModule.addTag(tag)

Kind: static method of MCReactModule
See

| Param | Type | Description | | --- | --- | --- | | tag | string | The tag to be added to the list of tags in the registration. |

MCReactModule.removeTag(tag)

Kind: static method of MCReactModule
See

| Param | Type | Description | | --- | --- | --- | | tag | string | The tag to be removed from the list of tags in the registration. |

MCReactModule.getTags() ⇒ Promise.<Array.<string>>

Returns the tags currently set on the device.

Kind: static method of MCReactModule
Returns: Promise.<Array.<string>> - A promise to the array of tags currently set in the native SDK.
See

MCReactModule.setContactKey(contactKey)

Sets the contact key for the device's user.

Kind: static method of MCReactModule
See

| Param | Type | Description | | --- | --- | --- | | contactKey | string | The value to be set as the contact key of the device's user. |

MCReactModule.getContactKey() ⇒ Promise.<?string>

Returns the contact key currently set on the device.

Kind: static method of MCReactModule
Returns: Promise.<?string> - A promise to the current contact key.
See

MCReactModule.enableVerboseLogging()

Enables verbose logging within the native Marketing Cloud SDK.

Kind: static method of MCReactModule
See

MCReactModule.disableVerboseLogging()

Disables verbose logging within the native Marketing Cloud SDK.

Kind: static method of MCReactModule
See

MCReactModule.logSdkState()

Instructs the native SDK to log the SDK state to the native logging system (Logcat for Android and Xcode/Console.app for iOS). This content can help diagnose most issues within the SDK and will be requested by the Marketing Cloud support team.

Kind: static method of MCReactModule

MCReactModule.track()

This method helps to track events, which could result in actions such as an InApp Message being displayed.

Kind: static method of MCReactModule

3rd Party Product Language Disclaimers

Where possible, we changed noninclusive terms to align with our company value of Equality. We retained noninclusive terms to document a third-party system, but we encourage the developer community to embrace more inclusive language. We can update the term when it’s no longer required for technical accuracy.