@capawesome/capacitor-live-update 8.1.1 → 8.2.0

package/README.md

@@ -21,6 +21,10 @@ We are proud to offer one of the most complete and feature-rich Capacitor plugin
 - 🛟 **Rollback**: Reset the app to the default bundle if an incompatible bundle has been set.
 - 🚀 **Rollout**: Gradually roll out new bundles to gather valuable feedback.
 - 🔁 **Delta Updates**: Make your updates faster by only downloading changed files.
+- ⚙️ **Runtime Configuration**: Update plugin configuration at runtime without rebuilding the app.
+- 📡 **Update Lifecycle Events**: Track download progress, react to bundle changes, and detect reloads with auto-blocking of rolled back bundles.
+- 🏠 **Self-Hosted Bundles**: Download bundles from any URL, no Capawesome Cloud dependency required.
+- 🏷️ **Custom Properties**: Associate custom key-value metadata with bundles via Capawesome Cloud.
 - 🔒 **Security**: Verify the authenticity and integrity of the bundle using a public key.
 - ⚔️ **Battle-Tested**: Used in more than 1,000 projects to update apps on more than 20,000,000 devices.
 - 🌐 **Open Source**: Licensed under the MIT License.
@@ -51,6 +55,21 @@ npx cap sync
 
 ### Android
 
+#### Channel
+
+If you are using [Versioned Channels](https://capawesome.io/cloud/live-updates/guides/best-practices/#versioned-channels), you can set a default channel directly in your native project by adding a string resource.
+This allows you to tie the channel to the version code at build time.
+
+Add the following to your app's `build.gradle` file:
+
+```groovy
+android {
+    defaultConfig {
+        resValue "string", "capawesome_live_update_default_channel", "production-" + defaultConfig.versionCode
+    }
+}
+```
+
 #### Variables
 
 If needed, you can define the following project variable in your app’s `variables.gradle` file to change the default version of the dependency:
@@ -62,6 +81,18 @@ This can be useful if you encounter dependency conflicts with other plugins in y
 
 ### iOS
 
+#### Channel
+
+If you are using [Versioned Channels](https://capawesome.io/cloud/live-updates/guides/best-practices/#versioned-channels), you can set a default channel directly in your native project by adding a key to your `Info.plist` file.
+This allows you to tie the channel to the build version at build time.
+
+Add the following to your `Info.plist` file:
+
+```xml
+<key>CapawesomeLiveUpdateDefaultChannel</key>
+<string>production-$(CURRENT_PROJECT_VERSION)</string>
+```
+
 #### Privacy manifest
 
 Add the `NSPrivacyAccessedAPICategoryUserDefaults` dictionary key to your [Privacy Manifest](https://capacitorjs.com/docs/ios/privacy-manifest) (usually `ios/App/PrivacyInfo.xcprivacy`):
@@ -100,7 +131,7 @@ We recommend to declare [`CA92.1`](https://developer.apple.com/documentation/bun
 | **`autoBlockRolledBackBundles`** | <code>boolean</code>                | Whether or not to automatically block bundles that have been rolled back. When enabled, the plugin will automatically block bundles that caused a rollback (up to 100 bundles). When the limit is reached, the oldest blocked bundle is unblocked. Blocked bundles will be skipped in future sync operations. **Attention**: This option has no effect if `readyTimeout` is set to `0`. Only available on Android and iOS. | <code>false</code>                     | 7.3.0 |
 | **`autoDeleteBundles`**          | <code>boolean</code>                | Whether or not to automatically delete unused bundles. When enabled, the plugin will automatically delete unused bundles after calling `ready()`.                                                                                                                                                                                                                                                                          | <code>false</code>                     | 5.0.0 |
 | **`autoUpdateStrategy`**         | <code>'none' \| 'background'</code> | The auto-update strategy for live updates. - `none`: Live updates will not be applied automatically. - `background`: Live updates will be automatically downloaded and applied in the background at app startup and when the app resumes (if the last check was more than 15 minutes ago). Only available on Android and iOS.                                                                                              | <code>'none'</code>                    | 7.3.0 |
-| **`defaultChannel`**             | <code>string</code>                 | The default channel of the app.                                                                                                                                                                                                                                                                                                                                                                                            |                                        | 6.3.0 |
+| **`defaultChannel`**             | <code>string</code>                 | The default channel of the app. This can be overridden by `setChannel()`, the `channel` parameter of `sync()`, or the native channel configuration (`CapawesomeLiveUpdateDefaultChannel` in `Info.plist` on iOS or `capawesome_live_update_default_channel` in `strings.xml` on Android).                                                                                                                                  |                                        | 6.3.0 |
 | **`httpTimeout`**                | <code>number</code>                 | The timeout in milliseconds for HTTP requests.                                                                                                                                                                                                                                                                                                                                                                             | <code>60000</code>                     | 6.4.0 |
 | **`publicKey`**                  | <code>string</code>                 | The public key to verify the integrity of the bundle. The public key must be a PEM-encoded RSA public key.                                                                                                                                                                                                                                                                                                                 |                                        | 6.1.0 |
 | **`readyTimeout`**               | <code>number</code>                 | The timeout in milliseconds to wait for the app to be ready before resetting to the default bundle. It is strongly **recommended** to configure this option (e.g. `10000` ms) so that the plugin can roll back to the default bundle in case of problems. If configured, the plugin will wait for the app to call the `ready()` method before resetting to the default bundle. Set to `0` to disable the timeout.          | <code>0</code>                         | 5.0.0 |
@@ -169,6 +200,11 @@ const downloadBundle = async () => {
   await LiveUpdate.downloadBundle({ url: 'https://example.com/1.0.0.zip', bundleId: '1.0.0' });
 };
 
+const fetchChannels = async () => {
+  const result = await LiveUpdate.fetchChannels();
+  return result.channels;
+};
+
 const fetchLatestBundle = async () => {
   await LiveUpdate.fetchLatestBundle();
 };
@@ -273,6 +309,7 @@ const isNewBundleAvailable = async () => {
 * [`clearBlockedBundles()`](#clearblockedbundles)
 * [`deleteBundle(...)`](#deletebundle)
 * [`downloadBundle(...)`](#downloadbundle)
+* [`fetchChannels(...)`](#fetchchannels)
 * [`fetchLatestBundle(...)`](#fetchlatestbundle)
 * [`getBlockedBundles()`](#getblockedbundles)
 * [`getBundles()`](#getbundles)
@@ -363,6 +400,35 @@ Only available on Android and iOS.
 --------------------
 
 
+### fetchChannels(...)
+
+```typescript
+fetchChannels(options?: FetchChannelsOptions | undefined) => Promise<FetchChannelsResult>
+```
+
+Fetch channels from [Capawesome Cloud](https://capawesome.io/cloud/).
+
+This is primarily intended for development and QA purposes.
+It allows you to retrieve a list of available channels so you can
+dynamically switch between them using `setChannel(...)`.
+
+**Attention**: Only works for apps with public channels enabled.
+If channels are private, they can still be set using `setChannel(...)`
+but won't be returned by this method.
+
+Only available on Android and iOS.
+
+| Param         | Type                                                                  |
+| ------------- | --------------------------------------------------------------------- |
+| **`options`** | <code><a href="#fetchchannelsoptions">FetchChannelsOptions</a></code> |
+
+**Returns:** <code>Promise&lt;<a href="#fetchchannelsresult">FetchChannelsResult</a>&gt;</code>
+
+**Since:** 8.2.0
+
+--------------------
+
+
 ### fetchLatestBundle(...)
 
 ```typescript
@@ -429,6 +495,15 @@ getChannel() => Promise<GetChannelResult>
 
 Get the channel that is used for the update.
 
+The channel is resolved in the following order (highest priority first):
+1. `setChannel()` (SharedPreferences on Android / UserDefaults on iOS)
+2. Native config (`CapawesomeLiveUpdateDefaultChannel` in `Info.plist` on iOS or
+   `capawesome_live_update_default_channel` in `strings.xml` on Android)
+3. Capacitor config `defaultChannel`
+
+**Note**: The `channel` parameter of `sync()` takes the highest priority
+but is not persisted and therefore not returned by this method.
+
 Only available on Android and iOS.
 
 **Returns:** <code>Promise&lt;<a href="#getchannelresult">GetChannelResult</a>&gt;</code>
@@ -891,6 +966,30 @@ Remove all listeners for this plugin.
 | **`url`**          | <code>string</code>              | The URL of the bundle to download. For the `zip` artifact type, the URL must point to a ZIP file. For the `manifest` artifact type, the URL serves as the base URL to download the individual files. For example, if the URL is `https://example.com/download`, the plugin will download the file with the href `index.html` from `https://example.com/download?href=index.html`. To **verify the integrity** of the file, the server should return a `X-Checksum` header with the SHA-256 hash in hex format. To **verify the signature** of the file, the server should return a `X-Signature` header with the signed SHA-256 hash in base64 format. |                    | 5.0.0 |
 
 
+#### FetchChannelsResult
+
+| Prop           | Type                   | Description           | Since |
+| -------------- | ---------------------- | --------------------- | ----- |
+| **`channels`** | <code>Channel[]</code> | The list of channels. | 8.2.0 |
+
+
+#### Channel
+
+| Prop       | Type                | Description                           | Since |
+| ---------- | ------------------- | ------------------------------------- | ----- |
+| **`id`**   | <code>string</code> | The unique identifier of the channel. | 8.2.0 |
+| **`name`** | <code>string</code> | The name of the channel.              | 8.2.0 |
+
+
+#### FetchChannelsOptions
+
+| Prop         | Type                | Description                               | Default         | Since |
+| ------------ | ------------------- | ----------------------------------------- | --------------- | ----- |
+| **`limit`**  | <code>number</code> | The maximum number of channels to return. | <code>50</code> | 8.2.0 |
+| **`offset`** | <code>number</code> | The number of channels to skip.           | <code>0</code>  | 8.2.0 |
+| **`query`**  | <code>string</code> | The query to filter channels by name.     |                 | 8.2.0 |
+
+
 #### FetchLatestBundleResult
 
 | Prop                   | Type                                    | Description                                                                                                                                                                                  | Since |
@@ -1129,6 +1228,18 @@ For this reason, you must be careful to [restrict live updates to compatible nat
 
 ## FAQ
 
+### How do I set a channel?
+
+There are four ways to set a channel, listed from lowest to highest priority:
+
+1. **Capacitor config**: Set the `defaultChannel` property in the [plugin configuration](#configuration). This is the simplest way to set a static default channel.
+2. **Native config**: Set `CapawesomeLiveUpdateDefaultChannel` in `Info.plist` (iOS) or `capawesome_live_update_default_channel` in `strings.xml` (Android). This is useful for [Versioned Channels](https://capawesome.io/cloud/live-updates/guides/best-practices/#versioned-channels) where the channel is tied to the build version.
+3. **[`setChannel(...)`](#setchannel)**: Set the channel at runtime. The value is persisted across app restarts.
+4. **[`sync(...)`](#sync)**: Pass a `channel` option to override the channel for a single sync call. This does **not** persist the channel.
+
+Each method overrides the ones above it.
+You can check the currently resolved channel by calling [`getChannel()`](#getchannel).
+
 ### Why can't I see my changes during development?
 
 As soon as you have installed a live update, the app will use the live update bundle and no longer the default bundle. 

package/android/src/main/java/io/capawesome/capacitorjs/plugins/liveupdate/LiveUpdate.java

@@ -15,17 +15,21 @@ import com.getcapacitor.Logger;
 import com.getcapacitor.plugin.WebView;
 import io.capawesome.capacitorjs.plugins.liveupdate.classes.Manifest;
 import io.capawesome.capacitorjs.plugins.liveupdate.classes.ManifestItem;
+import io.capawesome.capacitorjs.plugins.liveupdate.classes.api.GetChannelsResponseItem;
 import io.capawesome.capacitorjs.plugins.liveupdate.classes.api.GetLatestBundleResponse;
 import io.capawesome.capacitorjs.plugins.liveupdate.classes.events.DownloadBundleProgressEvent;
 import io.capawesome.capacitorjs.plugins.liveupdate.classes.events.NextBundleSetEvent;
 import io.capawesome.capacitorjs.plugins.liveupdate.classes.options.DeleteBundleOptions;
 import io.capawesome.capacitorjs.plugins.liveupdate.classes.options.DownloadBundleOptions;
+import io.capawesome.capacitorjs.plugins.liveupdate.classes.options.FetchChannelsOptions;
 import io.capawesome.capacitorjs.plugins.liveupdate.classes.options.FetchLatestBundleOptions;
 import io.capawesome.capacitorjs.plugins.liveupdate.classes.options.SetChannelOptions;
 import io.capawesome.capacitorjs.plugins.liveupdate.classes.options.SetConfigOptions;
 import io.capawesome.capacitorjs.plugins.liveupdate.classes.options.SetCustomIdOptions;
 import io.capawesome.capacitorjs.plugins.liveupdate.classes.options.SetNextBundleOptions;
 import io.capawesome.capacitorjs.plugins.liveupdate.classes.options.SyncOptions;
+import io.capawesome.capacitorjs.plugins.liveupdate.classes.results.ChannelResult;
+import io.capawesome.capacitorjs.plugins.liveupdate.classes.results.FetchChannelsResult;
 import io.capawesome.capacitorjs.plugins.liveupdate.classes.results.FetchLatestBundleResult;
 import io.capawesome.capacitorjs.plugins.liveupdate.classes.results.GetBlockedBundlesResult;
 import io.capawesome.capacitorjs.plugins.liveupdate.classes.results.GetBundlesResult;
@@ -115,6 +119,9 @@ public class LiveUpdate {
         // Check version and reset config if version changed
         checkAndResetConfigIfVersionChanged();
 
+        // Set the device ID on the HTTP client (after any potential config reset)
+        this.httpClient.setDeviceId(getDeviceId());
+
         // Start the rollback timer to rollback to the default bundle
         // if the app is not ready after a certain time
         startRollbackTimer();
@@ -159,6 +166,63 @@ public class LiveUpdate {
         }
     }
 
+    public void fetchChannels(@NonNull FetchChannelsOptions options, @NonNull NonEmptyCallback<FetchChannelsResult> callback) {
+        try {
+            HttpUrl.Builder urlBuilder = new HttpUrl.Builder()
+                .scheme("https")
+                .host(config.getServerDomain())
+                .addPathSegment("v1")
+                .addPathSegment("apps")
+                .addPathSegment(getAppId())
+                .addPathSegment("channels");
+            if (options.getLimit() != null) {
+                urlBuilder.addQueryParameter("limit", String.valueOf(options.getLimit()));
+            }
+            if (options.getOffset() != null) {
+                urlBuilder.addQueryParameter("offset", String.valueOf(options.getOffset()));
+            }
+            if (options.getQuery() != null) {
+                urlBuilder.addQueryParameter("query", options.getQuery());
+            }
+            String url = urlBuilder.build().toString();
+
+            httpClient.enqueue(
+                url,
+                new NonEmptyCallback<Response>() {
+                    @Override
+                    public void success(@NonNull Response response) {
+                        try {
+                            String responseBodyString = response.body().string();
+                            if (response.isSuccessful()) {
+                                JSONArray responseJsonArray = new JSONArray(responseBodyString);
+                                ChannelResult[] channels = new ChannelResult[responseJsonArray.length()];
+                                for (int i = 0; i < responseJsonArray.length(); i++) {
+                                    GetChannelsResponseItem item = new GetChannelsResponseItem(responseJsonArray.getJSONObject(i));
+                                    channels[i] = new ChannelResult(item.getId(), item.getName());
+                                }
+                                FetchChannelsResult result = new FetchChannelsResult(channels);
+                                callback.success(result);
+                            } else if (response.code() == 401) {
+                                callback.error(new Exception("Unauthorized. Channel Discovery may not be enabled for this app."));
+                            } else {
+                                callback.error(new Exception(responseBodyString));
+                            }
+                        } catch (Exception e) {
+                            callback.error(e);
+                        }
+                    }
+
+                    @Override
+                    public void error(@NonNull Exception exception) {
+                        callback.error(exception);
+                    }
+                }
+            );
+        } catch (Exception e) {
+            callback.error(e);
+        }
+    }
+
     public void fetchLatestBundle(@NonNull FetchLatestBundleOptions options, @NonNull NonEmptyCallback<FetchLatestBundleResult> callback) {
         fetchLatestBundleInternal(
             options,
@@ -1015,12 +1079,28 @@ public class LiveUpdate {
         if (config.getDefaultChannel() != null) {
             channel = config.getDefaultChannel();
         }
+        String nativeChannel = getNativeChannel();
+        if (nativeChannel != null) {
+            channel = nativeChannel;
+        }
         if (preferences.getChannel() != null) {
             channel = preferences.getChannel();
         }
         return channel;
     }
 
+    @Nullable
+    private String getNativeChannel() {
+        int resId = plugin
+            .getContext()
+            .getResources()
+            .getIdentifier("capawesome_live_update_default_channel", "string", plugin.getContext().getPackageName());
+        if (resId == 0) {
+            return null;
+        }
+        return plugin.getContext().getResources().getString(resId);
+    }
+
     /**
      * @return The current bundle ID or `null` if the default bundle is in use.
      */

package/android/src/main/java/io/capawesome/capacitorjs/plugins/liveupdate/LiveUpdateHttpClient.java

@@ -25,6 +25,9 @@ public class LiveUpdateHttpClient {
     @NonNull
     private final LiveUpdateConfig config;
 
+    @Nullable
+    private String deviceId;
+
     @NonNull
     private final OkHttpClient okHttpClient;
 
@@ -62,8 +65,16 @@ public class LiveUpdateHttpClient {
             .build();
     }
 
+    public void setDeviceId(@NonNull String deviceId) {
+        this.deviceId = deviceId;
+    }
+
     public Call enqueue(String url, NonEmptyCallback<Response> callback) {
-        Request request = new Request.Builder().url(url).build();
+        Request.Builder builder = new Request.Builder().url(url);
+        if (deviceId != null) {
+            builder.addHeader("X-Capawesome-Device-Id", deviceId);
+        }
+        Request request = builder.build();
 
         Call call = okHttpClient.newCall(request);
         call.enqueue(

package/android/src/main/java/io/capawesome/capacitorjs/plugins/liveupdate/LiveUpdatePlugin.java

@@ -14,12 +14,14 @@ import io.capawesome.capacitorjs.plugins.liveupdate.classes.events.DownloadBundl
 import io.capawesome.capacitorjs.plugins.liveupdate.classes.events.NextBundleSetEvent;
 import io.capawesome.capacitorjs.plugins.liveupdate.classes.options.DeleteBundleOptions;
 import io.capawesome.capacitorjs.plugins.liveupdate.classes.options.DownloadBundleOptions;
+import io.capawesome.capacitorjs.plugins.liveupdate.classes.options.FetchChannelsOptions;
 import io.capawesome.capacitorjs.plugins.liveupdate.classes.options.FetchLatestBundleOptions;
 import io.capawesome.capacitorjs.plugins.liveupdate.classes.options.SetChannelOptions;
 import io.capawesome.capacitorjs.plugins.liveupdate.classes.options.SetConfigOptions;
 import io.capawesome.capacitorjs.plugins.liveupdate.classes.options.SetCustomIdOptions;
 import io.capawesome.capacitorjs.plugins.liveupdate.classes.options.SetNextBundleOptions;
 import io.capawesome.capacitorjs.plugins.liveupdate.classes.options.SyncOptions;
+import io.capawesome.capacitorjs.plugins.liveupdate.classes.results.FetchChannelsResult;
 import io.capawesome.capacitorjs.plugins.liveupdate.classes.results.FetchLatestBundleResult;
 import io.capawesome.capacitorjs.plugins.liveupdate.classes.results.GetBlockedBundlesResult;
 import io.capawesome.capacitorjs.plugins.liveupdate.classes.results.GetConfigResult;
@@ -35,7 +37,7 @@ import io.capawesome.capacitorjs.plugins.liveupdate.interfaces.Result;
 public class LiveUpdatePlugin extends Plugin {
 
     public static final String TAG = "LiveUpdate";
-    public static final String VERSION = "8.1.0";
+    public static final String VERSION = "8.2.0";
     public static final String SHARED_PREFERENCES_NAME = "CapawesomeLiveUpdate"; // DO NOT CHANGE
     public static final String ERROR_APP_ID_MISSING = "appId must be configured.";
     public static final String ERROR_BUNDLE_EXISTS = "bundle already exists.";
@@ -178,6 +180,34 @@ public class LiveUpdatePlugin extends Plugin {
         }
     }
 
+    @PluginMethod
+    public void fetchChannels(PluginCall call) {
+        try {
+            String appId = config.getAppId();
+            if (appId == null || appId.isEmpty()) {
+                call.reject(ERROR_APP_ID_MISSING);
+                return;
+            }
+
+            FetchChannelsOptions options = new FetchChannelsOptions(call);
+            NonEmptyCallback<FetchChannelsResult> callback = new NonEmptyCallback<>() {
+                @Override
+                public void success(FetchChannelsResult result) {
+                    resolveCall(call, result.toJSObject());
+                }
+
+                @Override
+                public void error(Exception exception) {
+                    rejectCall(call, exception);
+                }
+            };
+
+            implementation.fetchChannels(options, callback);
+        } catch (Exception exception) {
+            rejectCall(call, exception);
+        }
+    }
+
     @PluginMethod
     public void fetchLatestBundle(PluginCall call) {
         try {

package/android/src/main/java/io/capawesome/capacitorjs/plugins/liveupdate/classes/api/GetChannelsResponseItem.java

@@ -0,0 +1,28 @@
+package io.capawesome.capacitorjs.plugins.liveupdate.classes.api;
+
+import androidx.annotation.NonNull;
+import org.json.JSONObject;
+
+public class GetChannelsResponseItem {
+
+    @NonNull
+    private final String id;
+
+    @NonNull
+    private final String name;
+
+    public GetChannelsResponseItem(@NonNull JSONObject responseJson) {
+        this.id = responseJson.optString("id");
+        this.name = responseJson.optString("name");
+    }
+
+    @NonNull
+    public String getId() {
+        return id;
+    }
+
+    @NonNull
+    public String getName() {
+        return name;
+    }
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/liveupdate/classes/options/FetchChannelsOptions.java

@@ -0,0 +1,38 @@
+package io.capawesome.capacitorjs.plugins.liveupdate.classes.options;
+
+import androidx.annotation.NonNull;
+import androidx.annotation.Nullable;
+import com.getcapacitor.PluginCall;
+
+public class FetchChannelsOptions {
+
+    @Nullable
+    private final Integer limit;
+
+    @Nullable
+    private final Integer offset;
+
+    @Nullable
+    private final String query;
+
+    public FetchChannelsOptions(@NonNull PluginCall call) {
+        this.limit = call.getInt("limit");
+        this.offset = call.getInt("offset");
+        this.query = call.getString("query");
+    }
+
+    @Nullable
+    public Integer getLimit() {
+        return limit;
+    }
+
+    @Nullable
+    public Integer getOffset() {
+        return offset;
+    }
+
+    @Nullable
+    public String getQuery() {
+        return query;
+    }
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/liveupdate/classes/results/ChannelResult.java

@@ -0,0 +1,28 @@
+package io.capawesome.capacitorjs.plugins.liveupdate.classes.results;
+
+import androidx.annotation.NonNull;
+import com.getcapacitor.JSObject;
+import io.capawesome.capacitorjs.plugins.liveupdate.interfaces.Result;
+
+public class ChannelResult implements Result {
+
+    @NonNull
+    private final String id;
+
+    @NonNull
+    private final String name;
+
+    public ChannelResult(@NonNull String id, @NonNull String name) {
+        this.id = id;
+        this.name = name;
+    }
+
+    @NonNull
+    @Override
+    public JSObject toJSObject() {
+        JSObject result = new JSObject();
+        result.put("id", id);
+        result.put("name", name);
+        return result;
+    }
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/liveupdate/classes/results/FetchChannelsResult.java

@@ -0,0 +1,28 @@
+package io.capawesome.capacitorjs.plugins.liveupdate.classes.results;
+
+import androidx.annotation.NonNull;
+import com.getcapacitor.JSArray;
+import com.getcapacitor.JSObject;
+import io.capawesome.capacitorjs.plugins.liveupdate.interfaces.Result;
+
+public class FetchChannelsResult implements Result {
+
+    @NonNull
+    private final ChannelResult[] channels;
+
+    public FetchChannelsResult(@NonNull ChannelResult[] channels) {
+        this.channels = channels;
+    }
+
+    @NonNull
+    @Override
+    public JSObject toJSObject() {
+        JSObject result = new JSObject();
+        JSArray channelsArray = new JSArray();
+        for (ChannelResult channel : channels) {
+            channelsArray.put(channel.toJSObject());
+        }
+        result.put("channels", channelsArray);
+        return result;
+    }
+}