FRURLProtocol

@objc
open class FRURLProtocol : URLProtocol

extension FRURLProtocol: URLSessionDataDelegate

Public Property


                    
                    
                    tokenManagementPolicy

TokenManagementPolicy for URLProtocol

Declaration

Swift

@objc
public static var tokenManagementPolicy: TokenManagementPolicy?


                    
                    
                    authorizationPolicy

AuthorizationPolicy for URLProtocol

Declaration

Swift

@objc
public static var authorizationPolicy: AuthorizationPolicy?

frSecurityConfiguration
FRSecurityConfiguration for URLProtocol - Used for SSL Pinning
Declaration
Swift

@objc public static var frSecurityConfiguration: FRSecurityConfiguration?

URLProtocol


                    
                    
                    canonicalRequest(for:)

Returns a canonical version of the given request

Declaration

Swift

public override class func canonicalRequest(for request: URLRequest) -> URLRequest

Parameters


                                request

A request to make canonical

Return Value

The canonical form of the given request

Method


                    
                    
                    canInit(with:)

Declaration

Swift

public override class func canInit(with request: URLRequest) -> Bool

startLoading()
Starts loading, and validating the request
Declaration
Swift

public override func startLoading()
stopLoading()
Stops loading, and indicates that the request has finished
Declaration
Swift

public override func stopLoading()


                    
                    
                    urlSession(_:dataTask:didReceive:)

URLSessionDataDelegate method for receiving data

Declaration

Swift

public func urlSession(_ session: URLSession, dataTask: URLSessionDataTask, didReceive data: Data)

Parameters

`session`	URLSession
`dataTask`	Current URLSessionDataTask
`data`	Data received


                    
                    
                    urlSession(_:dataTask:didReceive:completionHandler:)

URLSessionDataDelegate method for receiving response

Declaration

Swift

public func urlSession(_ session: URLSession, dataTask: URLSessionDataTask, didReceive response: URLResponse, completionHandler: @escaping (URLSession.ResponseDisposition) -> Void)

Parameters

`session`	URLSession
`dataTask`	Current URLSessionDataTask
`response`	Response received
`completionHandler`	Completion callback


                    
                    
                    urlSession(_:task:didCompleteWithError:)

URLSessionDataDelegate method to notify completion of the request

In this delegation method, FRURLProtocol will validate the result of the request with given ValidatedURLs, RefreshTokenPolicy, and maximum retry attempt, and perform token refresh if necessary

Declaration

Swift

public func urlSession(_ session: URLSession, task: URLSessionTask, didCompleteWithError error: Error?)

Parameters

`session`	URLSession
`task`	Current URLSessionDataTask
`error`	An error occurred during the request


                    
                    
                    urlSession(_:task:willPerformHTTPRedirection:newRequest:completionHandler:)

URLSessionDataDelegate method for HTTP Redirection

Declaration

Swift

public func urlSession(_ session: URLSession, task: URLSessionTask, willPerformHTTPRedirection response: HTTPURLResponse, newRequest request: URLRequest, completionHandler: @escaping (URLRequest?) -> Void)

Parameters

`session`	URLSession
`task`	Current URLSessionTask
`response`	HTTPURLResponse which may explain reason for redirection
`request`	Newly constructed URLRequest object
`completionHandler`	Completion callback


                    
                    
                    urlSession(_:didBecomeInvalidWithError:)

URLSessionDataDelegate method for invalidating the current request with an error

Declaration

Swift

public func urlSession(_ session: URLSession, didBecomeInvalidWithError error: Error?)

Parameters

`session`	URLSession
`error`	An error occurred during the request


                    
                    
                    urlSession(_:didReceive:completionHandler:)

URLSessionDelegate method for Authentication Challenge

Declaration

Swift

public func urlSession(_ session: URLSession, didReceive challenge: URLAuthenticationChallenge, completionHandler: @escaping (URLSession.AuthChallengeDisposition, URLCredential?) -> Void)

Parameters

`session`	URLSession
`challenge`	URLAuthenticationChallenge
`completionHandler`	Completion callback


                    
                    
                    urlSession(_:task:didReceive:completionHandler:)

URLSessionTaskDelegate method for Authentication Challenge

Declaration

Swift

public func urlSession(_ session: URLSession, task: URLSessionTask, didReceive challenge: URLAuthenticationChallenge, completionHandler: @escaping (URLSession.AuthChallengeDisposition, URLCredential?) -> Void)

Parameters

`session`	URLSession
`task`	URLSessionTask
`challenge`	URLAuthenticationChallenge
`completionHandler`	Completion callback


                    
                    
                    urlSessionDidFinishEvents(forBackgroundURLSession:)

URLSessionDataDelegate method

Declaration

Swift

public func urlSessionDidFinishEvents(forBackgroundURLSession session: URLSession)

Parameters


                                session

URLSession