NetworkOperatorTetheringManager Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
This interface exposes the methods and properties used to control and configure tethering capabilities for a specific network account.
public ref class NetworkOperatorTetheringManager sealed/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class NetworkOperatorTetheringManager final[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class NetworkOperatorTetheringManagerPublic NotInheritable Class NetworkOperatorTetheringManager- Inheritance
- Attributes
Windows requirements
| Device family |
Windows 10 (introduced in 10.0.10240.0 - for Xbox, see UWP features that aren't yet supported on Xbox)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced in v1.0)
|
| App capabilities |
wiFiControl
|
Remarks
Version history
| Windows version | SDK version | Value added |
|---|---|---|
| 1607 | 14393 | CreateFromConnectionProfile(ConnectionProfile,NetworkAdapter) |
| 2004 | 19041 | DisableNoConnectionsTimeout |
| 2004 | 19041 | DisableNoConnectionsTimeoutAsync |
| 2004 | 19041 | EnableNoConnectionsTimeout |
| 2004 | 19041 | EnableNoConnectionsTimeoutAsync |
| 2004 | 19041 | IsNoConnectionsTimeoutEnabled |
Properties
| ClientCount |
Gets the current number of connected clients on the tethering network. |
| MaxClientCount |
Gets the maximum number of client connections over a tethered network. |
| TetheringOperationalState |
Gets the current operational state of the tethering feature. Possible values are defined by TetheringOperationalState |
Methods
| ConfigureAccessPointAsync(NetworkOperatorTetheringAccessPointConfiguration) |
Use this method to provide tethering network configuration details for the tethering network. |
| CreateFromConnectionProfile(ConnectionProfile, NetworkAdapter) |
Creates a NetworkOperatorTetheringManager using the given profile as the public interface, and on the given NetworkAdapter as the private interface. |
| CreateFromConnectionProfile(ConnectionProfile) |
Creates a NetworkOperatorTetheringManager using the given profile as the public interface and Wi-Fi as the private interface. |
| CreateFromNetworkAccountId(String) |
Creates an instance of NetworkOperatorTetheringManager for a specific network account using the provided network account ID for the mobile broadband device. A network account is one of the mobile operator accounts available on the device (configured when the user inserts a SIM). You can retrieve a list of the IDs of the network accounts available on a device by accessing the MobileBroadbandAccount.AvailableNetworkAccountIds property. |
| DisableNoConnectionsTimeout() |
Disables the NoConnections timeout. |
| DisableNoConnectionsTimeoutAsync() |
Asynchronously disables the NoConnections timeout. |
| EnableNoConnectionsTimeout() |
Enables the NoConnections timeout. This means that tethering turns off automatically in 5 minutes after the last peer of the tethering connection goes away. |
| EnableNoConnectionsTimeoutAsync() |
Asynchronously enables the NoConnections timeout. This means that tethering turns off automatically in 5 minutes after the last peer of the tethering connection goes away. |
| GetCurrentAccessPointConfiguration() |
Gets the current access point configuration for a network account as defined by a NetworkOperatorTetheringAccessPointConfiguration object. |
| GetTetheringCapability(String) |
Indicates if a device is capable of creating a tethering network. Possible values are defined by TetheringCapability. |
| GetTetheringCapabilityFromConnectionProfile(ConnectionProfile) |
Gets tethering capabilities, based on the given connection profile. |
| GetTetheringClients() |
Retrieves a list of tethering clients for this NetworkOperatorTetheringManager. |
| IsNoConnectionsTimeoutEnabled() |
Gets a value indicating whether the NoConnections timeout is enabled. If enabled, tethering turns off automatically in 5 minutes after the last peer of the tethering connection goes away. |
| StartTetheringAsync() |
Establishes the tethering network. We recommended that you first call StopTetheringAsync in order to ensure that the tethering hotspot is off. |
| StartTetheringAsync(NetworkOperatorTetheringSessionAccessPointConfiguration) |
Starts the mobile hotspot using a specified per-session configuration. This overload allows you to start a tethering session without having to pre-configure it via ConfigureAccessPointAsync. The configuration passed as a parameter is valid only for the current session, and will be lost once the session has ended. Starting a new session via this overload of StartTetheringAsync also allows you to configure per-session-only parameters that can't be persistently set via ConfigureAccessPointAsync. Parameters that can be persisted are the network SSID, the network password, the network wireless frequency band, and the network authentication algorithm. We recommended that you first call StopTetheringAsync in order to ensure that the tethering hotspot is off. |
| StopTetheringAsync() |
Shuts down the tethering network. |