cordova-plugin-advance-downloader

環境セットアップ

Cordova のインストール

$ npm install -g cordova@10.0.0-nightly.2020.5.20.7b8e8678
$ cordova -v

iOS の場合 cocoapod のインストール

• cocoapods 使ってるので、 cocoapods の方のインストールをお願いします
• インストール方法は割愛します。自分は rbenv 使って ruby install して gem 入れてます
• 留意点 ... pod の version を 1.8.0 以上にしておく

ビルド

• 開発したプラグインを cordova で使ってみるために demo フォルダーがあります。
• demo フォルダーでビルドして確認してくだい
• 以下コマンドで platform を追加後、xcode or android studio で開いて、そこから run すれば動きます

$ cd demo;
$ yarn add:ios
$ yarn build:ios
$ open ./platforms/ios # このフォルダ以下が ios の開発環境になります xcworkspace を xcode で開いてください
$ open ./platforms/android # このフォルダ以下が android の開発環境になります android studio　から指定してください

シンボリックリンク貼ってるので、基本的に、IDE から該当ファイルいじっても、plugin の file の方も同期されます

なお、対象のファイルは xcode だと

の二つかなと思います。別途ファイルを追加する場合は、plugin.xml に追加するファイルを既述する必要があるので、ご注意ください。

画面をいじる

• cordova なので HTML ファイルをいじってください
• demo/www/** がビルド時にバンドルされる HTML/CSS/JS になります
• とりあえずテストボタンを追加しております

開発の留意点

package.jsonなどの更新をしたくない

無視させたいとき

git update-index --skip-worktree package.json
git update-index --skip-worktree package-lock.json

無視設定を解除したいとき

git update-index --no-skip-worktree [ファイル名]

設定の確認

git ls-files -v

フォルダ-構成

- demo
    - www <- cordova 上で表示する HTML/CSS/JS
        + css
        + img
        + js
            - index.js <- ここに画面に関するロジックを書く
        + index.html　<- こいつをいじると画面が変わる

- src <-  各プラットフォームのソースファイルが入っている
    + ios
    + android

- www
 + AdvanceDownloader.js <- ブリッジとなる js ファイル (js inteface)

- plugin.xml <- プラグインの情報 (pod とかはここで追加する)

何かおかしくなったら、

$ yarn clean
$ yarn add:ios

プッシュするもの

基本的には ./src/**/* と www/src/ だけで大丈夫です

js のインターフェースたたき台

関数一覧

// 新規ダウンロードの追加
add: (params) => createAction('add', params),
// ダウンロードの取得
getTasks: (params) => createAction('getTasks', params),
// 特定の id のダウンロードの開始
start: (params) => createAction('start', params),
// 特定の id のダウンロードの一時停止
pause: (params) => createAction('pause', params),
// 特定の id のダウンロードの再開
resume: (params) => createAction('resume', params),
// 特定の id のダウンロードの中断
stop: (params) => createAction('stop', params),
// イベントの登録
on: (id, action, callback) => {
    // action === start | pause | resume | stop | complete | fail;
    exec(
        (data) => {
            // 成功
            callback(data)
        },
        () => {
            // 失敗
            // TODO: error handling
        },'AdvanceDownloader', action, [id, action]
    );
},
// イベントの削除
off: (params) => createAction('off', params),

parameter の想定

// 追加時
interface AddRequestParams {
    url: string,     // ダウンロード元URL
    path: string,    // ファイルを保存するパスを渡せる
    fileName: string // hogehoge.mp3
    headers: { // 認証ヘッダー
        auautherization: stirng
    }
}
interface AddResponseParams {
    id: string,
    fileName: string // hogehoge.mp3
    absolutePath: string
}

// スタート
interface StartRequestParams {
    id: string
}
interface startResponseParams {
    id: string,
    filename: string,
    absolutePath: string
}

// 一時停止
interface PauseRequestParams {
    id: string
}
interface PauseResponseParams {
    id: string,
    filename: string,
    absolutePath: string
}

// 再開
interface ResumeRequestParams {
    id: string
}
interface ResumeResponseParams {
    id: string,
    filename: string,
    absolutePath: string
}

// ストップ
interface StopRequestParams {
    id: string
}
interface StopResponseParams {
    id: string,
    filename: string,
    absolutePath: string
}

// on
type ActionType = 'start' | 'pause' | 'resume' | 'stop' | 'complete' | 'fail'
interface onRequestParams {
    id: string,
    action:  ActionType
}
interface onResponseParams {}

// off
type ActionType = 'start' | 'pause' | 'resume' | 'stop' | 'complete' | 'fail'
interface onRequestParams {
    id: string,
    action:  ActionType
}
interface onResponseParams {}