Package apple.foundation

Class NSURLSessionConfiguration

  • All Implemented Interfaces:
    NSCopying, NSObject
    public class NSURLSessionConfiguration
extends NSObject
implements NSCopying
    Configuration options for an NSURLSession. When a session is created, a copy of the configuration object is made - you cannot modify the configuration of a session after it has been created. The shared session uses the global singleton credential, cache and cookie storage objects. An ephemeral session has no persistent disk storage for cookies, cache or credentials. A background session can be used to perform networking operations on behalf of a suspended application, within certain constraints. API-Since: 7.0

    • Constructor Detail

      • NSURLSessionConfiguration

        protected NSURLSessionConfiguration​(org.moe.natj.general.Pointer peer)

    • Method Detail

      • accessInstanceVariablesDirectly

        public static boolean accessInstanceVariablesDirectly()

      • automaticallyNotifiesObserversForKey

        public static boolean automaticallyNotifiesObserversForKey​(@NotNull
                                                           @NotNull java.lang.String key)

      • backgroundSessionConfiguration

        @NotNull
@Deprecated
public static @NotNull NSURLSessionConfiguration backgroundSessionConfiguration​(@NotNull
                                                                                @NotNull java.lang.String identifier)
        Deprecated.
        API-Since: 7.0 Deprecated-Since: 8.0

      • backgroundSessionConfigurationWithIdentifier

        @NotNull
public static @NotNull NSURLSessionConfiguration backgroundSessionConfigurationWithIdentifier​(@NotNull
                                                                                              @NotNull java.lang.String identifier)
        API-Since: 8.0

      • cancelPreviousPerformRequestsWithTarget

        public static void cancelPreviousPerformRequestsWithTarget​(@NotNull
                                                           @NotNull java.lang.Object aTarget)

      • cancelPreviousPerformRequestsWithTargetSelectorObject

        public static void cancelPreviousPerformRequestsWithTargetSelectorObject​(@NotNull
                                                                         @NotNull java.lang.Object aTarget,
                                                                         @NotNull
                                                                         @NotNull org.moe.natj.objc.SEL aSelector,
                                                                         @Nullable
                                                                         @Nullable java.lang.Object anArgument)

      • classFallbacksForKeyedArchiver

        @NotNull
public static @NotNull NSArray<java.lang.String> classFallbacksForKeyedArchiver()

      • classForKeyedUnarchiver

        @NotNull
public static @NotNull org.moe.natj.objc.Class classForKeyedUnarchiver()

      • debugDescription_static

        public static java.lang.String debugDescription_static()

      • description_static

        public static java.lang.String description_static()

      • hash_static

        public static long hash_static()

      • instanceMethodSignatureForSelector

        public static NSMethodSignature instanceMethodSignatureForSelector​(org.moe.natj.objc.SEL aSelector)

      • instancesRespondToSelector

        public static boolean instancesRespondToSelector​(org.moe.natj.objc.SEL aSelector)

      • isSubclassOfClass

        public static boolean isSubclassOfClass​(org.moe.natj.objc.Class aClass)

      • keyPathsForValuesAffectingValueForKey

        @NotNull
public static @NotNull NSSet<java.lang.String> keyPathsForValuesAffectingValueForKey​(@NotNull
                                                                                     @NotNull java.lang.String key)

      • new_objc

        @Deprecated
public static NSURLSessionConfiguration new_objc()
        Deprecated.
        API-Since: 7.0 Deprecated-Since: 13.0 Deprecated-Message: Please use NSURLSessionConfiguration.defaultSessionConfiguration or other class methods to create instances

      • resolveClassMethod

        public static boolean resolveClassMethod​(org.moe.natj.objc.SEL sel)

      • resolveInstanceMethod

        public static boolean resolveInstanceMethod​(org.moe.natj.objc.SEL sel)

      • setVersion_static

        public static void setVersion_static​(long aVersion)

      • superclass_static

        public static org.moe.natj.objc.Class superclass_static()

      • version_static

        public static long version_static()

      • HTTPAdditionalHeaders

        @Nullable
public @Nullable NSDictionary<?,​?> HTTPAdditionalHeaders()
        Specifies additional headers which will be set on outgoing requests. Note that these headers are added to the request only if not already present.

      • HTTPCookieAcceptPolicy

        public long HTTPCookieAcceptPolicy()
        Policy for accepting cookies. This overrides the policy otherwise specified by the cookie storage.

      • HTTPCookieStorage

        @Nullable
public @Nullable NSHTTPCookieStorage HTTPCookieStorage()
        The cookie storage object to use, or nil to indicate that no cookies should be handled

      • HTTPMaximumConnectionsPerHost

        public long HTTPMaximumConnectionsPerHost()
        The maximum number of simultaneous persistent connections per host

      • HTTPShouldSetCookies

        public boolean HTTPShouldSetCookies()
        Allow the session to set cookies on requests

      • HTTPShouldUsePipelining

        public boolean HTTPShouldUsePipelining()
        Allow the use of HTTP pipelining

      • TLSMaximumSupportedProtocol

        @Deprecated
public int TLSMaximumSupportedProtocol()
        Deprecated.
        The maximum allowable versions of the TLS protocol, from API-Since: 7.0 Deprecated-Since: 100000.0

      • TLSMinimumSupportedProtocol

        @Deprecated
public int TLSMinimumSupportedProtocol()
        Deprecated.
        The minimum allowable versions of the TLS protocol, from API-Since: 7.0 Deprecated-Since: 100000.0

      • URLCache

        @Nullable
public @Nullable NSURLCache URLCache()
        The URL resource cache, or nil to indicate that no caching is to be performed

      • URLCredentialStorage

        @Nullable
public @Nullable NSURLCredentialStorage URLCredentialStorage()
        The credential storage object, or nil to indicate that no credential storage is to be used

      • allowsCellularAccess

        public boolean allowsCellularAccess()
        allow request to route over cellular.

      • connectionProxyDictionary

        @Nullable
public @Nullable NSDictionary<?,​?> connectionProxyDictionary()
        The proxy dictionary, as described by

      • copyWithZone

        @NotNull
public @NotNull java.lang.Object copyWithZone​(@Nullable
                                              @Nullable org.moe.natj.general.ptr.VoidPtr zone)
        Specified by:
        copyWithZone in interface NSCopying

      • identifier

        @Nullable
public @Nullable java.lang.String identifier()
        identifier for the background session configuration

      • init

        @Deprecated
public NSURLSessionConfiguration init()
        Deprecated.
        API-Since: 7.0 Deprecated-Since: 13.0 Deprecated-Message: Please use NSURLSessionConfiguration.defaultSessionConfiguration or other class methods to create instances
        Overrides:
        init in class NSObject

      • isDiscretionary

        public boolean isDiscretionary()
        allows background tasks to be scheduled at the discretion of the system for optimal performance. API-Since: 7.0

      • setDiscretionary

        public void setDiscretionary​(boolean value)
        allows background tasks to be scheduled at the discretion of the system for optimal performance. API-Since: 7.0

      • networkServiceType

        public long networkServiceType()
        type of service for requests.

      • protocolClasses

        @Nullable
public @Nullable NSArray<? extends org.moe.natj.objc.Class> protocolClasses()
        An optional array of Class objects which subclass NSURLProtocol. The Class will be sent +canInitWithRequest: when determining if an instance of the class can be used for a given URL scheme. You should not use +[NSURLProtocol registerClass:], as that method will register your class with the default session rather than with an instance of NSURLSession. Custom NSURLProtocol subclasses are not available to background sessions.

      • requestCachePolicy

        public long requestCachePolicy()
        default cache policy for requests

      • sessionSendsLaunchEvents

        public boolean sessionSendsLaunchEvents()
        Allows the app to be resumed or launched in the background when tasks in background sessions complete or when auth is required. This only applies to configurations created with +backgroundSessionConfigurationWithIdentifier: and the default value is YES. NOTE: macOS apps based on AppKit do not support background launch. API-Since: 7.0

      • setAllowsCellularAccess

        public void setAllowsCellularAccess​(boolean value)
        allow request to route over cellular.

      • setConnectionProxyDictionary

        public void setConnectionProxyDictionary​(@Nullable
                                         @Nullable NSDictionary<?,​?> value)
        The proxy dictionary, as described by

      • setHTTPAdditionalHeaders

        public void setHTTPAdditionalHeaders​(@Nullable
                                     @Nullable NSDictionary<?,​?> value)
        Specifies additional headers which will be set on outgoing requests. Note that these headers are added to the request only if not already present.

      • setHTTPCookieAcceptPolicy

        public void setHTTPCookieAcceptPolicy​(long value)
        Policy for accepting cookies. This overrides the policy otherwise specified by the cookie storage.

      • setHTTPCookieStorage

        public void setHTTPCookieStorage​(@Nullable
                                 @Nullable NSHTTPCookieStorage value)
        The cookie storage object to use, or nil to indicate that no cookies should be handled

      • setHTTPMaximumConnectionsPerHost

        public void setHTTPMaximumConnectionsPerHost​(long value)
        The maximum number of simultaneous persistent connections per host

      • setHTTPShouldSetCookies

        public void setHTTPShouldSetCookies​(boolean value)
        Allow the session to set cookies on requests

      • setHTTPShouldUsePipelining

        public void setHTTPShouldUsePipelining​(boolean value)
        Allow the use of HTTP pipelining

      • setNetworkServiceType

        public void setNetworkServiceType​(long value)
        type of service for requests.

      • setProtocolClasses

        public void setProtocolClasses​(@Nullable
                               @Nullable NSArray<? extends org.moe.natj.objc.Class> value)
        An optional array of Class objects which subclass NSURLProtocol. The Class will be sent +canInitWithRequest: when determining if an instance of the class can be used for a given URL scheme. You should not use +[NSURLProtocol registerClass:], as that method will register your class with the default session rather than with an instance of NSURLSession. Custom NSURLProtocol subclasses are not available to background sessions.

      • setRequestCachePolicy

        public void setRequestCachePolicy​(long value)
        default cache policy for requests

      • setSessionSendsLaunchEvents

        public void setSessionSendsLaunchEvents​(boolean value)
        Allows the app to be resumed or launched in the background when tasks in background sessions complete or when auth is required. This only applies to configurations created with +backgroundSessionConfigurationWithIdentifier: and the default value is YES. NOTE: macOS apps based on AppKit do not support background launch. API-Since: 7.0

      • setSharedContainerIdentifier

        public void setSharedContainerIdentifier​(@Nullable
                                         @Nullable java.lang.String value)
        The identifier of the shared data container into which files in background sessions should be downloaded. App extensions wishing to use background sessions *must* set this property to a valid container identifier, or all transfers in that session will fail with NSURLErrorBackgroundSessionRequiresSharedContainer. API-Since: 8.0

      • setShouldUseExtendedBackgroundIdleMode

        public void setShouldUseExtendedBackgroundIdleMode​(boolean value)
        Enable extended background idle mode for any tcp sockets created. Enabling this mode asks the system to keep the socket open and delay reclaiming it when the process moves to the background (see https://developer.apple.com/library/ios/technotes/tn2277/_index.html) API-Since: 9.0

      • setTLSMaximumSupportedProtocol

        @Deprecated
public void setTLSMaximumSupportedProtocol​(int value)
        Deprecated.
        The maximum allowable versions of the TLS protocol, from API-Since: 7.0 Deprecated-Since: 100000.0

      • setTLSMinimumSupportedProtocol

        @Deprecated
public void setTLSMinimumSupportedProtocol​(int value)
        Deprecated.
        The minimum allowable versions of the TLS protocol, from API-Since: 7.0 Deprecated-Since: 100000.0

      • setTimeoutIntervalForRequest

        public void setTimeoutIntervalForRequest​(double value)
        default timeout for requests. This will cause a timeout if no data is transmitted for the given timeout value, and is reset whenever data is transmitted.

      • setTimeoutIntervalForResource

        public void setTimeoutIntervalForResource​(double value)
        default timeout for requests. This will cause a timeout if a resource is not able to be retrieved within a given timeout.

      • setURLCache

        public void setURLCache​(@Nullable
                        @Nullable NSURLCache value)
        The URL resource cache, or nil to indicate that no caching is to be performed

      • setURLCredentialStorage

        public void setURLCredentialStorage​(@Nullable
                                    @Nullable NSURLCredentialStorage value)
        The credential storage object, or nil to indicate that no credential storage is to be used

      • sharedContainerIdentifier

        @Nullable
public @Nullable java.lang.String sharedContainerIdentifier()
        The identifier of the shared data container into which files in background sessions should be downloaded. App extensions wishing to use background sessions *must* set this property to a valid container identifier, or all transfers in that session will fail with NSURLErrorBackgroundSessionRequiresSharedContainer. API-Since: 8.0

      • shouldUseExtendedBackgroundIdleMode

        public boolean shouldUseExtendedBackgroundIdleMode()
        Enable extended background idle mode for any tcp sockets created. Enabling this mode asks the system to keep the socket open and delay reclaiming it when the process moves to the background (see https://developer.apple.com/library/ios/technotes/tn2277/_index.html) API-Since: 9.0

      • timeoutIntervalForRequest

        public double timeoutIntervalForRequest()
        default timeout for requests. This will cause a timeout if no data is transmitted for the given timeout value, and is reset whenever data is transmitted.

      • timeoutIntervalForResource

        public double timeoutIntervalForResource()
        default timeout for requests. This will cause a timeout if a resource is not able to be retrieved within a given timeout.

      • multipathServiceType

        public long multipathServiceType()
        multipath service type to use for connections. The default is NSURLSessionMultipathServiceTypeNone API-Since: 11.0

      • setMultipathServiceType

        public void setMultipathServiceType​(long value)
        multipath service type to use for connections. The default is NSURLSessionMultipathServiceTypeNone API-Since: 11.0

      • setWaitsForConnectivity

        public void setWaitsForConnectivity​(boolean value)
        Causes tasks to wait for network connectivity to become available, rather than immediately failing with an error (such as NSURLErrorNotConnectedToInternet) when it is not. When waiting for connectivity, the timeoutIntervalForRequest property does not apply, but the timeoutIntervalForResource property does. Unsatisfactory connectivity (that requires waiting) includes cases where the device has limited or insufficient connectivity for a task (e.g., only has a cellular connection but the allowsCellularAccess property is NO, or requires a VPN connection in order to reach the desired host). Default value is NO. Ignored by background sessions, as background sessions always wait for connectivity. API-Since: 11.0

      • waitsForConnectivity

        public boolean waitsForConnectivity()
        Causes tasks to wait for network connectivity to become available, rather than immediately failing with an error (such as NSURLErrorNotConnectedToInternet) when it is not. When waiting for connectivity, the timeoutIntervalForRequest property does not apply, but the timeoutIntervalForResource property does. Unsatisfactory connectivity (that requires waiting) includes cases where the device has limited or insufficient connectivity for a task (e.g., only has a cellular connection but the allowsCellularAccess property is NO, or requires a VPN connection in order to reach the desired host). Default value is NO. Ignored by background sessions, as background sessions always wait for connectivity. API-Since: 11.0

      • TLSMaximumSupportedProtocolVersion

        public short TLSMaximumSupportedProtocolVersion()
        The maximum allowable versions of the TLS protocol, from API-Since: 13.0

      • TLSMinimumSupportedProtocolVersion

        public short TLSMinimumSupportedProtocolVersion()
        The minimum allowable versions of the TLS protocol, from API-Since: 13.0

      • allowsConstrainedNetworkAccess

        public boolean allowsConstrainedNetworkAccess()
        allow request to route over networks in constrained mode. Defaults to YES. API-Since: 13.0

      • allowsExpensiveNetworkAccess

        public boolean allowsExpensiveNetworkAccess()
        allow request to route over expensive networks. Defaults to YES. API-Since: 13.0

      • setAllowsConstrainedNetworkAccess

        public void setAllowsConstrainedNetworkAccess​(boolean value)
        allow request to route over networks in constrained mode. Defaults to YES. API-Since: 13.0

      • setAllowsExpensiveNetworkAccess

        public void setAllowsExpensiveNetworkAccess​(boolean value)
        allow request to route over expensive networks. Defaults to YES. API-Since: 13.0

      • setTLSMaximumSupportedProtocolVersion

        public void setTLSMaximumSupportedProtocolVersion​(short value)
        The maximum allowable versions of the TLS protocol, from API-Since: 13.0

      • setTLSMinimumSupportedProtocolVersion

        public void setTLSMinimumSupportedProtocolVersion​(short value)
        The minimum allowable versions of the TLS protocol, from API-Since: 13.0

      • requiresDNSSECValidation

        public boolean requiresDNSSECValidation()
        requires requests from the session to be made with DNSSEC validation enabled. Defaults to NO. API-Since: 16.0

      • setRequiresDNSSECValidation

        public void setRequiresDNSSECValidation​(boolean value)
        requires requests from the session to be made with DNSSEC validation enabled. Defaults to NO. API-Since: 16.0

      • useStoredAccessor

        @Deprecated
public static boolean useStoredAccessor()
        Deprecated.