Class

URLSessionTask

A task, like downloading a specific resource, performed in a URL session. URLセッションにおいて実行される、特定のリソースをダウンロードするような、あるタスク。

Declaration 宣言

class URLSessionTask : NSObject

Overview 概要

The URLSessionTask class is the base class for tasks in a URL session. Tasks are always part of a session; you create a task by calling one of the task creation methods on a URLSession instance. The method you call determines the type of task. URLSessionTaskクラスは、あるURLセッションの中のタスクに対する基本クラスです。タスクは常にあるセッションの一部です；あなたはタスクをURLSessionインスタンス上でタスク作成メソッドを呼び出すことによって作成します。あなたが呼び出すメソッドは、タスクの種類を決定します。

Use URLSession’s dataTask(with:) and related methods to create URLSessionDataTask instances. Data tasks request a resource, returning the server’s response as one or more NSData objects in memory. They are supported in default, ephemeral, and shared sessions, but are not supported in background sessions. URLSessionのもつdataTask(with:)と関連メソッドを使って、URLSessionDataTaskインスタンスを作成してください。データタスクはあるリソースを要請します、それはサーバのもつ応答を１つ以上のNSDataオブジェクトとしてメモリの中に返します。それらは、省略時、短命、そして共有セッションでサポートされます、しかしバックグラウンドセッションではサポートされません。
Use URLSession’s uploadTask(with:from:) and related methods to create URLSessionUploadTask instances. Upload tasks are like data tasks, except that they make it easier to provide a request body so you can upload data before retrieving the server’s response. Additionally, upload tasks are supported in background sessions. URLSessionのもつuploadTask(with:from:)と関連メソッドを使って、URLSessionUploadTaskインスタンスを作成してください。アップロードタスクはデータタスクに似ています、しかしそれらがリクエストボディの提供をより簡単にすることを除きます、それであなたはサーバのもつ応答を受け取る前にデータをアップロードできます。加えて、アップロードタスクは、バックグラウンドセッションにおいてサポートされます。
Use URLSession’s downloadTask(with:) and related methods to create URLSessionDownloadTask instances. Download tasks download a resource directly to a file on disk. Download tasks are supported in any type of session. URLSessionのもつdownloadTask(with:)と関連メソッドを使って、URLSessionDownloadTaskインスタンスを作成してください。ダウンロードタスクは、リソースを直接にディスク上のファイルへとダウンロードします。ダウンロードタスクは、あらゆる型のセッションにおいてサポートされます。
Use URLSession’s streamTask(withHostName:port:) or streamTask(with:) to create URLSessionStreamTask instances. Stream tasks establish a TCP/IP connection from a host name and port or a net service object. URLSessionのもつstreamTask(withHostName:port:)またはstreamTask(with:)を使って、URLSessionStreamTaskインスタンスを作成してください。ストリームタスクは、TCP/IP接続をホスト名とポートまたは新しいネットサービスオブジェクトから確立します。

After you create a task, you start it by calling its resume() method. The session then maintains a strong reference to the task until the request finishes or fails; you don’t need to maintain a reference to the task unless it’s useful for your app’s internal bookkeeping. あなたがタスクを作成する後、あなたはそれをそれのresume()メソッドを呼び出すことによって開始します。セッションは、それからそのタスクへの強い参照をリクエストが終了または失敗するまで保守します；あなたはタスクへの参照を保守する必要はありません、それがあなたのアプリのもつ内部的簿記に役立つ場合を除いて。

Topics 話題

Controlling the Task State タスク状態を制御する

func cancel()

Cancels the task. タスクを取り消します。

func resume()

Resumes the task, if it is suspended. タスクを再開します、もしれそが一時停止されるならば。

func suspend()

Temporarily suspends a task. 一時的にタスクを一時停止します。

var state: URLSessionTask.State

The current state of the task—active, suspended, in the process of being canceled, or completed. タスクの現在の状態 — 活動中、一時停止、取り消される処理中、または完了した。

enum URLSessionTask.State

Constants for determining the current state of a task. タスクの現在の状態を決定するための定数。

var priority: Float

The relative priority at which you’d like a host to handle the task, specified as a floating point value between 0.0 (lowest priority) and 1.0 (highest priority). それであなたがホストにそのタスクを取り扱って欲しい相対的優先度、0.0（最低優先度）と1.0（最高優先度）の間の浮動小数点値として指定されます。

URL Session Task Priority URLセッションタスク優先度

Constants for providing task priority hints to a host, used with the priority property. タスク優先度ヒントをホストに提供するための定数、priorityプロパティで使われます。

Obtaining Task Progress タスク進捗を取得する

var progress: Progress

A representation of the overall task progress. 全てひっくるめたタスク進捗の表現。

var countOfBytesExpectedToReceive: Int64

The number of bytes that the task expects to receive in the response body. タスクが応答ボディにおいて受け取ることを予想するバイト数。

var countOfBytesReceived: Int64

The number of bytes that the task has received from the server in the response body. タスクがサーバーから応答ボディにおいて受け取ったバイト数。

var countOfBytesExpectedToSend: Int64

The number of bytes that the task expects to send in the request body. タスクがリクエストボディにおいて送ることを予想するバイト数。

var countOfBytesSent: Int64

The number of bytes that the task has sent to the server in the request body. タスクがリクエストボディにおいてサーバーに送ったバイト数。

let NSURLSessionTransferSizeUnknown: Int64

The total size of the transfer cannot be determined. 転送の合計サイズが決定されることができません。

Obtaining General Task Information 一般的タスク情報を入手する

var currentRequest: URLRequest?

The URL request object currently being handled by the task. 現在タスクによって取り扱われているURLリクエストオブジェクト。

var originalRequest: URLRequest?

The original request object passed when the task was created. タスクが作成された時に渡された元のリクストオブジェクト。

var response: URLResponse?

The server’s response to the currently active request. 現在活動中のリクエストへのサーバのもつ応答。

var taskDescription: String?

An app-provided string value for the current task. 現在のタスクに対するアプリ提供の文字列値。

var taskIdentifier: Int

An identifier uniquely identifying the task within a given session. 与えられたセッション内でタスクを特有に識別している識別子。

var error: Error?

An error object that indicates why the task failed. なぜタスクが失敗したかを指し示しているエラーオブジェクト。

Determining Task Behavior

var prefersIncrementalDelivery: Bool

A Boolean value that determines whether to deliver a partial response body in increments. あるブール値、それは部分的返答本文を増分として配達するかどうかを決定します。

Using a Task-Specific Delegate タスク特有委任先を使う

var delegate: URLSessionTaskDelegate?

A delegate specific to the task. そのタスクに特有なある委任先。

protocol URLSessionTaskDelegate

A protocol that defines methods that URL session instances call on their delegates to handle task-level events. あるプロトコル、それはいくつかのメソッドを定義します、それらはURLセッションインスタンスがそれらの委任先上で呼び出してタスク水準イベントを取り扱うものです。