NSUrlSession NSUrlSession Class

Definition

Coordinates a set of data-transfer tasks, including large background tasks.

[Foundation.Register("NSURLSession", true)]
[ObjCRuntime.Introduced(ObjCRuntime.PlatformName.iOS, 7, 0, ObjCRuntime.PlatformArchitecture.All, null)]
[ObjCRuntime.Introduced(ObjCRuntime.PlatformName.MacOSX, 10, 9, ObjCRuntime.PlatformArchitecture.All, null)]
public class NSUrlSession : Foundation.NSObject
type NSUrlSession = class
    inherit NSObject
Inheritance
NSUrlSessionNSUrlSession
Derived
Attributes

Remarks

In iOS 7 and later, NSUrlSession and related classes are the preferred way to transfer larger files to and from the Web.

NSUrlSession downloads can work when the application is in the background.

Unlike regular tasks, background transfers are not constrained to 10 minutes, and instead will run until the transfer completes. Because background transfers are not bound by an arbitrary time limit, they can be used to upload or download large files, auto-update content in the background, and more.

The following example shows a download request, capable of asynchronously downloading a large file:


var config = NSUrlSessionConfiguration.BackgroundSessionConfiguration(Guid.NewGuid().ToString());
var session = NSUrlSession.FromConfiguration(config, new SimpleSessionDelegate(), new NSOperationQueue());
var downloadTask = session.CreateDownloadTask(NSUrlRequest.FromUrl(url));
//Begin download, asynchronously
downloadTask.Resume();
 ... 
class SimpleSessionDelegate : NSUrlSessionDownloadDelegate
{
  public override void DidFinishDownloading(NSUrlSession session, NSUrlSessionDownloadTask downloadTask, NSUrl location)
	{
		var file = File.OpenRead(location.Path);
     ...
	}
}

Constructors

NSUrlSession(IntPtr) NSUrlSession(IntPtr)

A constructor used when creating managed representations of unmanaged objects; Called by the runtime.

NSUrlSession(NSObjectFlag) NSUrlSession(NSObjectFlag)

Constructor to call on derived classes to skip initialization and merely allocate the object.

Properties

Class Class Inherited from NSObject
ClassHandle ClassHandle

The handle for this class.

Configuration Configuration

The configuration object for this session.

DebugDescription DebugDescription

A developer-meaningful description of this object.

(Inherited from NSObject)
Delegate Delegate

An instance of the Foundation.INSUrlSessionDelegate model class which acts as the class delegate.

DelegateQueue DelegateQueue

The operation queue used when this was created. Read-only.

Description Description

Description of the object, the Objective-C version of ToString.

(Inherited from NSObject)
Handle Handle

Handle (pointer) to the unmanaged object representation.

(Inherited from NSObject)
IsDirectBinding IsDirectBinding Inherited from NSObject
IsProxy IsProxy Inherited from NSObject
RetainCount RetainCount

Returns the current Objective-C retain count for the object.

(Inherited from NSObject)
Self Self Inherited from NSObject
SessionDescription SessionDescription

A human-readable description for the session.

SharedSession SharedSession

The shared singleton object.

Superclass Superclass Inherited from NSObject
SuperHandle SuperHandle

Handle used to represent the methods in the base class for this NSObject.

(Inherited from NSObject)
WeakDelegate WeakDelegate

An object that can respond to the delegate protocol for this type

Zone Zone Inherited from NSObject

Methods

AddObserver(NSObject, NSString, NSKeyValueObservingOptions, IntPtr) AddObserver(NSObject, NSString, NSKeyValueObservingOptions, IntPtr)

Registers an object for being observed externally (using NSString keyPath).   Observed changes are dispatched to the observer’s object ObserveValue(NSString, NSObject, NSDictionary, IntPtr) method.

(Inherited from NSObject)
AddObserver(NSObject, String, NSKeyValueObservingOptions, IntPtr) AddObserver(NSObject, String, NSKeyValueObservingOptions, IntPtr)

Registers an object for being observed externally (using string keyPath).   Observed changes are dispatched to the observer’s object ObserveValue(NSString, NSObject, NSDictionary, IntPtr) method.

(Inherited from NSObject)
AddObserver(NSString, NSKeyValueObservingOptions, Action<NSObservedChange>) AddObserver(NSString, NSKeyValueObservingOptions, Action<NSObservedChange>)

Registers an object for being observed externally using an arbitrary method.

(Inherited from NSObject)
AddObserver(String, NSKeyValueObservingOptions, Action<NSObservedChange>) AddObserver(String, NSKeyValueObservingOptions, Action<NSObservedChange>)

Registers an object for being observed externally using an arbitrary method.

(Inherited from NSObject)
AwakeFromNib() AwakeFromNib()

Called after the object has been loaded from the nib file. Overriders must call base.AwakeFromNib().

(Inherited from NSObject)
BeginInvokeOnMainThread(Action) BeginInvokeOnMainThread(Action) Inherited from NSObject
BeginInvokeOnMainThread(Selector, NSObject) BeginInvokeOnMainThread(Selector, NSObject)

Invokes asynchrously the specified code on the main UI thread.

(Inherited from NSObject)
Bind(NSString, NSObject, String, NSDictionary) Bind(NSString, NSObject, String, NSDictionary) Inherited from NSObject
Bind(String, NSObject, String, NSDictionary) Bind(String, NSObject, String, NSDictionary) Inherited from NSObject
BindingInfo(String) BindingInfo(String) Inherited from NSObject
BindingOptionDescriptions(String) BindingOptionDescriptions(String) Inherited from NSObject
BindingValueClass(String) BindingValueClass(String) Inherited from NSObject
CommitEditing() CommitEditing() Inherited from NSObject
CommitEditing(NSObject, Selector, IntPtr) CommitEditing(NSObject, Selector, IntPtr) Inherited from NSObject
ConformsToProtocol(IntPtr) ConformsToProtocol(IntPtr)

Invoked to determine if this object implements the specified protocol.

(Inherited from NSObject)
Copy() Copy()

Performs a copy of the underlying Objective-C object.

(Inherited from NSObject)
CreateBidirectionalStream(NSNetService) CreateBidirectionalStream(NSNetService)
CreateBidirectionalStream(String, nint) CreateBidirectionalStream(String, nint)
CreateDataTask(NSUrl) CreateDataTask(NSUrl)

Creates an HTTP request based on the specified url.

CreateDataTask(NSUrl, NSUrlSessionResponse) CreateDataTask(NSUrl, NSUrlSessionResponse)
CreateDataTask(NSUrlRequest) CreateDataTask(NSUrlRequest)
CreateDataTask(NSUrlRequest, NSUrlSessionResponse) CreateDataTask(NSUrlRequest, NSUrlSessionResponse)
CreateDataTaskAsync(NSUrl) CreateDataTaskAsync(NSUrl)
CreateDataTaskAsync(NSUrl, NSUrlSessionDataTask) CreateDataTaskAsync(NSUrl, NSUrlSessionDataTask)
CreateDataTaskAsync(NSUrlRequest) CreateDataTaskAsync(NSUrlRequest)
CreateDataTaskAsync(NSUrlRequest, NSUrlSessionDataTask) CreateDataTaskAsync(NSUrlRequest, NSUrlSessionDataTask)
CreateDownloadTask(NSData) CreateDownloadTask(NSData)

Creates a download task for a previously canceled or failed download.

CreateDownloadTask(NSUrl) CreateDownloadTask(NSUrl)
CreateDownloadTask(NSUrl, NSUrlDownloadSessionResponse) CreateDownloadTask(NSUrl, NSUrlDownloadSessionResponse)
CreateDownloadTask(NSUrlRequest) CreateDownloadTask(NSUrlRequest)
CreateDownloadTask(NSUrlRequest, NSUrlDownloadSessionResponse) CreateDownloadTask(NSUrlRequest, NSUrlDownloadSessionResponse)
CreateDownloadTaskAsync(NSUrl) CreateDownloadTaskAsync(NSUrl)
CreateDownloadTaskAsync(NSUrl, NSUrlSessionDownloadTask) CreateDownloadTaskAsync(NSUrl, NSUrlSessionDownloadTask)

Downloads a url resource asynchronously to a temporary file.

CreateDownloadTaskAsync(NSUrlRequest) CreateDownloadTaskAsync(NSUrlRequest)
CreateDownloadTaskAsync(NSUrlRequest, NSUrlSessionDownloadTask) CreateDownloadTaskAsync(NSUrlRequest, NSUrlSessionDownloadTask)

Downloads a url resource asynchronously to a temporary file.

CreateDownloadTaskFromResumeData(NSData, NSUrlDownloadSessionResponse) CreateDownloadTaskFromResumeData(NSData, NSUrlDownloadSessionResponse)
CreateDownloadTaskFromResumeDataAsync(NSData) CreateDownloadTaskFromResumeDataAsync(NSData)
CreateDownloadTaskFromResumeDataAsync(NSData, NSUrlSessionDownloadTask) CreateDownloadTaskFromResumeDataAsync(NSData, NSUrlSessionDownloadTask)
CreateUploadTask(NSUrlRequest) CreateUploadTask(NSUrlRequest)

Creates an upload task.

CreateUploadTask(NSUrlRequest, NSData) CreateUploadTask(NSUrlRequest, NSData)
CreateUploadTask(NSUrlRequest, NSData, NSUrlSessionResponse) CreateUploadTask(NSUrlRequest, NSData, NSUrlSessionResponse)
CreateUploadTask(NSUrlRequest, NSUrl) CreateUploadTask(NSUrlRequest, NSUrl)
CreateUploadTask(NSUrlRequest, NSUrl, NSUrlSessionResponse) CreateUploadTask(NSUrlRequest, NSUrl, NSUrlSessionResponse)
CreateUploadTaskAsync(NSUrlRequest, NSData) CreateUploadTaskAsync(NSUrlRequest, NSData)
CreateUploadTaskAsync(NSUrlRequest, NSData, NSUrlSessionUploadTask) CreateUploadTaskAsync(NSUrlRequest, NSData, NSUrlSessionUploadTask)
CreateUploadTaskAsync(NSUrlRequest, NSUrl) CreateUploadTaskAsync(NSUrlRequest, NSUrl)
CreateUploadTaskAsync(NSUrlRequest, NSUrl, NSUrlSessionUploadTask) CreateUploadTaskAsync(NSUrlRequest, NSUrl, NSUrlSessionUploadTask)
DangerousAutorelease() DangerousAutorelease() Inherited from NSObject
DangerousRelease() DangerousRelease() Inherited from NSObject
DangerousRetain() DangerousRetain() Inherited from NSObject
DidChange(NSKeyValueChange, NSIndexSet, NSString) DidChange(NSKeyValueChange, NSIndexSet, NSString)

Indicates a change occurred to the indexes for a to-many relationship.

(Inherited from NSObject)
DidChange(NSString, NSKeyValueSetMutationKind, NSSet) DidChange(NSString, NSKeyValueSetMutationKind, NSSet) Inherited from NSObject
DidChangeValue(String) DidChangeValue(String)

Indicates that a change occurred on the specified key.

(Inherited from NSObject)
Dispose() Dispose()

Releases the resources used by the NSObject object.

(Inherited from NSObject)
Dispose(Boolean) Dispose(Boolean)

Releases the resources used by the NSObject object.

(Inherited from NSObject)
DoesNotRecognizeSelector(Selector) DoesNotRecognizeSelector(Selector)

Indicates that this object does not recognize the specified selector.

(Inherited from NSObject)
Equals(NSObject) Equals(NSObject) Inherited from NSObject
Equals(Object) Equals(Object) Inherited from NSObject
ExposedBindings() ExposedBindings() Inherited from NSObject
FinishTasksAndInvalidate() FinishTasksAndInvalidate()

Invalidates the object after allowing any outstanding tasks to finish.

Flush(Action) Flush(Action)
FlushAsync() FlushAsync()
FromConfiguration(NSUrlSessionConfiguration) FromConfiguration(NSUrlSessionConfiguration)

Factory method to create an NSUrlSession from the specified configuration.

FromConfiguration(NSUrlSessionConfiguration, INSUrlSessionDelegate, NSOperationQueue) FromConfiguration(NSUrlSessionConfiguration, INSUrlSessionDelegate, NSOperationQueue)
FromConfiguration(NSUrlSessionConfiguration, NSUrlSessionDelegate, NSOperationQueue) FromConfiguration(NSUrlSessionConfiguration, NSUrlSessionDelegate, NSOperationQueue)
FromWeakConfiguration(NSUrlSessionConfiguration, NSObject, NSOperationQueue) FromWeakConfiguration(NSUrlSessionConfiguration, NSObject, NSOperationQueue)
GetAllTasks(NSUrlSessionAllPendingTasks) GetAllTasks(NSUrlSessionAllPendingTasks)
GetAllTasksAsync() GetAllTasksAsync()
GetBindingInfo(NSString) GetBindingInfo(NSString) Inherited from NSObject
GetBindingOptionDescriptions(NSString) GetBindingOptionDescriptions(NSString) Inherited from NSObject
GetBindingValueClass(NSString) GetBindingValueClass(NSString) Inherited from NSObject
GetDictionaryOfValuesFromKeys(NSString[]) GetDictionaryOfValuesFromKeys(NSString[])

Retrieves the values of the specified keys.

(Inherited from NSObject)
GetHashCode() GetHashCode()

Generates a hash code for the current instance.

(Inherited from NSObject)
GetMethodForSelector(Selector) GetMethodForSelector(Selector) Inherited from NSObject
GetNativeField(String) GetNativeField(String) Inherited from NSObject
GetNativeHash() GetNativeHash() Inherited from NSObject
GetTasks(NSUrlSessionPendingTasks) GetTasks(NSUrlSessionPendingTasks)

Requests the groups of pending tasks (data, upload and downloads).

GetTasks2(NSUrlSessionPendingTasks2) GetTasks2(NSUrlSessionPendingTasks2)
GetTasks2Async() GetTasks2Async()

Requests the groups of pending tasks (data, upload and downloads).

GetTasksAsync() GetTasksAsync()

Requests the groups of pending tasks (data, upload and downloads).

Init() Init() Inherited from NSObject
InitializeHandle(IntPtr) InitializeHandle(IntPtr) Inherited from NSObject
InitializeHandle(IntPtr, String) InitializeHandle(IntPtr, String) Inherited from NSObject
InvalidateAndCancel() InvalidateAndCancel()

Cancels all outstanding tasks and invalidates the session object.

Invoke(Action, Double) Invoke(Action, Double) Inherited from NSObject
Invoke(Action, TimeSpan) Invoke(Action, TimeSpan) Inherited from NSObject
InvokeOnMainThread(Action) InvokeOnMainThread(Action) Inherited from NSObject
InvokeOnMainThread(Selector, NSObject) InvokeOnMainThread(Selector, NSObject)

Invokes synchrously the specified code on the main UI thread.

(Inherited from NSObject)
IsEqual(NSObject) IsEqual(NSObject) Inherited from NSObject
IsKindOfClass(Class) IsKindOfClass(Class) Inherited from NSObject
IsMemberOfClass(Class) IsMemberOfClass(Class) Inherited from NSObject
MarkDirty() MarkDirty()

Promotes a regular peer object (IsDirectBinding is true) into a toggleref object.

(Inherited from NSObject)
MutableCopy() MutableCopy()

Creates a mutable copy of the specified NSObject.

(Inherited from NSObject)
ObjectDidEndEditing(NSObject) ObjectDidEndEditing(NSObject) Inherited from NSObject
ObserveValue(NSString, NSObject, NSDictionary, IntPtr) ObserveValue(NSString, NSObject, NSDictionary, IntPtr)

Indicates that the value at the specified keyPath relative to this object has changed.

(Inherited from NSObject)
PerformSelector(Selector) PerformSelector(Selector) Inherited from NSObject
PerformSelector(Selector, NSObject) PerformSelector(Selector, NSObject) Inherited from NSObject
PerformSelector(Selector, NSObject, Double) PerformSelector(Selector, NSObject, Double)

Invokes the selector on the current instance and if the obj is not null, it passes this as its single parameter.

(Inherited from NSObject)
PerformSelector(Selector, NSObject, Double, NSString[]) PerformSelector(Selector, NSObject, Double, NSString[]) Inherited from NSObject
PerformSelector(Selector, NSObject, NSObject) PerformSelector(Selector, NSObject, NSObject) Inherited from NSObject
PerformSelector(Selector, NSThread, NSObject, Boolean) PerformSelector(Selector, NSThread, NSObject, Boolean) Inherited from NSObject
PerformSelector(Selector, NSThread, NSObject, Boolean, NSString[]) PerformSelector(Selector, NSThread, NSObject, Boolean, NSString[]) Inherited from NSObject
PrepareForInterfaceBuilder() PrepareForInterfaceBuilder() Inherited from NSObject
RemoveObserver(NSObject, NSString) RemoveObserver(NSObject, NSString)

Stops the specified observer from receiving further notifications of changed values for the specified keyPath.

(Inherited from NSObject)
RemoveObserver(NSObject, NSString, IntPtr) RemoveObserver(NSObject, NSString, IntPtr)

Stops the specified observer from receiving further notifications of changed values for the specified keyPath and context.

(Inherited from NSObject)
RemoveObserver(NSObject, String) RemoveObserver(NSObject, String)

Stops the specified observer from receiving further notifications of changed values for the specified keyPath.

(Inherited from NSObject)
RemoveObserver(NSObject, String, IntPtr) RemoveObserver(NSObject, String, IntPtr)

Stops the specified observer from receiving further notifications of changed values for the specified keyPath and context.

(Inherited from NSObject)
Reset(Action) Reset(Action)
ResetAsync() ResetAsync()
RespondsToSelector(Selector) RespondsToSelector(Selector)

Whether this object recognizes the specified selector.

(Inherited from NSObject)
SetNativeField(String, NSObject) SetNativeField(String, NSObject) Inherited from NSObject
SetNilValueForKey(NSString) SetNilValueForKey(NSString)

Sets the value of the specified key to null.

(Inherited from NSObject)
SetValueForKey(NSObject, NSString) SetValueForKey(NSObject, NSString)

Sets the value of the property specified by the key to the specified value.

(Inherited from NSObject)
SetValueForKeyPath(IntPtr, NSString) SetValueForKeyPath(IntPtr, NSString)

A constructor used when creating managed representations of unmanaged objects; Called by the runtime.

(Inherited from NSObject)
SetValueForKeyPath(NSObject, NSString) SetValueForKeyPath(NSObject, NSString)

Sets the value of a property that can be reached using a keypath.

(Inherited from NSObject)
SetValueForUndefinedKey(NSObject, NSString) SetValueForUndefinedKey(NSObject, NSString)

Indicates an attempt to write a value to an undefined key. If not overridden, raises an NSUndefinedKeyException.

(Inherited from NSObject)
SetValuesForKeysWithDictionary(NSDictionary) SetValuesForKeysWithDictionary(NSDictionary)

Sets the values of this NSObject to those in the specified dictionary.

(Inherited from NSObject)
ToString() ToString()

Returns a string representation of the value of the current instance.

(Inherited from NSObject)
Unbind(NSString) Unbind(NSString) Inherited from NSObject
Unbind(String) Unbind(String) Inherited from NSObject
ValueForKey(NSString) ValueForKey(NSString)

Returns the value of the property associated with the specified key.

(Inherited from NSObject)
ValueForKeyPath(NSString) ValueForKeyPath(NSString)

Returns the value of a property that can be reached using a keypath.

(Inherited from NSObject)
ValueForUndefinedKey(NSString) ValueForUndefinedKey(NSString)

Indicates an attempt to read a value of an undefined key. If not overridden, raises an NSUndefinedKeyException.

(Inherited from NSObject)
WillChange(NSKeyValueChange, NSIndexSet, NSString) WillChange(NSKeyValueChange, NSIndexSet, NSString)

Indicates that the values of the specified indices in the specified key are about to change.

(Inherited from NSObject)
WillChange(NSString, NSKeyValueSetMutationKind, NSSet) WillChange(NSString, NSKeyValueSetMutationKind, NSSet) Inherited from NSObject
WillChangeValue(String) WillChangeValue(String)

Indicates that the value of the specified key is about to change.

(Inherited from NSObject)

Extension Methods

ObjectDidBeginEditing(NSObject, INSEditor) ObjectDidBeginEditing(NSObject, INSEditor)
ObjectDidEndEditing(NSObject, INSEditor) ObjectDidEndEditing(NSObject, INSEditor)
GetValidModes(NSObject, NSFontPanel) GetValidModes(NSObject, NSFontPanel)
ValidateToolbarItem(NSObject, NSToolbarItem) ValidateToolbarItem(NSObject, NSToolbarItem)
GetDebugDescription(INSObjectProtocol) GetDebugDescription(INSObjectProtocol)
AcceptsPreviewPanelControl(NSObject, QLPreviewPanel) AcceptsPreviewPanelControl(NSObject, QLPreviewPanel)
BeginPreviewPanelControl(NSObject, QLPreviewPanel) BeginPreviewPanelControl(NSObject, QLPreviewPanel)
EndPreviewPanelControl(NSObject, QLPreviewPanel) EndPreviewPanelControl(NSObject, QLPreviewPanel)
GetAccessibilityCustomRotors(NSObject) GetAccessibilityCustomRotors(NSObject)

Gets the array of UIAccessibilityCustomRotor objects appropriate for this object.

SetAccessibilityCustomRotors(NSObject, UIAccessibilityCustomRotor[]) SetAccessibilityCustomRotors(NSObject, UIAccessibilityCustomRotor[])

Sets the array of UIAccessibilityCustomRotor objects appropriate for this object.

Applies to

See also