NetworkProvider: improve documentation of unregisterNetworkOffer

Add a warning to unregisterNetworkOffer to inform users that this method
executes asynchronously.

Test: documentation only change
Change-Id: Ic4742bf570ebcd4d00b0b259c35fd46688494517
This commit is contained in:
Patrick Rohr 2022-07-18 09:08:34 -07:00
commit c886983669

View file

@ -319,6 +319,11 @@ public class NetworkProvider {
* if it could beat any of them, and may be advantageous to the provider's implementation that
* can rely on no longer receiving callbacks for a network that they can't bring up anyways.
*
* Warning: This method executes asynchronously. The NetworkOfferCallback object can continue
* receiving onNetworkNeeded and onNetworkUnneeded callbacks even after this method has
* returned. In this case, it is on the caller to take appropriate steps in order to prevent
* bringing up a network.
*
* @hide
*/
@SystemApi