SwiftのBox APIでディレクトリを作成する。

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

目次

1. はじめに
2. 前提
3. ディレクトリ作成処理
4. おわりに

絶対に挫折しないiPhoneアプリ開発「超」入門 増補第6版【Swift 4 & iOS 11】完全対応 (Informatics&IDEA)

1. はじめに

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

目次へ

2. 前提

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

paveway.hatenablog.com

目次へ

3. ディレクトリ作成処理

SwiftのBox APIでディレクトリを作成するには、クライアントオブジェクトのfolderCreateRequestメソッドを使用します。

以下がディレクトリを作成する手順です。 この手順は、Box iOS SDKライブラリのドキュメントFoldersのCreate a new Box Folderを参考にしました。

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

2. クライアントオブジェクトのfolderCreateRequestメソッドで、ディレクトリ作成リクエストを生成します。
   folderCreateRequestメソッドの引数には、

   • ディレクトリ名
   • ディレクトリを作成するディレクトリのID
     ルートディレクトリの場合はBOXAPIFolderIDRoot定数

   を指定します。

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

実装例

import BOXContentSDK

/**
 ディレクトリを作成します。

 - Parameter dirName: ディレクトリ名
 - Parameter parentId: ディレクトリを作成するディレクトリのID
 */
func createDir(_ dirName: String, parentId: String) {
    // 1. クライアントオブジェクトを取得します。
    guard let client = BoxContentClient.default() else {
        // クライアントオブジェ久我取得できない場合、処理を終了します。
        // 必要に応じてエラー処理を行ってください。
        return
    }

    // 2. ディレクトリ作成リクエストを取得します。
    let request = client.folderCreateRequest(withName: dirName, parentFolderID: parentId)
    
    // 3. ディレクトリを作成します。
    request.perform(completion: { (folder: BOXFolder?, error: Error?) -> Void in
        // 4. エラーかチェックします。
        if let error = error {
            // エラーの場合、処理を終了します。
            // 必要に応じてエラー処理してください。
            return
        }
        
        // 4. ディレクトリが作成されたかチェックします。
        guard let _ = folder else {
            // ディレクトリが作成されていない場合、処理を終了します。
            // 必要に応じてエラー処理してください。
            return
        }

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

目次へ

4. おわりに

ファイル作成のfileUploadRequestToFolderメソッドの引数の順序は、

• 親ディレクトリのID
• ファイルデータ
• ファイル名

でした。

しかし今回のディレクトリ作成のfolderCreateRequestメソッドの引数の順序は、

• ディレクトリ名
• 親ディレクトリのID

です。

細かい話ですが、引数の順序も合わせてもらえたらと、思いました。

プログラミングスクール【Tech Boost】

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

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

目次へ

---

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

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

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

目次へ