Add more details in the javadocs for new visibility apis.

- Describe the expected behaviour when calling setVisibilityPublic and
setVisibilityRestricted on {MediaRoute2Info.Builder}.

Bug: 266564463
Test: NA as it's just changes in javadocs.
Change-Id: I2bd699b9cfbb8973770898e54f4db7645af3d99b
This commit is contained in:
Bishoy Gendy
2023-01-24 16:01:19 +00:00
parent adc9ba1add
commit f2508a0413

View File

@@ -1086,8 +1086,16 @@ public final class MediaRoute2Info implements Parcelable {
}
/**
* Sets the visibility of this route to public. This is the default
* visibility for routes that are public to all other apps.
* Sets the visibility of this route to public.
*
* <p>By default, unless you call {@link #setVisibilityRestricted}, the new route will be
* public.
*
* <p>Public routes are visible to any application with a matching {@link
* RouteDiscoveryPreference#getPreferredFeatures feature}.
*
* <p>Calls to this method override previous calls to {@link #setVisibilityPublic} and
* {@link #setVisibilityRestricted}.
*/
@NonNull
public Builder setVisibilityPublic() {
@@ -1097,8 +1105,16 @@ public final class MediaRoute2Info implements Parcelable {
}
/**
* Sets the visibility of this route to restricted. This means that the
* route is only visible to a set of package name.
* Sets the visibility of this route to restricted.
*
* <p>Routes with restricted visibility are only visible to its publisher application and
* applications whose package name is included in the provided {@code allowedPackages} set
* with a matching {@link RouteDiscoveryPreference#getPreferredFeatures feature}.
*
* <p>Calls to this method override previous calls to {@link #setVisibilityPublic} and
* {@link #setVisibilityRestricted}.
*
* @see #setVisibilityPublic
* @param allowedPackages set of package names which are allowed to see this route.
*/
@NonNull