SwiftのBox APIでファイルをリネームする。

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

目次

1. はじめに
2. 前提
3. ファイルリネーム処理
4. おわりに

作って学ぶ　iPhoneアプリの教科書　【Swift4＆Xcode 9対応】 (教科書シリーズ)

1. はじめに

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

目次へ

2. 前提

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

paveway.hatenablog.com

目次へ

3. ファイルリネーム処理

SwiftのBox APIでファイルをリネームするには、fileRenameRequestメソッドを使用します。
ディレクトリはこのメソッドでリネームできず、別のメソッドでリネームします。

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

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

2. クライアントオブジェクトのfileRenameRequestメソッドで、ファイルリネームリクエストを生成します。
   fileRenameRequestメソッドの引数には、

   • リネームするファイルのID

   を指定します。

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

実装例

import BOXContentSDK

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

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

目次へ

4. おわりに

他のクラウドストレージのAPIでリネームのAPIはあまりないのですが、Box APIには用意されていました。
いろいろなクラウドストレージのAPIを使用してみましたが、Box APIが一番整理されていると思います。

未経験から最短でエンジニア転職を目指す

詳細! Swift iPhoneアプリ開発入門ノート iOS12 + Xcode 10対応

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

目次へ

---

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

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

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

目次へ