phonegap-plugin-csdk-asset-browser

The Creative SDK provides a convenient UI for accessing all of a user’s creative assets stored in the Creative Cloud, including files, photos, libraries, and mobile creations.

This plugin makes it possible for you to use the Creative SDK Asset Browser in your PhoneGap apps on Android and iOS. Read on to learn how!

Contents

• Prerequisites
• Installation
• Setup guide
• Sample code
• API guide

Prerequisites

Required: You must first install the Client Auth plugin for this plugin to work.

Required: This guide will assume that you have installed all software and completed all of the steps in the Client Auth guide.

Installation

Adding the plugin

Use the command below to add the plugin to your app.

Adding released version

phonegap plugin add --save phonegap-plugin-csdk-asset-browser

Adding development version

phonegap plugin add --save https://github.com/CreativeSDK/phonegap-plugin-csdk-asset-browser

Downloading the Creative SDK

iOS

Note: For some developers, the iOS version of the SDK is currently running into some server issues (getting a 400 on launch of the component). We are looking into the issue and will provide an update as soon as possible.

To get the iOS SDK, go to the Downloads page, click the download link for STATIC FRAMEWORKS (DEPRECATED), and extract it to the src/ios folder of this plugin. Extracting the ZIP will create an AdobeCreativeSDKFrameworks folder.

The ZIP files contain all the frameworks in the Creative SDK, but for this plugin we will only be using the AdobeCreativeSDKImage.framework.

Android

No action is required for Android. The Creative SDK for Android is delivered as a remote Maven repository, and the required framework will be downloaded automatically by the plugin.

Setup guide

1. cd into your existing PhoneGap app (must already include Client Auth)
2. Add this plugin (see "Adding the plugin" above)
3. iOS only: download and add the Creative SDK to this plugin's src/ios directory (see "Downloading the Creative SDK" above)
4. Build and run for your platform

Sample code

www/index.html

Add a button within the body. The PhoneGap "Hello World" example includes a div with an ID of app, so for this example, we are including it in there.

// ...

<div class="app">

	// ...

    <button id="launch-browser">Launch asset browser</button>
</div>

// ...

www/js/index.js

Note: Most of the code below comes from the PhoneGap "Hello World" example, and we are providing it here for context.

This plugin provides access to a global CSDKAssetBrowser object.

The CSDKAssetBrowser object exposes a .downloadFiles() function, and some enums to use when setting up your options.

See comments #1-2 below for relevant code:

var app = {
    initialize: function() {
        this.bindEvents();
    },
    bindEvents: function() {
        // ...

        /* 1) Add a click handler for your button */
        document.getElementById('launch-browser').addEventListener('click', this.launchBrowser, false);
    },
    onDeviceReady: function() {
        app.receivedEvent('deviceready');
    },
    receivedEvent: function(id) {
        // ...
    },

    /* 2) Make a helper function to launch the Asset Browser */
    launchBrowser: function() {

    	/* 2.a) Prep work for calling `.edit()` */
        function success(newUrl) {
            console.log("Success!", newUrl);
        }

        function error(error) {
            console.log("Error!", error);
        }

        var options = {};

        /* 2.b) Launch the Asset Browser */
        CSDKAssetBrowser.downloadFiles(success, error, options);
    }
};

API guide

See the full API guide.