SwiftのBox APIでファイル一覧を取得する。

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

目次

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でファイル一覧を取得する手順です。
この手順は、Box iOS SDKライブラリのドキュメントFoldersのGet Info about a Box Folderを参考にしました。

Boxではディレクトリやファイルは、ファイルパス名ではなくIDで管理されています。
これはGoogle Drive APIやOne Drive APIと同じです。

ルートディレクトリのIDは、BOXAPIFolderIDRootになります。
BOXAPIFolderIDRootはString型ですが、値はBox iOS SDKライブラリのソースを確認したところ、"0"のようです。

1. Boxのクライアントオブジェクトを取得します。
2. クライアントオブジェクトのfolderItemsRequestメソッドで、ファイル一覧取得リクエストを生成します。
   folderItemsRequestメソッドの引数には、ファイル一覧を取得するディレクトリのIDを指定します。
3. ファイル一覧取得リクエストのperformメソッドを実行し、ファイル一覧を取得します。 取得した結果はクロージャで返却されます。
   ネットワークアクセスしますので、PWEditorではファイル一覧取得中は、処理中ダイアログを表示しています。
4. エラーがあれば、クロージャーの引数errorが設定されます。
   取得したファイル一覧はクロージャーの引数itemsに設定されます。
   itemsはArray型なので、BOXItem型配列に型変換して使用します。

実装例

import BOXContentSDK

/**
 ファイル一覧を取得します。
 
 - Parameter id: ファイル一覧を取得するディレクトリのID
 */
func getFileList(_ id: String) {
    // 1. クライアントオブジェクトを取得します。
    guard let client = BoxContentClient.default() else {
        // クライアントオブジェ久我取得できない場合、処理を終了します。
        // 必要に応じてエラー処理を行ってください。
        return
    }
    
    // 2. ファイル一覧取得リクエストを取得します。
    let request = client.folderItemsRequest(withID: id)
    
    // 3. ファイル一覧を取得します。
    request.perform(completion: { (items: Array<Any>?, error: Error?) -> Void in
        // 4. エラーかチェックします。
        if let error = error {
            // エラーの場合、処理を終了します。
            // 必要に応じてエラー処理してください。
            return
        }
        
        // 4. ファイル一覧のアイテム配列が取得できたかチェックします。
        guard let items = items else {
            // 取得できない場合、処理を終了します。
            // 必要に応じてエラー処理してください。
            return
        }
        
        // 4. ファイル一覧のアイテム配列をBOXItem型配列に変換します。
        guard let boxItems = items as? [BOXItem] else {
            // 変換できない場合、処理を終了します。
            // 必要に応じてエラー処理してください。
            return
        }
        
        // 以降正常終了した場合の処理を記述してください。
        // 以下はサンプルです。
        
        // BOXItem数分繰り返します。
        for boxItem in BoxItems {
            // 名前を取得します。
            guard let name = boxItem.name else {
                // 名前が取得できない場合、次のBOXItemへ
                continue
            }
            
            if boxItem.isFile {
                // ファイルの場合
            
            } else if boxItem.isFolder {
                // ディレクトリの場合
            
            } else {
                // 上記以外、次のアイテムへ
                continue
            }
        }
    })
}

目次へ

4. おわりに

他のファイル操作の Box APIも同じような手順になります。
Box APIはよく整理されていて、以前紹介したDropbox API以上に実装が簡単です。
自分でもこんな風にAPIの設計ができたらと思います。

【WebCamp】

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

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

目次へ

---

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

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

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

目次へ