Monkeybread Xojo plugin - NSURLRequestMBS class

Platforms to show: All Mac Windows Linux Cross-Platform

NSURLRequestMBS class

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
class	Cocoa Networking	MBS MacBase Plugin	7.2	✅ Yes	❌ No	❌ No	✅ Yes	All

Function: An NSURLRequest object represents a URL load request in a manner independent of protocol and URL scheme.
Example:

msgbox HTMLViewer1.mainFrameMBS.DataSource.Request.url

Notes:
NSURLRequest encapsulates two basic data elements about a URL load request:

The URL to load.
The policy to use when consulting the URL content cache made available by the implementation.

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
- const NSURLRequestReloadIgnoringCacheData = 1
- const NSURLRequestReloadIgnoringLocalAndRemoteCacheData = 4
- const NSURLRequestReloadRevalidatingCacheData = 5
- const NSURLRequestReturnCacheDataDontLoad = 3
- const NSURLRequestReturnCacheDataElseLoad = 2
- const NSURLRequestUseProtocolCachePolicy = 0

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. The service type is used to provide the networking layers a hint of the purpose of the request.
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.