Skip to content

Latest commit

 

History

History
143 lines (110 loc) · 7.18 KB

README.md

File metadata and controls

143 lines (110 loc) · 7.18 KB
Raw

BlackBerry-Dynamics-for-React-Native-Base

BlackBerry-Dynamics-for-React-Native-Base automatically integrates the BlackBerry Dynamics SDK for iOS and Android into a React Native application.

Setup environment

Please setup your environment as described in the React Native documentation.

Supportability

React Native

  • 0.66.x (deprecated)
  • 0.67.x (deprecated)
  • 0.68.x (deprecated)
  • 0.69.x (deprecated)
  • 0.70.x
  • 0.71.x
  • 0.72.x

Preconditions

Install required dependencies using RubyGems

$ gem install xcodeproj
$ gem install plist

Dynamics SDK Dependency

Dynamics SDK for iOS and Android are now installed as part of the Base module using CocoaPods & Gradle. The integration uses the iOS "Dynamic Framework" version of BlackBerry Dynamics as the static library is no longer supported.

Supported Dynamics SDK for iOS versions:

  • 11.1, check environment requirements here
  • 11.2, check environment requirements here
  • 12.0, check environment requirements here

Supported Dynamics SDK for Android versions:

  • 11.1, check environment requirements here
  • 11.2, check environment requirements here
  • 12.0, check environment requirements here
BlackBerry Dynamics SDK for iOS integration
Using default (12.0) released version - default

By default, BlackBerry-Dynamics-for-React-Native-Base module will integrate 12.0 (12.0.1.79) version of BlackBerry Dynamics SDK for iOS using following podspec: https://software.download.blackberry.com/repository/framework/dynamics/ios/12.0.1.79/BlackBerryDynamics-12.0.1.79.podspec.

NOTE: If one of the below integration methods was used there is an option to reset default configuration by running following command: $ yarn set-dynamics-podspec --default $ cd ios && pod install && cd ..

Using other released version

There is possibility to integrate other released build of BlackBerry Dynamics SDK for iOS. Currently, the other supported versions are 11.1 and 11.2.
Following command should be run to use BlackBerry Dynamics SDK for iOS v11.2:

$ yarn set-dynamics-podspec --url "https://software.download.blackberry.com/repository/framework/dynamics/ios/11.2.0.26/BlackBerryDynamics-11.2.0.26.podspec"
$ cd ios && pod install && cd ..
Using locally downloaded version

Also, it is possible to integrate manually downloaded BlackBerry Dynamics SDK for iOS from local place. Following command should be run:

$ yarn set-dynamics-podspec --path "/Users/<user>/Downloads/gdsdk-release-dylib-X.X.X.X/BlackBerry_Dynamics_SDK_for_iOS_vX.X.X.X_dylib"
$ cd ios && pod install && cd ..
BlackBerry Dynamics SDK for Android integration

By default, BlackBerry-Dynamics-for-React-Native-Base module will integrate 12.0 (12.0.1.79) version of BlackBerry Dynamics SDK for Android.

Using other released version

There is possibility to integrate other released build of BlackBerry Dynamics SDK for Android.
Currently, the other supported versions are 11.1 and 11.2.
Following steps should be done to use BlackBerry Dynamics SDK for Android v11.2:

  • update versions of Dynamics dependencies in all modules from <path>/BlackBerry_Dynamics_SDK_for_React_Native_vX.X.X.X/modules/ and ui-components from <path>/BlackBerry_Dynamics_SDK_for_React_Native_vX.X.X.X/ui-components/: 
    implementation 'com.blackberry.blackberrydynamics:android_handheld_platform:11.2.0.13'
implementation 'com.blackberry.blackberrydynamics:android_handheld_backup_support:11.2.0.13'
implementation 'com.blackberry.blackberrydynamics:android_webview:11.2.0.13'
  • if your application contains some modules or ui-components from BlackBerry_Dynamics_SDK_for_React_Native, you will need to uninstall them first by using following commands:
$ cd <path_to_your_app>
// Repeat this command to remove all appropriate modules and ui-components
$ yarm remove BlackBerry-Dynamics-for-React-Native-<name>
$ cd ios  
$ pod install  
$ cd ..
  • install modules and ui-components from BlackBerry_Dynamics_SDK_for_React_Native with updated dependencies version by using following commands:
$ yarn add <path>/BlackBerry_Dynamics_SDK_for_React_Native_vX.X.X.X/modules/BlackBerry-Dynamics-for-React-Native-Base
// Repeat this command for all appropriate modules and ui-components
$ yarn add <path>/BlackBerry_Dynamics_SDK_for_React_Native_vX.X.X.X/modules/<name>
$ cd ios  
$ pod install  
$ cd ..

Installation

react-native

$ npx react-native init <appFolder> --version 0.70.0
$ cd <appFolder>
$ yarn add <path>/modules/BlackBerry-Dynamics-for-React-Native-Base

Integrates Dynamics based on your current identifiers - iOS Bundle ID and Android Package Name.

$ yarn set-bundle-id (OPTIONAL)

Allows to update an identifier (required) and name (optional) for your application. This identifier is your iOS Bundle ID or Android Package Name. It will also be used as the Entitlement ID for entitling and activating your application with the BlackBerry UEM management console.

iOS
$ cd ios  
$ pod install  
$ cd ..  
$ npx react-native run-ios
Android
$ npx react-native run-android

Activation

To activate your new BlackBerry Dynamics application with the BlackBerry UEM management console, please see the 'Deploy and Test' section of Get Started with BlackBerry Dynamics SDK.

Uninstallation

$ cd <appFolder>
$ yarn remove BlackBerry-Dynamics-for-React-Native-Base
iOS
$ cd ios
$ pod install
$ cd ..

Limitations

Flipper is disabled on iOS

Flipper cannot be used together with BlackBerry Dynamics SDK for React Native on iOS in debug configuration as it disables some BlackBerry Dynamics functionality related to secure networking. Flipper is disabled on iOS by default. If your Dynamics React Native application on iOS does not use Secure Connectivity feature (BlackBerry-Dynamics-for-React-Native-Networking module) you can enable Flipper by uncommenting use_flipper!() line in Podfile of your application.

Android 12+ support for React Native version less than 0.68

Apps targeting Android 12 and higher are required to specify an explicit value for android:exported when the corresponding component has an intent filter defined. More details can be found here. React Native 0.68 and higher supports Android 12+ by default by setting appropriate setting in AndroidManifest.xml. For React Native versions <= 0.67 setting android:exported should be set manually.