DataNotificationConfig

Kotlin |Java

public final class DataNotificationConfig
extends Object implements Parcelable

java.lang.Object
↳	android.ranging.DataNotificationConfig

Represents the configuration for data notifications in ranging operations.

This class holds the configuration settings for how notifications are sent regarding the proximity of ranging devices.

Summary

Nested classes
`class`	`DataNotificationConfig.Builder` Builder for `DataNotificationConfig`

Constants
`int`	`NOTIFICATION_CONFIG_DISABLE`
`int`	`NOTIFICATION_CONFIG_ENABLE`
`int`	`NOTIFICATION_CONFIG_PROXIMITY_EDGE`
`int`	`NOTIFICATION_CONFIG_PROXIMITY_LEVEL`

Inherited constants

From interface android.os.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(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<DataNotificationConfig>`	`CREATOR`

Public methods
`int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`int`	`getNotificationConfigType()` Returns the configured notification configuration type.
`int`	`getProximityFarCm()` Returns the far proximity threshold in centimeters.
`int`	`getProximityNearCm()` Returns the near proximity threshold in centimeters.
`String`	`toString()` Returns a string representation of the object.
`void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

Inherited methods

From class


        
          java.lang.Object

`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.

From interface


        
          android.os.Parcelable

`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.

Constants

NOTIFICATION_CONFIG_DISABLE

Added in Android Baklava

public static final int NOTIFICATION_CONFIG_DISABLE

Constant Value: 0 (0x00000000)

NOTIFICATION_CONFIG_ENABLE

Added in Android Baklava

public static final int NOTIFICATION_CONFIG_ENABLE

Constant Value: 1 (0x00000001)

NOTIFICATION_CONFIG_PROXIMITY_EDGE

Added in Android Baklava

public static final int NOTIFICATION_CONFIG_PROXIMITY_EDGE

Constant Value: 3 (0x00000003)

NOTIFICATION_CONFIG_PROXIMITY_LEVEL

Added in Android Baklava

public static final int NOTIFICATION_CONFIG_PROXIMITY_LEVEL

Constant Value: 2 (0x00000002)

Fields

CREATOR

Added in Android Baklava

public static final Creator<DataNotificationConfig> CREATOR

Public methods

describeContents

Added in Android Baklava

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`

getNotificationConfigType

Added in Android Baklava

public int getNotificationConfigType ()

Returns the configured notification configuration type.

Returns
`int`	the notification configuration type. Value is `NOTIFICATION_CONFIG_DISABLE`, `NOTIFICATION_CONFIG_ENABLE`, `NOTIFICATION_CONFIG_PROXIMITY_LEVEL`, or `NOTIFICATION_CONFIG_PROXIMITY_EDGE`

getProximityFarCm

Added in Android Baklava

public int getProximityFarCm ()

Returns the far proximity threshold in centimeters.

Returns
`int`	the far proximity in centimeters. Value is between 0 and 20000 inclusive

getProximityNearCm

Added in Android Baklava

public int getProximityNearCm ()

Returns the near proximity threshold in centimeters.

Returns
`int`	the near proximity in centimeters. Value is between 0 and 20000 inclusive

toString

Added in Android Baklava

public String toString ()

Returns a string representation of the object.

Returns
`String`	a string representation of the object.

writeToParcel

Added in Android Baklava

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

DataNotificationConfig

Summary

Nested classes

Constants

Inherited constants

Fields

Public methods

Inherited methods

Constants

NOTIFICATION_CONFIG_DISABLE

NOTIFICATION_CONFIG_ENABLE

NOTIFICATION_CONFIG_PROXIMITY_EDGE

NOTIFICATION_CONFIG_PROXIMITY_LEVEL

Fields

CREATOR

Public methods

describeContents

getNotificationConfigType

getProximityFarCm

getProximityNearCm

toString

writeToParcel