SwiftのBox APIでファイルをコピーする。

この記事は2018年10月11日に投稿しました。

目次

1. はじめに
2. 前提
3. ファイルコピー処理
4. おわりに

たった2日でマスターできる iOSアプリ開発集中講座 Xcode 9/Swift 4対応

1. はじめに

こんにちは、iOSのエディタアプリPWEditorの開発者の二俣です。
今回はSwiftのBox APIでファイルをコピーする手順の紹介です。

目次へ

2. 前提

iOSアプリからBox APIにアクセスするため、Box iOS SDKライブラリを使用します。
以下の記事を参考に、Box APIを使用する準備をしておいてください。

paveway.hatenablog.com

目次へ

3. ファイルコピー処理

SwiftのBox APIでファイルをコピーするには、fileCopyRequestメソッドを使用します。
ディレクトリはこのメソッドでコピーできず、別のメソッドでコピーします。

以下がファイルをコピーする手順です。 この手順はドキュメントに記載がなかったため、調べながら実装しました。

1. Boxのクライアントオブジェクトを取得します。

2. クライアントオブジェクトのfileCopyRequestメソッドで、ファイルコピーリクエストを生成します。
   fileCopyRequestメソッドの引数には、

   • コピー元のファイルのID
   • コピー先のディレクトリのID

   を指定します。

3. ファイルコピーリクエストのperformメソッドを実行し、ファイルをコピーします。 コピーした結果はクロージャで返却されます。 ネットワークアクセスしますので、PWEditorではファイルコピー中は、処理中ダイアログを表示しています。
4. エラーがあれば、クロージャーの引数errorが設定されます。
   コピーしたファイルはクロージャーの引数fileに設定されます。

実装例

import BOXContentSDK

/**
 ファイルをコピーします。
 
 - Parameter fileId: コピー元のファイルのID
 - Parameter parentId: コピー先のディレクトリのID
 */
func copyFile(_ fileId: String, parentId: String) {
    // 1. クライアントオブジェクトを取得します。
    guard let client = BoxContentClient.default() else {
        // クライアントオブジェ久我取得できない場合、処理を終了します。
        // 必要に応じてエラー処理を行ってください。
        return
    }
    
    // 2. ファイルコピーリクエストを取得します。
    guard let request = client.fileCopyRequest(withID: fileId, destinationFolderId: parentId) else {
        return
    }
    
    // 3. ファイルをコピーします。
    request.perform(completion: { (file: BOXFile?, error: Error?) -> Void in
        // 4. エラーかチェックします。
        if let error = error {
            // エラーの場合、処理を終了します。
            // 必要に応じてエラー処理してください。
            return
        }

        // 以降正常終了した場合の処理を記述してください。
    })
}

目次へ

4. おわりに

Box APIでコピーは、ディレクトリとファイルで使用するメソッドが異なります。
使う側からすると、正直一緒でもいいのでは、と思います。

イラスト作成ならココナラ

本気ではじめるiPhoneアプリ作り Xcode 9.x+Swift 4.x対応 (「ヤフー黒帯」シリーズ)

紹介している一部の記事のコードはGitlabで公開しています。
興味のある方は覗いてみてください。

目次へ

---

私が勤務しているニューラルでは、主に組み込み系ソフトの開発を行っております。
弊社製品のハイブリッドOS Bi-OSは高い技術力を評価されており、特に制御系や通信系を得意としています。
私自身はiOSモバイルアプリやウィンドウズアプリを得意としております。
ソフトウェア開発に関して相談などございましたら、お気軽にご連絡ください。

また一緒に働きたい技術者の方も随時募集中です。
興味がありましたらご連絡ください。

EMAIL : info-nr@newral.co.jp / m-futamata@newral.co.jp
TEL : 042-523-3663
FAX : 042-540-1688

目次へ