Platforms to show: All Mac Windows Linux Cross-Platform
NSMutableURLRequestMBS class
Super class: NSURLRequestMBS
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
class | Cocoa | MBS MacBase Plugin | 9.6 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
NSMutableURLRequest is a subclass of NSURLRequest provided to aid developers who may find it more convenient to mutate a single request object for a series of URL load requests instead of creating an immutable NSURLRequest for each load.
This programming model is supported by the following contract between NSMutableURLRequest and NSURLConnection: NSURLConnection makes a deep copy of each NSMutableURLRequest object passed to one of its initializers.
Subclass of the NSURLRequestMBS class.
- 15 methods
- method addValue(value as string, field as string)
- method Constructor(url as string)
- method Constructor(url as string, cachePolicy as Integer, timeoutInterval as Double)
- method setAllHTTPHeaderFields(headerFields as Dictionary)
- method setAttribution(Attribution as Integer)
- method setCachePolicy(policy as Integer)
- method setHTTPBody(data as MemoryBlock)
- method setHTTPMethod(HTTPMethod as string)
- method setHTTPShouldHandleCookies(should as boolean)
- method setHTTPShouldUsePipelining(shouldUsePipelining as boolean)
- method setMainDocumentURL(url as string)
- method setNetworkServiceType(networkServiceType as Integer)
- method setTimeoutInterval(seconds as Double)
- method setURL(url as string)
- method setValue(value as string, field as string)
Super class NSURLRequestMBS
- 12 properties
- property attribution as Integer
- property cachePolicy as Integer
- property Handle as Integer
- property HTTPBody as memoryblock
- property HTTPMethod as string
- property HTTPShouldHandleCookies as boolean
- property HTTPShouldUsePipelining as boolean
- property isHTTPRequest as boolean
- property mainDocumentURL as string
- property networkServiceType as Integer
- property timeoutInterval as Double
- property URL as string
- 6 methods
- method allHTTPHeaderFields as Dictionary
- method Constructor(url as string)
- method Constructor(url as string, cachePolicy as Integer, timeoutInterval as Double)
- method copy as NSURLRequestMBS
- method mutableCopy as NSMutableURLRequestMBS
- method valueForHTTPHeaderField(field as string) as string
- 3 shared methods
- shared method requestWithHandle(Handle as Integer) as NSURLRequestMBS
- shared method requestWithURL(url as string) as NSURLRequestMBS
- shared method requestWithURL(url as string, cachePolicy as Integer, timeoutInterval as Double) as NSURLRequestMBS
- 13 constants
Constants
Constant | Value | Description |
---|---|---|
NSURLRequestReloadIgnoringCacheData | 1 | A constant that can be used to specify the type of interactions that take place with the caching system when the URL loading system processes a request. Specifically, these constants cover interactions that have to do with whether already-existing cache data is returned to satisfy a URL load request. more |
NSURLRequestReloadIgnoringLocalAndRemoteCacheData | 4 | A constant that can be used to specify the type of interactions that take place with the caching system when the URL loading system processes a request. Specifies that not only should the local cache data be ignored, but that proxies and other intermediates should be instructed to disregard their caches so far as the protocol allows. more |
NSURLRequestReloadRevalidatingCacheData | 5 |
A constant that can be used to specify the type of interactions that take place with the caching system when the URL loading system processes a request.
Specifies that the existing cache data may be used provided the origin source confirms its validity, otherwise the URL is loaded from the origin source. Available in Mac OS X v10.5 and later. |
NSURLRequestReturnCacheDataDontLoad | 3 | A constant that can be used to specify the type of interactions that take place with the caching system when the URL loading system processes a request. Specifically, these constants cover interactions that have to do with whether already-existing cache data is returned to satisfy a URL load request. more |
NSURLRequestReturnCacheDataElseLoad | 2 | A constant that can be used to specify the type of interactions that take place with the caching system when the URL loading system processes a request. Specifically, these constants cover interactions that have to do with whether already-existing cache data is returned to satisfy a URL load request. more |
NSURLRequestUseProtocolCachePolicy | 0 | A constant that can be used to specify the type of interactions that take place with the caching system when the URL loading system processes a request. Specifically, these constants cover interactions that have to do with whether already-existing cache data is returned to satisfy a URL load request. more |
Network Service Type Constants
Constant | Value | Description |
---|---|---|
NSURLNetworkServiceTypeBackground | 3 |
Specifies that the request is for background traffic (such as a file download). The service type is used to provide the networking layers a hint of the purpose of the request. |
NSURLNetworkServiceTypeDefault | 0 | Is the default value for an NSURLRequest when created. This value should be left unchanged for the vast majority of requests. more |
NSURLNetworkServiceTypeVideo | 2 |
Specifies that the request is for video traffic. The service type is used to provide the networking layers a hint of the purpose of the request. |
NSURLNetworkServiceTypeVoice | 4 |
Specifies that the request is for voice data. The service type is used to provide the networking layers a hint of the purpose of the request. |
NSURLNetworkServiceTypeVoIP | 1 |
Specifies that the request is for voice over IP control traffic. The service type is used to provide the networking layers a hint of the purpose of the request. |
Attribution
Constant | Value | Description |
---|---|---|
NSURLRequestAttributionDeveloper | 0 |
Indicates that the URL was specified by the developer. This is the default value for an NSURLRequest when created. |
NSURLRequestAttributionUser | 1 |
Indicates that the URL was specified by the user. |
This class has no sub classes.
Some methods using this class:
- NSURLRequestMBS.mutableCopy as NSMutableURLRequestMBS
Some examples using this class:
Blog Entries
- Notes from the last days
- MBS Real Studio Plugins, version 11.3pr6
- Nearly 2000 new Functions in the 9.6 prerelease of MBS
Xojo Developer Magazine
The items on this page are in the following plugins: MBS MacBase Plugin.
NSMutableParagraphStyleMBS - NSNetServiceBrowserMBS