NfcAntennaInfo


public final class NfcAntennaInfo
extends Object implements Parcelable

java.lang.Object
   ↳ android.nfc.NfcAntennaInfo


Contains information on all available Nfc antennas on an Android device as well as information on the device itself in relation positioning of the antennas.

Summary

Inherited constants

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(Parcel, int): 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)".

Fields

public static final Creator<NfcAntennaInfo> CREATOR

Public constructors

NfcAntennaInfo(int deviceWidth, int deviceHeight, boolean deviceFoldable, List<AvailableNfcAntenna> availableNfcAntennas)

Public methods

int describeContents()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.

List<AvailableNfcAntenna> getAvailableNfcAntennas()

Get all NFC antennas that exist on the device.

int getDeviceHeight()

Height of the device in millimeters.

int getDeviceWidth()

Width of the device in millimeters.

boolean isDeviceFoldable()

Whether the device is foldable.

void writeToParcel(Parcel dest, int flags)

Flatten this object in to a Parcel.

Inherited methods

Object clone()

Creates and returns a copy of this object.

boolean equals(Object obj)

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

void finalize()

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.

final Class<?> getClass()

Returns the runtime class of this Object.

int hashCode()

Returns a hash code value for the object.

final void notify()

Wakes up a single thread that is waiting on this object's monitor.

final void notifyAll()

Wakes up all threads that are waiting on this object's monitor.

String toString()

Returns a string representation of the object.

final void wait(long timeoutMillis, int nanos)

Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

final void wait(long timeoutMillis)

Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

final void wait()

Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

abstract int describeContents()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.

abstract void writeToParcel(Parcel dest, int flags)

Flatten this object in to a Parcel.

Fields

CREATOR

Added in API level 34
public static final Creator<NfcAntennaInfo> CREATOR

Public constructors

NfcAntennaInfo

Added in API level 34
public NfcAntennaInfo (int deviceWidth, 
                int deviceHeight, 
                boolean deviceFoldable, 
                List<AvailableNfcAntenna> availableNfcAntennas)

Parameters
deviceWidth int

deviceHeight int

deviceFoldable boolean

availableNfcAntennas List: This value cannot be null.

Public methods

describeContents

Added in API level 34
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

getAvailableNfcAntennas

Added in API level 34
public List<AvailableNfcAntenna> getAvailableNfcAntennas ()

Get all NFC antennas that exist on the device.

Returns
List<AvailableNfcAntenna> This value cannot be null.

getDeviceHeight

Added in API level 34
public int getDeviceHeight ()

Height of the device in millimeters.

Returns
int

getDeviceWidth

Added in API level 34
public int getDeviceWidth ()

Width of the device in millimeters.

Returns
int

isDeviceFoldable

Added in API level 34
public boolean isDeviceFoldable ()

Whether the device is foldable. When the device is foldable, the 0, 0 is considered to be top-left when the device is unfolded and the screens are facing the user. For non-foldable devices 0, 0 is top-left when the user is facing the screen.

Returns
boolean

writeToParcel

Added in API level 34
public void writeToParcel (Parcel dest, 
                int flags)

Flatten this object in to a Parcel.

Parameters
dest Parcel: This value cannot be null.

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