# Print output for @column tags ?>
public
class
NetworkInfo
extends Object
implements
Parcelable
java.lang.Object | |
↳ | android.net.NetworkInfo |
This class is deprecated.
Callers should instead use the ConnectivityManager.NetworkCallback
API to
learn about connectivity changes, or switch to use
ConnectivityManager#getNetworkCapabilities
or
ConnectivityManager#getLinkProperties
to get information synchronously. Keep
in mind that while callbacks are guaranteed to be called for every event in order,
synchronous calls have no such constraints, and as such it is unadvisable to use the
synchronous methods inside the callbacks as they will often not offer a view of
networking that is consistent (that is: they may return a past or a future state with
respect to the event being processed by the callback). Instead, callers are advised
to only use the arguments of the callbacks, possibly memorizing the specific bits of
information they need to keep from one callback to another.
Describes the status of a network interface.
Use ConnectivityManager#getActiveNetworkInfo()
to get an instance that represents
the current network connection.
Nested classes | |
---|---|
enum |
NetworkInfo.DetailedState
This enum is deprecated.
See |
enum |
NetworkInfo.State
This enum is deprecated.
See |
Inherited constants |
---|
Fields | |
---|---|
public
static
final
Creator<NetworkInfo> |
CREATOR
|
Public constructors | |
---|---|
NetworkInfo(int type, int subtype, String typeName, String subtypeName)
Create a new instance of NetworkInfo. |
Public methods | |
---|---|
int
|
describeContents()
Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
NetworkInfo.DetailedState
|
getDetailedState()
This method is deprecated.
Apps should instead use the
|
String
|
getExtraInfo()
This method is deprecated. Use other services e.g. WifiManager to get additional information passed up from the lower networking layers. |
String
|
getReason()
This method is deprecated. This method does not have a consistent contract that could make it useful to callers. |
NetworkInfo.State
|
getState()
This method is deprecated.
Apps should instead use the
|
int
|
getSubtype()
This method is deprecated.
Use |
String
|
getSubtypeName()
This method is deprecated.
Use |
int
|
getType()
This method is deprecated.
Callers should switch to checking |
String
|
getTypeName()
This method is deprecated.
Callers should switch to checking |
boolean
|
isAvailable()
This method is deprecated.
Apps should instead use the
|
boolean
|
isConnected()
This method is deprecated.
Apps should instead use the
|
boolean
|
isConnectedOrConnecting()
This method is deprecated.
Apps should instead use the
|
boolean
|
isFailover()
This method is deprecated. This field is not populated in recent Android releases, and does not make a lot of sense in a multi-network world. |
boolean
|
isRoaming()
This method is deprecated.
Callers should switch to checking
|
void
|
setDetailedState(NetworkInfo.DetailedState detailedState, String reason, String extraInfo)
This method is deprecated.
Use |
String
|
toString()
Returns a string representation of the object. |
void
|
writeToParcel(Parcel dest, int flags)
Flatten this object in to a Parcel. |
Inherited methods | |
---|---|
public NetworkInfo (int type, int subtype, String typeName, String subtypeName)
Create a new instance of NetworkInfo. This may be useful for apps to write unit tests.
public int describeContents ()
Describe the kinds of special objects contained in this Parcelable
instance's marshaled representation. For example, if the object will
include a file descriptor in the output of writeToParcel(android.os.Parcel, int)
,
the return value of this method must include the
CONTENTS_FILE_DESCRIPTOR
bit.
Returns | |
---|---|
int |
a bitmask indicating the set of special object types marshaled
by this Parcelable object instance.
Value is either 0 or CONTENTS_FILE_DESCRIPTOR |
public NetworkInfo.DetailedState getDetailedState ()
This method is deprecated.
Apps should instead use the
ConnectivityManager.NetworkCallback
API to
learn about connectivity changes. See
ConnectivityManager#registerDefaultNetworkCallback
and
ConnectivityManager#registerNetworkCallback
. These will
give a more accurate picture of the connectivity state of
the device and let apps react more easily and quickly to changes.
Reports the current fine-grained state of the network.
Returns | |
---|---|
NetworkInfo.DetailedState |
the fine-grained state
This value cannot be null . |
public String getExtraInfo ()
This method is deprecated.
Use other services e.g. WifiManager to get additional information passed up from
the lower networking layers.
Report the extra information about the network state, if any was provided by the lower networking layers.
Returns | |
---|---|
String |
the extra information, or null if not available |
public String getReason ()
This method is deprecated.
This method does not have a consistent contract that could make it useful
to callers.
Report the reason an attempt to establish connectivity failed, if one is available.
Returns | |
---|---|
String |
the reason for failure, or null if not available |
public NetworkInfo.State getState ()
This method is deprecated.
Apps should instead use the
ConnectivityManager.NetworkCallback
API to
learn about connectivity changes.
ConnectivityManager#registerDefaultNetworkCallback
and
ConnectivityManager#registerNetworkCallback
. These will
give a more accurate picture of the connectivity state of
the device and let apps react more easily and quickly to changes.
Reports the current coarse-grained state of the network.
Returns | |
---|---|
NetworkInfo.State |
the coarse-grained state |
public int getSubtype ()
This method is deprecated.
Use TelephonyManager.getDataNetworkType()
instead.
Return a network-type-specific integer describing the subtype of the network.
Returns | |
---|---|
int |
the network subtype |
public String getSubtypeName ()
This method is deprecated.
Use TelephonyManager.getDataNetworkType()
instead.
Return a human-readable name describing the subtype of the network.
Returns | |
---|---|
String |
the name of the network subtype |
public int getType ()
This method is deprecated.
Callers should switch to checking NetworkCapabilities#hasTransport
instead with one of the NetworkCapabilities#TRANSPORT_* constants :
getType()
and getTypeName()
cannot account for networks using
multiple transports. Note that generally apps should not care about transport;
NetworkCapabilities#NET_CAPABILITY_NOT_METERED
and
NetworkCapabilities#getLinkDownstreamBandwidthKbps
are calls that
apps concerned with meteredness or bandwidth should be looking at, as they
offer this information with much better accuracy.
Reports the type of network to which the
info in this NetworkInfo
pertains.
Returns | |
---|---|
int |
one of ConnectivityManager#TYPE_MOBILE , ConnectivityManager#TYPE_WIFI , ConnectivityManager#TYPE_WIMAX , ConnectivityManager#TYPE_ETHERNET , ConnectivityManager#TYPE_BLUETOOTH , or other
types defined by ConnectivityManager . |
public String getTypeName ()
This method is deprecated.
Callers should switch to checking NetworkCapabilities#hasTransport
instead with one of the NetworkCapabilities#TRANSPORT_* constants :
getType()
and getTypeName()
cannot account for networks using
multiple transports. Note that generally apps should not care about transport;
NetworkCapabilities#NET_CAPABILITY_NOT_METERED
and
NetworkCapabilities#getLinkDownstreamBandwidthKbps
are calls that
apps concerned with meteredness or bandwidth should be looking at, as they
offer this information with much better accuracy.
Return a human-readable name describe the type of the network, for example "WIFI" or "MOBILE".
Returns | |
---|---|
String |
the name of the network type |
public boolean isAvailable ()
This method is deprecated.
Apps should instead use the
ConnectivityManager.NetworkCallback
API to
learn about connectivity changes.
ConnectivityManager#registerDefaultNetworkCallback
and
ConnectivityManager#registerNetworkCallback
. These will
give a more accurate picture of the connectivity state of
the device and let apps react more easily and quickly to changes.
Indicates whether network connectivity is possible. A network is unavailable when a persistent or semi-persistent condition prevents the possibility of connecting to that network. Examples include
true
, because the system only
returns info for available networks.
Returns | |
---|---|
boolean |
true if the network is available, false otherwise |
public boolean isConnected ()
This method is deprecated.
Apps should instead use the
ConnectivityManager.NetworkCallback
API to
learn about connectivity changes. See
ConnectivityManager#registerDefaultNetworkCallback
and
ConnectivityManager#registerNetworkCallback
. These will
give a more accurate picture of the connectivity state of
the device and let apps react more easily and quickly to changes.
Indicates whether network connectivity exists and it is possible to establish connections and pass data.
Always call this before attempting to perform data transactions.
Returns | |
---|---|
boolean |
true if network connectivity exists, false otherwise. |
public boolean isConnectedOrConnecting ()
This method is deprecated.
Apps should instead use the
ConnectivityManager.NetworkCallback
API to
learn about connectivity changes.
ConnectivityManager#registerDefaultNetworkCallback
and
ConnectivityManager#registerNetworkCallback
. These will
give a more accurate picture of the connectivity state of
the device and let apps react more easily and quickly to changes.
Indicates whether network connectivity exists or is in the process
of being established. This is good for applications that need to
do anything related to the network other than read or write data.
For the latter, call isConnected()
instead, which guarantees
that the network is fully usable.
Returns | |
---|---|
boolean |
true if network connectivity exists or is in the process
of being established, false otherwise. |
public boolean isFailover ()
This method is deprecated.
This field is not populated in recent Android releases,
and does not make a lot of sense in a multi-network world.
Indicates whether the current attempt to connect to the network resulted from the ConnectivityManager trying to fail over to this network following a disconnect from another network.
Returns | |
---|---|
boolean |
true if this is a failover attempt, false
otherwise. |
public boolean isRoaming ()
This method is deprecated.
Callers should switch to checking
NetworkCapabilities#NET_CAPABILITY_NOT_ROAMING
instead, since that handles more complex situations, such as
VPNs.
Indicates whether the device is currently roaming on this network. When
true
, it suggests that use of data on this network may incur
extra costs.
Returns | |
---|---|
boolean |
true if roaming is in effect, false otherwise. |
public void setDetailedState (NetworkInfo.DetailedState detailedState, String reason, String extraInfo)
This method is deprecated.
Use NetworkCapabilities
instead.
Sets the fine-grained state of the network. This is only useful for testing.
Parameters | |
---|---|
detailedState |
NetworkInfo.DetailedState : the DetailedState .
This value cannot be null . |
reason |
String : a String indicating the reason for the state change,
if one was supplied. May be null .
This value may be null . |
extraInfo |
String : an optional String providing addditional network state
information passed up from the lower networking layers.
This value may be null . |
public String toString ()
Returns a string representation of the object. In general, the
toString
method returns a string that
"textually represents" this object. The result should
be a concise but informative representation that is easy for a
person to read.
It is recommended that all subclasses override this method.
The toString
method for class Object
returns a string consisting of the name of the class of which the
object is an instance, the at-sign character `@
', and
the unsigned hexadecimal representation of the hash code of the
object. In other words, this method returns a string equal to the
value of:
getClass().getName() + '@' + Integer.toHexString(hashCode())
Returns | |
---|---|
String |
a string representation of the object. |
public void writeToParcel (Parcel dest, int flags)
Flatten this object in to a Parcel.
Parameters | |
---|---|
dest |
Parcel : The Parcel in which the object should be written. |
flags |
int : Additional flags about how the object should be written.
May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE .
Value is either 0 or a combination of Parcelable.PARCELABLE_WRITE_RETURN_VALUE , and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES |