SwiftのDropbox APIでファイルを更新する。

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

f:id:paveway:20190914064630j:plain

1. はじめに

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

PWEditorではDropboxのファイルの編集内容は、メモリ上で更新されています。
そのままでは編集した内容は保存されないので、編集した内容をDropbox上のファイルに反映する必要があります。
今回はその手順の説明になります。

目次へ

2. ファイル更新処理

Dropbox上のファイルの更新は、"ファイルを作成する"で使用したuploadメソッドを使います。
ファイルを作成した時とは異なりuploadメソッドの引数は、ファイルパス名、ファイルデータの他にいくつか必要になります。

modeは競合が発生した場合、どのような方針でファイルを更新するか指定します。
PWEditorでは".override"常に上書き保存となっています。

mode	説明
.add	常に新しいファイル名で保存されます。既存のファイルが存在する場合、例えば元のファイル名が"document.txt"の場合、新しく"document (2).txt"で保存されます。
.overwrite	常に上書き保存されます。
.update	競合していない場合は上書き保存します。競合した場合は、例えば元のファイル名が"document.txt"の場合、新しく"document (confilicted copy).txt"で保存されます。

autorenameは、"mode"で指定した競合時のファイルの自動生成を、行うかどうかを指定します。
PWEditorでは"常に上書き"のため、falseを指定しています。

clientModifiedはファイルのタイムスタンプを指定します。
nilの場合、Dropbox上にファイルが書き込まれた時刻になります。
タイムスタンプを指定した場合、指定されたタイムスタンプが記録されます。

muteは、ファイルの更新通知を行うかどうかの指定になります。

/**
 ファイルを更新します。
 
 - Parameter filePathName: ファイルパス名
 - Parameter fileData: ファイルデータ
 */
func saveFile(filePathName: String, fileData: Data) {
    gaurd let client = DropboxClientManager.authorizedClient else {
        // 認証済みクライアントオブジェクトが取得できない場合、処理を終了する。
        // 念のためのチェックです。
        // 必要ならばエラー処理してください。
        return
    }

    // Dropbox上のファイルを更新します。
    // PWEditorでは常に上書き保存になります。
    let _ = client.files.upload(path: filePathName, mode: .overwrite, autorename: false, clientModified: nil, mute: false, input: fileData).response { response, error in
        if let error = error {
            // エラーの場合、処理を終了します。
            // 必要ならばエラー処理してください。
            return
        }

        guard let response = response else {
            // レスポンスがない場合、処理を終了します。
            // 必要ならばエラー処理してください。
            reutrn
        }

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

API Reference
uploadメソッド
 mode(WriteMode)

目次へ

3. おわりに

おそらくDropboxの想定は、

ファイルは一旦デバイス側にダウンロードする。
ファイルの更新はデバイス側の一時ファイルに対して行う。
最後にアップロードする。

なのではないかと思います。
PWEditorはDropbox上のファイルを直接編集できるイメージにしているため、ファイルデータはメモリに展開し、更新時に毎回アップロードしています。
そのためネットワーク負荷はそれなりにかかります。

絶対に挫折しない iPhoneアプリ開発「超」入門第6版【Swift 4 ＆ iOS 11】完全対応

作者: 高橋京介
出版社/メーカー: SBクリエイティブ
発売日: 2017/11/22
メディア: Kindle版
この商品を含むブログを見る

キャッチコピー

紹介している一部の記事のコードは[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

目次へ