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

この記事は2018年06月29日に投稿しました。
この記事は2018年07月21日に更新しました。

目次

1. はじめに
2. ファイル一覧取得処理
3. おわりに

[改訂新版]Swiftポケットリファレンス (POCKET REFERENCE)

1. はじめに

こんにちは、iOSのエディタアプリPWEditorの開発者の二俣です。

OneDrive APIでファイル一覧を取得してみます。
なおDropbox APIのファイル一覧取得処理のgetFileInfoListメソッドとOneDrive API用のgetFileInfoListメソッドのI/Fは合わせてあります。

ドキュメント"Collections in the OneDrive SDK for iOS"の"Getting a collection"を参考にしました。

目次へ

2. ファイル一覧取得処理

OneDrive APIでファイル一覧を取得するには、getWithCompletionメソッドを使用します。
OneDrive APIで、ディレクトリやファイルはIDで管理されています。
そのためサンプルgetFileInfoListメソッドの引数はpathNameとしていますが、実際はIDを指定します。
ルートディレクトリの場合、IDは"root"となります。

OneDrive APIもDropbox APIと同じような処理で、

1. 認証済みクライアントオブジェクトを取得します。
2. 認証済みクライアントオブジェクトに対し、ファイル一覧取得処理を実行します。
3. クロージャで結果を取得します。
4. エラーやファイル情報リストの有無のチェックを行います。
5. ファイル情報リストからファイル情報を取得します。

という感じになります。
ただしOneDrive APIの場合、"2の処理"は認証済みクライアントオブジェクトに対して直接ではなく、そこからリクエストオブジェクトを取得して、ファイル一覧処理を実行します。

import OneDriveSDK

/**
 パス名で指定されるディレクトリのファイル一覧を取得します。
 
 - Parameter pathName: パス名(実際はID)
 */
func getFileInfoList(pathName: String) {
    // 認証済みクライアントオブジェクトを取得します。
    guard let client = ODClient.loadCurrent() else {
        // 認証済みクライアントオブジェクトが取得できない場合、処理を終了します。
        // 念のためのチェックです。
        // 必要に応じてエラー処理を行ってください。
        return
    }
    
    // リクエストオブジェクトを取得します。
    // clientオブジェクトから直接取得できないため、長くなっています。
    guard let drive = client.drive(), let items = drive.items(pathName), let children = items.children(), let request = children.request() else {
        // リクエストオブジェクトが取得できない場合、処理を終了します。
        // 必要に応じてエラー処理を行ってください。
        return
    }
    
    // リクエストオブジェクトを使ってファイル一覧を取得します。
    request.getWithCompletion { (children: ODCollection?, nextRequest: ODChildrenCollectionRequest?, error: Error?) -> Void in
        if let error = error {
            // エラーの場合、処理を終了します。
            // 必要に応じてエラー処理を行ってください。
            return
        }
        
        guard let children = children else {
            // ファイル情報オブジェクトが取得できない場合、処理を終了します。
            // 必要に応じてエラー処理を行ってください。
            return
        }
        
        // ファイル情報オブジェクトをOneDriveのファイル情報(ODItem)に型変換します。
        guard let items = children.value as? [ODItem] else {
            // 型変換できない場合、処理を終了します。
            // 必要に応じてエラー処理を行ってください。
            return
        }
        
        // ファイル情報数分繰り返します。
        for item in items {
            // itemから必要なファイル情報を取得してください。
            // IDを取得します。
            let id = item.id
            // 名前を取得します。
            let name = item.name
            
            // ファイルかディレクトリか判定します。
            if let _ = item.file {
                // ファイルの場合

            } else {
                // ディレクトリの場合
            }
        }
    )}
}

目次へ

3. おわりに

後日説明する予定のGoogleDrive APIも同様なのですが、OneDrive APIではファイルやディレクトリはIDで管理されています。
PWEditorは最初にローカルストレージとDropbx APIに対応した関係で、ファイルやディレクトリはパス名で操作していました。
そして共通的な処理は、全ストレージで同じI/Fにしてありました。
そのため今回のgetFileInfoListメソッドも、引数のパス名をIDとして扱うように調整しました。

プログラミングのオンラインスクールのCodeCamp

Swift 4プログラミング入門 iOS 11+Xcode 9対応

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

目次へ

---

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

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

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

目次へ