Skip to content

Latest commit

 

History

History
65 lines (39 loc) · 5.4 KB

api-android.md

File metadata and controls

65 lines (39 loc) · 5.4 KB
Raw

Java API Reference (Android)

The Java API is made available by importing the com.microsoft.codepush.react.CodePush class into your MainActivity.java file, and consists of a single public class named CodePush.

CodePush

Constructs the CodePush client runtime and represents the ReactPackage instance that you add to you app's list of packages.

Constructors

  • CodePush(String deploymentKey, Activity mainActivity) - Creates a new instance of the CodePush runtime, that will be used to query the service for updates via the provided deployment key. The mainActivity parameter should always be set to this when configuring your React packages list inside the MainActivity class. This constructor puts the CodePush runtime into "release mode", so if you want to enable debugging behavior, use the following constructor instead.

  • CodePush(String deploymentKey, Activity mainActivity, bool isDebugMode) - Equivalent to the previous constructor but allows you to specify whether you want the CodePush runtime to be in debug mode or not. When using this constructor, the isDebugMode parameter should always be set to BuildConfig.DEBUG in order to stay synchronized with your build type. When putting CodePush into debug mode, the following behaviors are enabled:

    1. Old CodePush updates aren't deleted from storage whenever a new binary is deployed to the emulator/device. This behavior enables you to deploy new binaries, without bumping the version during development, and without continuously getting the same update every time your app calls sync.

    2. The local cache that the React Native runtime maintains in debug mode is deleted whenever a CodePush update is installed. This ensures that when the app is restarted after an update is applied, you will see the expected changes. As soon as this PR is merged, we won't need to do this anymore.

  • CodePush(String deploymentKey, Context context, boolean isDebugMode, Integer publicKeyResourceDescriptor) - Equivalent to the previous constructor, but allows you to specify the public key resource descriptor needed to read public key content. Please refer to Code Signing section for more details about Code Signing Feature.

  • CodePush(String deploymentKey, Context context, boolean isDebugMode, String serverUrl) Constructor allows you to specify CodePush Server Url. The Default value: "https://codepush.azurewebsites.net/" is overridden by value specfied in serverUrl.

Builder

As an alternative to constructors you can also use CodePushBuilder to setup a CodePush instance configured with only parameters you want.

    @Override
    protected List<ReactPackage> getPackages() {
      return Arrays.<ReactPackage>asList(
            new MainReactPackage(),
            new CodePushBuilder("deployment-key-here",getApplicationContext())
                .setIsDebugMode(BuildConfig.DEBUG)
                .setPublicKeyResourceDescriptor(R.string.publicKey)
                .setServerUrl("https://yourcodepush.server.com")
                .build() //return configured CodePush instance
      );
    }

CodePushBuilder methods:

  • public CodePushBuilder(String deploymentKey, Context context) - setup same parameters as via CodePush(String deploymentKey, Activity mainActivity)

  • public CodePushBuilder setIsDebugMode(boolean isDebugMode) - allows you to specify whether you want the CodePush runtime to be in debug mode or not. Default value: false.

  • public CodePushBuilder setServerUrl(String serverUrl) - allows you to specify CodePush Server Url. Default value: "https://codepush.azurewebsites.net/".

  • public CodePushBuilder setPublicKeyResourceDescriptor(int publicKeyResourceDescriptor) - allows you to specify Public Key resource descriptor which will be used for reading Public Key content for strings.xml file. Please refer to Code Signing section for more detailed information about purpose of this parameter.

  • public CodePush build() - return configured CodePush instance.

Public Methods
  • setDeploymentKey(String deploymentKey) - Sets the deployment key that the app should use when querying for updates. This is a dynamic alternative to setting the deployment key in Codepush constructor/builder and/or specifying a deployment key in JS when calling checkForUpdate or sync.
Static Methods

  • getBundleUrl() - Returns the path to the most recent version of your app's JS bundle file, assuming that the resource name is index.android.bundle. If your app is using a different bundle name, then use the overloaded version of this method which allows specifying it. This method has the same resolution behavior as the Objective-C equivalent described above.

  • getBundleUrl(String bundleName) - Returns the path to the most recent version of your app's JS bundle file, using the specified resource name (e.g. index.android.bundle). This method has the same resolution behavior as the Objective-C equivalent described above.

  • getPackageFolder() - Returns the path to the current update folder.

  • overrideAppVersion(String appVersionOverride) - Sets the version of the application's binary interface, which would otherwise default to the Play Store version specified as the versionName in the build.gradle. This should be called a single time, before the CodePush instance is constructed.