FMLiveSwitchProxy Class Reference

Proxy utility methods. More...

Instance Methods

(instancetype) - init
 

Class Methods

(FMLiveSwitchFuture< FMLiveSwitchProxyAuthCheckResult * > *) + authCheckWithUrl:
 Checks if proxy authentication is required to access a given URL. More...
 
(NSString *) + exportCredentials
 Exports the credentials to JSON. More...
 
(FMLiveSwitchProxyCredentials *) + getCredentialsWithProxyIPAddress:
 Gets the proxy credentials for the given proxy IP address. More...
 
(void) + importCredentialsWithCredentialsJson:
 Imports credentials from JSON. More...
 
(FMLiveSwitchProxy *) + proxy
 
(void) + setCredentialsWithProxyIPAddress:proxyCredentials:
 Sets the proxy credentials for the given proxy IP address. More...
 
(void) + setCredentialsWithProxyIPAddresses:proxyCredentials:
 Sets the proxy credentials for the given proxy IP addresss. More...
 

Detailed Description

Proxy utility methods.

Method Documentation

◆ authCheckWithUrl:

+ (FMLiveSwitchFuture<FMLiveSwitchProxyAuthCheckResult*>*) authCheckWithUrl: (NSString *)  url

Checks if proxy authentication is required to access a given URL.

Parameters
urlThe URL.

◆ exportCredentials

+ (NSString*) exportCredentials

Exports the credentials to JSON.

Returns
The credentials in JSON format.

◆ getCredentialsWithProxyIPAddress:

+ (FMLiveSwitchProxyCredentials*) getCredentialsWithProxyIPAddress: (NSString *)  proxyIPAddress

Gets the proxy credentials for the given proxy IP address.

Parameters
proxyIPAddressThe proxy IP address.
Returns
The proxy credentials, if they exist, or null.

◆ importCredentialsWithCredentialsJson:

+ (void) importCredentialsWithCredentialsJson: (NSString *)  credentialsJson

Imports credentials from JSON.

Parameters
credentialsJsonThe credentials in JSON format.

◆ init

- (instancetype) init

◆ proxy

+ (FMLiveSwitchProxy*) proxy

◆ setCredentialsWithProxyIPAddress:proxyCredentials:

+ (void) setCredentialsWithProxyIPAddress: (NSString *)  proxyIPAddress
proxyCredentials: (FMLiveSwitchProxyCredentials *)  proxyCredentials 

Sets the proxy credentials for the given proxy IP address.

Parameters
proxyIPAddressThe proxy IP address.
proxyCredentialsThe proxy credentials.

◆ setCredentialsWithProxyIPAddresses:proxyCredentials:

+ (void) setCredentialsWithProxyIPAddresses: (NSMutableArray *)  proxyIPAddresses
proxyCredentials: (FMLiveSwitchProxyCredentials *)  proxyCredentials 

Sets the proxy credentials for the given proxy IP addresss.

Parameters
proxyIPAddressesThe proxy IP addresses.
proxyCredentialsThe proxy credentials.