# Print output for @column tags ?>
public
static
final
class
RangingRequest.Builder
extends Object
java.lang.Object | |
↳ | android.net.wifi.rtt.RangingRequest.Builder |
Builder class used to construct RangingRequest
objects.
Public constructors | |
---|---|
Builder()
|
Public methods | |
---|---|
RangingRequest.Builder
|
addAccessPoint(ScanResult apInfo)
Add the device specified by the |
RangingRequest.Builder
|
addAccessPoints(List<ScanResult> apInfos)
Add the devices specified by the |
RangingRequest.Builder
|
addWifiAwarePeer(MacAddress peerMacAddress)
Add the device specified by the |
RangingRequest.Builder
|
addWifiAwarePeer(PeerHandle peerHandle)
Add a device specified by a |
RangingRequest
|
build()
Build |
Inherited methods | |
---|---|
public Builder ()
public RangingRequest.Builder addAccessPoint (ScanResult apInfo)
Add the device specified by the ScanResult
to the list of devices with
which to measure range. The total number of peers added to a request cannot exceed the
limit specified by RangingRequest.getMaxPeers()
.
Ranging may not be supported if the Access Point does not support IEEE 802.11mc. Use
ScanResult#is80211mcResponder()
to verify the Access Point's capabilities. If
not supported the result status will be
RangingResult#STATUS_RESPONDER_DOES_NOT_SUPPORT_IEEE80211MC
.
Parameters | |
---|---|
apInfo |
ScanResult : Information of an Access Point (AP) obtained in a Scan Result.
This value cannot be null . |
Returns | |
---|---|
RangingRequest.Builder |
The builder to facilitate chaining
builder.setXXX(..).setXXX(..) . |
public RangingRequest.Builder addAccessPoints (List<ScanResult> apInfos)
Add the devices specified by the ScanResult
s to the list of devices with
which to measure range. The total number of peers added to a request cannot exceed the
limit specified by RangingRequest.getMaxPeers()
.
Ranging may not be supported if the Access Point does not support IEEE 802.11mc. Use
ScanResult#is80211mcResponder()
to verify the Access Point's capabilities. If
not supported the result status will be
RangingResult#STATUS_RESPONDER_DOES_NOT_SUPPORT_IEEE80211MC
.
Parameters | |
---|---|
apInfos |
List : Information of an Access Points (APs) obtained in a Scan Result.
This value cannot be null . |
Returns | |
---|---|
RangingRequest.Builder |
The builder to facilitate chaining
builder.setXXX(..).setXXX(..) . |
public RangingRequest.Builder addWifiAwarePeer (MacAddress peerMacAddress)
Add the device specified by the peerMacAddress
to the list of devices with
which to measure range.
The MAC address may be obtained out-of-band from a peer Wi-Fi Aware device. A Wi-Fi
Aware device may obtain its MAC address using the IdentityChangedListener
provided to
WifiAwareManager#attach(AttachCallback, IdentityChangedListener, Handler)
.
Note: in order to use this API the device must support Wi-Fi Aware
android.net.wifi.aware
. The peer device which is being ranged to must be
configured to publish a service (with any name) with:
PublishConfig.PUBLISH_TYPE_UNSOLICITED
.
PublishConfig.Builder.setRangingEnabled(boolean)
.
Parameters | |
---|---|
peerMacAddress |
MacAddress : The MAC address of the Wi-Fi Aware peer.
This value cannot be null . |
Returns | |
---|---|
RangingRequest.Builder |
The builder, to facilitate chaining builder.setXXX(..).setXXX(..) . |
public RangingRequest.Builder addWifiAwarePeer (PeerHandle peerHandle)
Add a device specified by a PeerHandle
to the list of devices with which to
measure range.
The PeerHandle
may be obtained as part of the Wi-Fi Aware discovery process. E.g.
using DiscoverySessionCallback#onServiceDiscovered(PeerHandle, byte[], List)
.
Note: in order to use this API the device must support Wi-Fi Aware
android.net.wifi.aware
. The peer device which is being ranged to must be
configured to publish a service (with any name) with:
PublishConfig.PUBLISH_TYPE_UNSOLICITED
.
PublishConfig.Builder.setRangingEnabled(boolean)
.
Parameters | |
---|---|
peerHandle |
PeerHandle : The peer handler of the peer Wi-Fi Aware device.
This value cannot be null . |
Returns | |
---|---|
RangingRequest.Builder |
The builder, to facilitate chaining builder.setXXX(..).setXXX(..) . |
public RangingRequest build ()
Build RangingRequest
given the current configurations made on the
builder.
Returns | |
---|---|
RangingRequest |