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

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

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でファイルを移動するには、クライアントオブジェクトのfileMoveRequestメソッドを使用します。
ディレクトリはこのメソッドで移動できず、別のメソッドで移動します。

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

Boxのクライアントオブジェクトを取得します。
クライアントオブジェクトのfileMoveRequestメソッドで、ファイル移動リクエストを生成します。
fileMoveRequestメソッドの引数には、
- 移動元のファイルのID
- 移動先のディレクトリのID
を指定します。
ファイル移動リクエストのperformメソッドを実行し、ファイルを移動します。
移動した結果はクロージャで返却されます。
ネットワークアクセスしますので、PWEditorではファイル移動中は、処理中ダイアログを表示しています。
エラーがあれば、クロージャーの引数errorが設定されます。
移動したファイルはクロージャーの引数fileに設定されます。

実装例

import BOXContentSDK

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

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

目次へ

4. おわりに

いまさらですが、個人的にメソッド名などの命名は

動詞 + 名詞

にしています。
なので実装例のメソッド名は

moveFile

にしてます。

Box APIは

file + 動詞

または

folder + 動詞

になっています。
統一感が取れませんが、仕方ありません。

企業向けプログラミング研修【CodeCamp】

作って学ぶ iPhoneアプリの教科書【Swift4&Xcode 9対応】 ~人工知能アプリを作ってみよう! ~(特典PDF付き)

作者: 森巧尚,まつむらまきお
出版社/メーカー: マイナビ出版
発売日: 2017/12/25
メディア: 単行本（ソフトカバー）
この商品を含むブログを見る

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

目次へ

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

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

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

目次へ