SwiftのBox APIでファイルを作成する。 - プログラムを書こう！

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

f:id:paveway:20190914064630j:plain

1. はじめに

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

目次へ

2. 前提

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

paveway.hatenablog.com

目次へ

3. ファイル作成処理

SwiftのBox APIでファイルを作成するAPIは用意されていません。
代わりに空のファイルデータをアップロードしてファイルを作成します。
そのためfileUploadRequestToFolderメソッドを使用しします。

以下がファイルを作成する手順です。この手順は、Box iOS SDKライブラリのドキュメントFilesのUpload a Fileを参考にしました。

Boxのクライアントオブジェクトを取得します。
クライアントオブジェクトのfileUploadRequestToFolderメソッドで、ファイル作成リクエストを生成します。
fileUploadRequestToFolderメソッドの引数には、
- ファイルを作成するディレクトリのID
- ファイルデータ(今回は空データ)
- ファイル名
を指定します。
ファイル作成リクエストのperformメソッドを実行し、ファイルを作成します。ファイル作成の場合、進捗状況を通知するクロージャーと、作成した結果のクロージャの2つが用意されています。ネットワークアクセスしますので、PWEditorではファイル作成中は、処理中ダイアログを表示しています。
エラーがあれば、作成した結果のクロージャーの引数errorが設定されます。
作成したファイルは作成した結果のクロージャーの引数fileが設定されます。

実装例

import BOXContentSDK

/**
 ファイルを作成します。
 
 - Parameter parentId: ファイルを作成するディレクトリのID
 - Parameter fileName: ファイル名
 */
func createFile(_ parentId: String, fileName: String) {
    // 1. クライアントオブジェクトを取得します。
    guard let client = BoxContentClient.default() else {
        // クライアントオブジェ久我取得できない場合、処理を終了します。
        // 必要に応じてエラー処理を行ってください。
        return
    }
    
    // 空データを生成します。
    let data = Data()
    
    // 2. ファイル作成リクエストを取得します。
    guard let request = client.fileUploadRequestToFolder(withID: parentId, from: data, fileName: fileName) else {
        return
    }
    
    // 3. ファイルを作成します。
    request.perform(progress: { (totalBytesTransferred: Int64, totalBytesExpectedToTransfer: Int64) -> Void in
        // 処理中に呼び出されます。
        // 必要に応じて、進捗状況の表示等の処理を行ってください。

    }, completion: { (file: BOXFile?, error: Error?) -> Void in
        // ファイル作成処理が完了した時に呼び出されます。
        
        // 4. エラーかチェックします。
        if let error = error {
            // エラーの場合、処理を終了します。
            // 必要に応じてエラー処理してください。
            return
        }
        
        // 4. ファイルが作成されたかチェックします。
        guard let _ = files else {
            // ファイルが作成されていない場合、処理を終了します。
            // 必要に応じてエラー処理してください。
            return
        }

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

目次へ

4. おわりに

ファイル作成の場合、進捗状況が取得できるクロージャーも用意されています。
PWEditorでは子のクロージャーは利用しませんでしたが、よく考えられていると思います。

エンジニアのためのQ&Aサイト【teratail】

詳細！Swift 4 iPhoneアプリ開発入門ノート Swift 4+Xcode 9対応

作者: 大重美幸
出版社/メーカー: ソーテック社
メディア: Kindle版
この商品を含むブログを見る

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

目次へ

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

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

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

目次へ