Google is committed to advancing racial equity for Black communities. See how.
Added in API level 1

Proxy

class Proxy
kotlin.Any
   ↳ android.net.Proxy

A convenience class for accessing the user and default proxy settings.

Summary

Constants
static String

Intent extra included with PROXY_CHANGE_ACTION intents.
static String

Used to notify an app that's caching the proxy that either the default connection has changed or any connection's proxy has changed.

Public constructors

Public methods
static String!

Return the default proxy host specified by the carrier.
static Int

Return the default proxy port specified by the carrier.
static String!

Return the proxy host set by the user.
static Int

Return the proxy port set by the user.

Constants

EXTRA_PROXY_INFO

Added in API level 21
Deprecated in API level 23
static val EXTRA_PROXY_INFO: String

Deprecated: Because PROXY_CHANGE_ACTION is sent whenever the proxy for any network on the system changes, applications should always use ConnectivityManager#getDefaultProxy() or ConnectivityManager#getLinkProperties(Network).LinkProperties#getHttpProxy() to get the proxy for the Network(s) they are using.

Intent extra included with PROXY_CHANGE_ACTION intents. It describes the new proxy being used (as a ProxyInfo object).

Value: "android.intent.extra.PROXY_INFO"

PROXY_CHANGE_ACTION

Added in API level 1
static val PROXY_CHANGE_ACTION: String

Used to notify an app that's caching the proxy that either the default connection has changed or any connection's proxy has changed. The new proxy should be queried using ConnectivityManager#getDefaultProxy().

This is a protected intent that can only be sent by the system

Value: "android.intent.action.PROXY_CHANGE"

Public constructors

<init>

Proxy()

Public methods

getDefaultHost

Added in API level 1
Deprecated in API level 15
static fun getDefaultHost(): String!

Deprecated: Use standard java vm proxy values to find the host, port and exclusion list. This call ignores the exclusion list and no longer reports only mobile-data apn-based proxy values.

Return the default proxy host specified by the carrier.

Return
String! String containing the host name or null if there is no proxy for this carrier.

getDefaultPort

Added in API level 1
Deprecated in API level 15
static fun getDefaultPort(): Int

Deprecated: Use standard java vm proxy values to find the host, port and exclusion list. This call ignores the exclusion list and no longer reports only mobile-data apn-based proxy values.

Return the default proxy port specified by the carrier.

Return
Int The port number to be used with the proxy host or -1 if there is no proxy for this carrier.

getHost

Added in API level 1
Deprecated in API level 15
static fun getHost(ctx: Context!): String!

Deprecated: Use standard java vm proxy values to find the host, port and exclusion list. This call ignores the exclusion list.

Return the proxy host set by the user.

Parameters
ctx Context!: A Context used to get the settings for the proxy host.
Return
String! String containing the host name. If the user did not set a host name it returns the default host. A null value means that no host is to be used.

getPort

Added in API level 1
Deprecated in API level 15
static fun getPort(ctx: Context!): Int

Deprecated: Use standard java vm proxy values to find the host, port and exclusion list. This call ignores the exclusion list.

Return the proxy port set by the user.

Parameters
ctx Context!: A Context used to get the settings for the proxy port.
Return
Int The port number to use or -1 if no proxy is to be used.