DiscoveryRequest
public
final
class
DiscoveryRequest
extends Object
implements
Parcelable
| java.lang.Object | |
| ↳ | android.net.nsd.DiscoveryRequest |
Encapsulates parameters for NsdManager.discoverServices.
Summary
Nested classes | |
|---|---|
class |
DiscoveryRequest.Builder
The builder for creating new |
Constants | |
|---|---|
long |
FLAG_NO_PICKER
Indicates that a UI service picker should never be shown to the user for this request. |
long |
FLAG_SHOW_PICKER
Indicates that a UI service picker must be shown to the user for this request. |
long |
FLAG_USER_APPROVED_ONLY
Indicates that only services previously approved by the user must be discovered. |
Inherited constants |
|---|
Fields | |
|---|---|
public
static
final
Creator<DiscoveryRequest> |
CREATOR
|
Public methods | |
|---|---|
int
|
describeContents()
Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
boolean
|
equals(Object other)
Indicates whether some other object is "equal to" this one. |
Map<String, PatternMatcher>
|
getAttributeFilters()
Returns the filters to apply to attributes as per |
String
|
getDisplayNameAttribute()
Return the attribute to use to display the service in system UI service picker. |
long
|
getFlags()
Returns the discovery flags. |
Network
|
getNetwork()
Returns the |
PatternMatcher
|
getServiceNameFilter()
Returns the filter to apply to service names as per |
String
|
getServiceType()
Returns the service type in format of dot-joint string of two labels. |
String
|
getSubtype()
Returns the subtype without the trailing "._sub" label or |
int
|
hashCode()
Returns a hash code value for the object. |
String
|
toString()
Returns a string representation of the object. |
void
|
writeToParcel(Parcel dest, int flags)
Flatten this object in to a Parcel. |
Inherited methods | |
|---|---|
Constants
FLAG_NO_PICKER
public static final long FLAG_NO_PICKER
Indicates that a UI service picker should never be shown to the user for this request.
Starting from target SDK Build.VERSION_CODES.CINNAMON_BUN, if the
caller does not have the Manifest.permission.ACCESS_LOCAL_NETWORK
permission and does not specify FLAG_USER_APPROVED_ONLY, this will cause the request
to fail with
android.net.nsd.NsdManager.DiscoveryListener.onStartDiscoveryFailed(String,int) and
NsdManager.FAILURE_PERMISSION_DENIED.
If neither FLAG_NO_PICKER nor FLAG_SHOW_PICKER is set, the picker will
be shown if the app does not have Manifest.permission.ACCESS_LOCAL_NETWORK
permission.
Value is either 0 or a combination of the following:
FLAG_NO_PICKERFLAG_SHOW_PICKERFLAG_USER_APPROVED_ONLY
Constant Value: 1 (0x0000000000000001)
FLAG_SHOW_PICKER
public static final long FLAG_SHOW_PICKER
Indicates that a UI service picker must be shown to the user for this request.
If this flag is set, the user will be prompted to choose a service to be discovered among
all services matching the discovery service type and discovery filters.
android.net.nsd.NsdManager.DiscoveryListener.onServiceFound(NsdServiceInfo) will be
called at most once, and discovery will stop if a service is selected or the user cancels
the request. Manifest.permission.ACCESS_LOCAL_NETWORK permission is *not*
necessary when discovering with this flag.
Once a service has been selected by the user in the UI picker,
NsdManager.resolveService(NsdServiceInfo,java.util.concurrent.Executor,NsdManager.ResolveListener) or NsdManager.registerServiceInfoCallback(NsdServiceInfo,Executor,NsdManager.ServiceInfoCallback) can be called for that service without requiring
the Manifest.permission.ACCESS_LOCAL_NETWORK permission or any further UI
being displayed.
If neither FLAG_NO_PICKER nor FLAG_SHOW_PICKER is set, the picker will
be shown if the app does not have Manifest.permission.ACCESS_LOCAL_NETWORK
permission.
This flag cannot be combined with FLAG_NO_PICKER or
FLAG_USER_APPROVED_ONLY.
Value is either 0 or a combination of the following:
FLAG_NO_PICKERFLAG_SHOW_PICKERFLAG_USER_APPROVED_ONLY
Constant Value: 2 (0x0000000000000002)
FLAG_USER_APPROVED_ONLY
public static final long FLAG_USER_APPROVED_ONLY
Indicates that only services previously approved by the user must be discovered.
If this flag is set, only services that have been selected by the user in previous
requests that used the service picker UI will be discovered.
Manifest.permission.ACCESS_LOCAL_NETWORK permission is *not* necessary when
discovering with this flag.
This flag implies FLAG_NO_PICKER, and it cannot be combined with
FLAG_SHOW_PICKER.
Value is either 0 or a combination of the following:
FLAG_NO_PICKERFLAG_SHOW_PICKERFLAG_USER_APPROVED_ONLY
See also:
Constant Value: 4 (0x0000000000000004)
Fields
CREATOR
public static final Creator<DiscoveryRequest> CREATOR
Public methods
describeContents
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(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
|
equals
public boolean equals (Object other)
Indicates whether some other object is "equal to" this one.
The equals method implements an equivalence relation
on non-null object references:
- It is reflexive: for any non-null reference value
x,x.equals(x)should returntrue. - It is symmetric: for any non-null reference values
xandy,x.equals(y)should returntrueif and only ify.equals(x)returnstrue. - It is transitive: for any non-null reference values
x,y, andz, ifx.equals(y)returnstrueandy.equals(z)returnstrue, thenx.equals(z)should returntrue. - It is consistent: for any non-null reference values
xandy, multiple invocations ofx.equals(y)consistently returntrueor consistently returnfalse, provided no information used inequalscomparisons on the objects is modified. - For any non-null reference value
x,x.equals(null)should returnfalse.
An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.
| Parameters | |
|---|---|
other |
Object: the reference object with which to compare. |
| Returns | |
|---|---|
boolean |
true if this object is the same as the obj
argument; false otherwise. |
getAttributeFilters
public Map<String, PatternMatcher> getAttributeFilters ()
Returns the filters to apply to attributes as per NsdServiceInfo.getAttributes().
| Returns | |
|---|---|
Map<String, PatternMatcher> |
This value cannot be null. |
getDisplayNameAttribute
public String getDisplayNameAttribute ()
Return the attribute to use to display the service in system UI service picker.
Attributes are as per NsdServiceInfo.getAttributes().
If null, the service name as per NsdServiceInfo.getServiceName() is used.
| Returns | |
|---|---|
String |
|
See also:
getFlags
public long getFlags ()
Returns the discovery flags.
| Returns | |
|---|---|
long |
Value is either 0 or a combination of the following:
|
getNetwork
public Network getNetwork ()
Returns the Network on which the query should be sent or null if no
network is specified.
| Returns | |
|---|---|
Network |
|
getServiceNameFilter
public PatternMatcher getServiceNameFilter ()
Returns the filter to apply to service names as per NsdServiceInfo.getServiceName().
As per RFC6335 5.1., service names must be only US-ASCII letters, digits and hyphens, and matching is not case-sensitive.
If null, services are not filtered by name.
| Returns | |
|---|---|
PatternMatcher |
|
getServiceType
public String getServiceType ()
Returns the service type in format of dot-joint string of two labels. For example, "_ipp._tcp" for internet printer and "_matter._tcp" for Matter operational device.
| Returns | |
|---|---|
String |
This value cannot be null. |
getSubtype
public String getSubtype ()
Returns the subtype without the trailing "._sub" label or null if no subtype is
specified.
For example, the return value will be "_printer" for subtype "_printer._sub".
| Returns | |
|---|---|
String |
|
hashCode
public int hashCode ()
Returns a hash code value for the object. This method is
supported for the benefit of hash tables such as those provided by
HashMap.
The general contract of hashCode is:
- Whenever it is invoked on the same object more than once during
an execution of a Java application, the
hashCodemethod must consistently return the same integer, provided no information used inequalscomparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. - If two objects are equal according to the
equalsmethod, then calling thehashCodemethod on each of the two objects must produce the same integer result. - It is not required that if two objects are unequal
according to the
equalsmethod, then calling thehashCodemethod on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
| Returns | |
|---|---|
int |
a hash code value for this object. |
toString
public String toString ()
Returns a string representation of the object.
| Returns | |
|---|---|
String |
a string representation of the object. |
writeToParcel
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 the following:
|
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2026-02-26 UTC.