Instance Method インスタンスメソッド

startDownloadingUbiquitousItemAtURL:error:

Starts downloading (if necessary) the specified item to the local system. 指定された項目をローカルシステムにダウンロードすることを開始します。

Declaration 宣言

- (BOOL)startDownloadingUbiquitousItemAtURL:(NSURL *)url 
                                      error:(NSError * _Nullable *)error;

Parameters パラメータ

url

The URL for the file or directory in the cloud that you want to download. あなたがダウンロードを望むクラウドでのファイルまたはディレクトリのURL。

errorOut

On input, a pointer to variable for an NSError object. If an error occurs, this pointer is set to an NSError object containing information about the error. You may specify nil to ignore the error information. 入力では、あるNSErrorオブジェクトに対する変数へのポインタ。エラーが発生するならば、このポインタはエラーについての情報を含んでいるNSErrorオブジェクトへと設定されます。あなたは、nilを指定して、エラー情報を無視するかもしれません。

Return Value 戻り値

YES if the download started successfully or was not necessary, otherwise NO. If NO is returned and errorOut is not nil, an NSError object describing the error is returned in that parameter. YES、もしダウンロードがうまく始まったまたは必要なかったならば、そうでなければNONOが返されるそしてerrorOutnilでないならば、エラーを記述しているNSErrorオブジェクトがそのパラメータにおいて返されます。

Discussion 議論

If a cloud-based file or directory has not been downloaded yet, calling this method starts the download process. If the item exists locally, calling this method synchronizes the local copy with the version in the cloud. クラウドベースのファイルまたはディレクトリがまだダウンロードされていないならば、このメソッドを呼ぶことはダウンロードプロセスを開始します。項目がローカルに存在するならば、このメソッドの呼び出しは、ローカルコピーをクラウドにおけるバージョンと同期します。

For a given URL, you can determine if a file is downloaded by getting the value of the NSMetadataUbiquitousItemDownloadingStatusKey key. You can also use related keys to determine the current progress in downloading the file. 与えられたURLに対して、あなたはダウンロードされたかをNSMetadataUbiquitousItemDownloadingStatusKeyキーの値を取得することによって判定できます。あなたはまた、関連したキーを使ってファイルのダウンロードでの現在の進捗を明らかにできます。

See Also 参照

Managing iCloud-Based Items iCloud基盤の項目を管理する