ProxyInfo

Kotlin |Java

open class ProxyInfo : Parcelable

kotlin.Any
↳	android.net.ProxyInfo

Describes a proxy configuration. Proxy configurations are already integrated within the java.net and Apache HTTP stack. So URLConnection and Apache's HttpClient will use them automatically. Other HTTP stacks will need to obtain the proxy info by watching for the Proxy#PROXY_CHANGE_ACTION broadcast and calling methods such as android.net.ConnectivityManager#getDefaultProxy.

Summary

Inherited constants

From class Parcelable

Int

CONTENTS_FILE_DESCRIPTOR

Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor.

Int

PARCELABLE_WRITE_RETURN_VALUE

Flag for use with writeToParcel: the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)". Some implementations may want to release resources at this point.

Public constructors
`ProxyInfo(source: ProxyInfo?)` A copy constructor to hold proxy properties.

Public methods
open static ProxyInfo!	`buildDirectProxy(host: String!, port: Int)` Constructs a `ProxyInfo` object that points at a Direct proxy on the specified host and port.
open static ProxyInfo!	`buildDirectProxy(host: String!, port: Int, exclList: MutableList<String!>!)` Constructs a `ProxyInfo` object that points at a Direct proxy on the specified host and port.
open static ProxyInfo!	`buildPacProxy(pacUri: Uri!)` Construct a `ProxyInfo` that will download and run the PAC script at the specified URL.
open static ProxyInfo	`buildPacProxy(pacUrl: Uri, port: Int)` Construct a `ProxyInfo` object that will download and run the PAC script at the specified URL and port.
open Boolean	`equals(other: Any?)` Indicates whether some other object is "equal to" this one.
open Array<String!>!	`getExclusionList()` When configured to use a Direct Proxy this returns the list of hosts for which the proxy is ignored.
open String!	`getHost()` When configured to use a Direct Proxy this returns the host of the proxy.
open Uri!	`getPacFileUrl()` Returns the URL of the current PAC script or null if there is no PAC script.
open Int	`getPort()` When configured to use a Direct Proxy this returns the port of the proxy
open Int	`hashCode()`
open Boolean	`isValid()` Return true if the pattern of proxy is valid, otherwise return false.
open String	`toString()`

Properties
static Parcelable.Creator<ProxyInfo!>	`CREATOR`

Public constructors

ProxyInfo

Added in API level 30

ProxyInfo(source: ProxyInfo?)

A copy constructor to hold proxy properties.

Parameters
`source`	ProxyInfo?: This value may be `null`.

Public methods

buildDirectProxy

Added in API level 21

open static fun buildDirectProxy(
    host: String!, 
    port: Int
): ProxyInfo!

Constructs a ProxyInfo object that points at a Direct proxy on the specified host and port.

buildDirectProxy

Added in API level 21

open static fun buildDirectProxy(
    host: String!, 
    port: Int, 
    exclList: MutableList<String!>!
): ProxyInfo!

Constructs a ProxyInfo object that points at a Direct proxy on the specified host and port. The proxy will not be used to access any host in exclusion list, exclList.

Parameters
`exclList`	MutableList<String!>!: Hosts to exclude using the proxy on connections for. These hosts can use wildcards such as *.example.com.

buildPacProxy

Added in API level 21

open static fun buildPacProxy(pacUri: Uri!): ProxyInfo!

Construct a ProxyInfo that will download and run the PAC script at the specified URL.

buildPacProxy

Added in API level 30

open static fun buildPacProxy(
    pacUrl: Uri, 
    port: Int
): ProxyInfo

Construct a ProxyInfo object that will download and run the PAC script at the specified URL and port.

Parameters
`pacUrl`	Uri: This value cannot be `null`.

Return
`ProxyInfo`	This value cannot be `null`.

equals

Added in API level 21

open fun equals(other: Any?): Boolean

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
`obj`	the reference object with which to compare.
`o`	This value may be `null`.

Return
`Boolean`	`true` if this object is the same as the obj argument; `false` otherwise.

getExclusionList

Added in API level 21

open fun getExclusionList(): Array<String!>!

When configured to use a Direct Proxy this returns the list of hosts for which the proxy is ignored.

getHost

Added in API level 21

open fun getHost(): String!

When configured to use a Direct Proxy this returns the host of the proxy.

getPacFileUrl

Added in API level 21

open fun getPacFileUrl(): Uri!

Returns the URL of the current PAC script or null if there is no PAC script.

getPort

Added in API level 21

open fun getPort(): Int

When configured to use a Direct Proxy this returns the port of the proxy

hashCode

Added in API level 21

open fun hashCode(): Int

Return
`Int`	a hash code value for this object.

isValid

Added in API level 30

open fun isValid(): Boolean

Return true if the pattern of proxy is valid, otherwise return false.

toString

Added in API level 21

open fun toString(): String

Return
`String`	a string representation of the object.

Properties

CREATOR

Added in API level 21

static val CREATOR: Parcelable.Creator<ProxyInfo!>