Skip Navigation

Installing the Configure plug-in

You install the Configure plug-in before you install the Base plug-in. The Configure plug-in modifies the Base plug-in so that it can be added to your
Cordova
projects (for example, setting the paths of the home directories). The Base plug-in adds the configuration that enables the
BlackBerry Dynamics SDK
in your app.
You have three options for installing the Configure plugin.

Option 1: Use the default installation path

Instead of specifying the SDK paths, use the following:
cordova plugin add
<path_to_package>
/BlackBerry_Dynamics_SDK_for_Cordova_
<version>
/plugins/cordova-plugin-bbd-configure
If you installed the
BlackBerry Dynamics SDK for Android
and
BlackBerry Dynamics SDK for iOS
in the default locations, the Configure plug-in will use the default install path.
  • If installed using the Android SDK Manager tool, the default location for the
    BlackBerry Dynamics SDK for Android
    is
    $ANDROID_HOME/extras/blackberry/dynamics_sdk/sdk
    . The
    ANDROID_HOME
    environment variable must be set.
  • The default location for the
    BlackBerry Dynamics SDK for iOS
    is ~/Library/Application Support/BlackBerry/Good.platform/iOS/Frameworks/GD.framework.

Option 2: Specify explicit paths

Specify the explicit path for the
BlackBerry Dynamics SDK for Android
and the
BlackBerry Dynamics SDK for iOS
:
cordova plugin add
<path_to_package>
/BlackBerry_Dynamics_SDK_for_Cordova_
<version>
/plugins/cordova-plugin-bbd-configure--variable bbdSDKForAndroid="/Users/
<user>
/Downloads/gdsdk-release-
<version>
/sdk" --variable bbdSDKForiOS="/Applications/Xcode.app/Contents/Developer/Platforms/iPhoneOS.platform/Developer/SDKs/iPhoneOS.sdk/System/Library/Frameworks/GD.framework"
Specify the explicit path for the
BlackBerry Dynamics SDK for iOS
and the automatic path for the
BlackBerry Dynamics SDK for Android
:
cordova plugin add
<path_to_package>
/BlackBerry_Dynamics_SDK_for_Cordova_
<version>
/plugins/cordova-plugin-bbd-configure--variable bbdSDKForiOS="/Applications/Xcode.app/Contents/Developer/Platforms/iPhoneOS.platform/Developer/SDKs/iPhoneOS.sdk/System/Library/Frameworks/GD.framework"

Option 3: Specify that one or more SDKs are not installed

Specify that the
BlackBerry Dynamics SDK for Android
is not installed:
cordova plugin add
<path_to_package>
/BlackBerry_Dynamics_SDK_for_Cordova_
<version>
/plugins/cordova-plugin-bbd-configure--variable bbdSDKForiOS="/Applications/Xcode.app/Contents/Developer/Platforms/iPhoneOS.platform/Developer/SDKs/iPhoneOS.sdk/System/Library/Frameworks/GD.framework" --variable ignoreFailure="true"
Specify that the
BlackBerry Dynamics SDK for iOS
in not installed:
cordova plugin add
<path_to_package>
/BlackBerry_Dynamics_SDK_for_Cordova_
<version>
/plugins/cordova-plugin-bbd-configure--variable bbdSDKForAndroid="/Users/
<user>
/Downloads/gdsdk-release-
<version>
/sdk" --variable ignoreFailure="true"
Setting ignoreFailure="true" makes the Configure plug-in ignore errors that it encounters while processing explicit or automatic SDK paths. Use this option if you want to develop a
Cordova
app on one platform only, or if you use the
BlackBerry Dynamics SDK
for one platform only.