Builder

Builder

Builder()

Default constructor for Builder.

Builder

Builder(request: NetworkRequest)

Creates a new Builder of NetworkRequest from an existing instance.

addCapability

open fun addCapability(capability: Int): NetworkRequest.Builder!

Add the given capability requirement to this builder. These represent the requested network's required capabilities. Note that when searching for a network to satisfy a request, all capabilities requested must be satisfied.

addTransportType

open fun addTransportType(transportType: Int): NetworkRequest.Builder!

Adds the given transport requirement to this builder. These represent the set of allowed transports for the request. Only networks using one of these transports will satisfy the request. If no particular transports are required, none should be specified here.

build

open fun build(): NetworkRequest!

Build NetworkRequest give the current set of capabilities.

clearCapabilities

open fun clearCapabilities(): NetworkRequest.Builder

Completely clears all the NetworkCapabilities from this builder instance, removing even the capabilities that are set by default when the object is constructed. Also removes any set forbidden capabilities.

removeCapability

open fun removeCapability(capability: Int): NetworkRequest.Builder!

Removes (if found) the given capability from this builder instance.

removeTransportType

open fun removeTransportType(transportType: Int): NetworkRequest.Builder!

Removes (if found) the given transport from this builder instance.

setIncludeOtherUidNetworks

open fun setIncludeOtherUidNetworks(include: Boolean): NetworkRequest.Builder

Specifies whether the built request should also match networks that do not apply to the calling UID. By default, the built request will only match networks that apply to the calling UID. If this method is called with true, the built request will match any network on the system that matches the other parameters of the request. In this case, any information in the built request that is subject to redaction for security or privacy purposes, such as a NetworkSpecifier, will be redacted or removed to prevent the application deducing sensitive information.

setNetworkSpecifier

open fun setNetworkSpecifier(networkSpecifier: NetworkSpecifier!): NetworkRequest.Builder!

Sets the optional bearer specific network specifier. This has no meaning if a single transport is also not specified, so calling this without a single transport set will generate an exception, as will subsequently adding or removing transports after this is set.

setNetworkSpecifier

open fun setNetworkSpecifier(networkSpecifier: String!): NetworkRequest.Builder!

Deprecated: Use setNetworkSpecifier(android.net.NetworkSpecifier) instead.

Sets the optional bearer specific network specifier. This has no meaning if a single transport is also not specified, so calling this without a single transport set will generate an exception, as will subsequently adding or removing transports after this is set.

• If the specifier can be parsed as an integer, it will be treated as a TelephonyNetworkSpecifier, and the provided integer will be interpreted as a SubscriptionId.
• If the value is an ethernet interface name, it will be treated as such.
• For all other cases, the behavior is undefined.

setSubscriptionIds

open fun setSubscriptionIds(subIds: MutableSet<Int!>): NetworkRequest.Builder

Sets the optional subscription ID set.

This specify the subscription IDs requirement. A network will satisfy this request only if it matches one of the subIds in this set. An empty set matches all networks, including those without a subId.

Registering a NetworkRequest with a non-empty set of subIds requires the NETWORK_FACTORY permission.