プログラムを書こう!

実務や自作アプリ開発で習得した役に立つソフトウェア技術情報を発信するブログ

SwiftのBox APIでディレクトリをリネームする。

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

f:id:paveway:20190914064630j:plain

目次

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

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

絶対に挫折しない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でディレクトリをリネームするには、folderRenameRequestメソッドを使用します。
ファイルはこのメソッドでリネームできず、別のメソッドでリネームします。

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

  1. Boxのクライアントオブジェクトを取得します。
  2. クライアントオブジェクトのfolderRenameRequestメソッドで、ディレクトリリネームリクエストを生成します。
    folderRenameRequestメソッドの引数には、

    • リネームするディレクトリのID

    を指定します。

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

実装例

import BOXContentSDK

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

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

目次へ

4. おわりに

ディレクトリのリネームする手順は、ファイルをリネームする手順とほとんど同じです。

今回でPWEditorで使用しているBox APIの紹介は終わります。
Box APIの他のAPIを使用する機会があれば、また紹介したいと思います。

エンジニアによるエンジニアのためのサイト始まる!!【teratail】

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

詳細!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

目次へ