MobileBroadbandSarManager Class

Reference

Definition

Namespace:: Windows.Networking.NetworkOperators

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.

Edit

Contains the SAR configuration properties and the control method to change them on the device.

Note

To use this API you will need to contact Microsoft to request the custom capability microsoft.cellularSARConfiguration_8wekyb3d8bbwe. For more info, see the Custom capabilities section in the App capability declarations topic, and Creating a custom capability to pair a driver with a Hardware Support App.

public ref class MobileBroadbandSarManager sealed

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 327680)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
class MobileBroadbandSarManager final

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 327680)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
public sealed class MobileBroadbandSarManager

Public NotInheritable Class MobileBroadbandSarManager

Inheritance: Object Platform::Object IInspectable MobileBroadbandSarManager

Attributes: ContractVersionAttribute MarshalingBehaviorAttribute

Windows requirements

Device family	Windows 10 Fall Creators Update (introduced in 10.0.16299.0)
API contract	Windows.Foundation.UniversalApiContract (introduced in v5.0)
App capabilities	cellularDeviceControl cellularDeviceIdentity microsoft.cellularSARConfiguration_8wekyb3d8bbwe

Properties

Antennas	Gets the collection of current SAR configuration models for each antenna on the device. Note To use this API you will need to contact Microsoft to request the custom capability microsoft.cellularSARConfiguration_8wekyb3d8bbwe. For more info, see the Custom capabilities section in the App capability declarations topic, and Creating a custom capability to pair a driver with a Hardware Support App.
HysteresisTimerPeriod	Gets the time window of the hysteresis timer that is used to determine antenna's transmission state. Note To use this API you will need to contact Microsoft to request the custom capability microsoft.cellularSARConfiguration_8wekyb3d8bbwe. For more info, see the Custom capabilities section in the App capability declarations topic, and Creating a custom capability to pair a driver with a Hardware Support App.
IsBackoffEnabled	Gets a value indicating whether SAR backoff functionality is enabled on the device. Note To use this API you will need to contact Microsoft to request the custom capability microsoft.cellularSARConfiguration_8wekyb3d8bbwe. For more info, see the Custom capabilities section in the App capability declarations topic, and Creating a custom capability to pair a driver with a Hardware Support App.
IsSarControlledByHardware	Gets a value indicating if SAR configuration is controlled by device hardware. Note To use this API you will need to contact Microsoft to request the custom capability microsoft.cellularSARConfiguration_8wekyb3d8bbwe. For more info, see the Custom capabilities section in the App capability declarations topic, and Creating a custom capability to pair a driver with a Hardware Support App.
IsWiFiHardwareIntegrated	Gets a value indicating if WiFi and cellular SAR are integrated in the device. Note To use this API you will need to contact Microsoft to request the custom capability microsoft.cellularSARConfiguration_8wekyb3d8bbwe. For more info, see the Custom capabilities section in the App capability declarations topic, and Creating a custom capability to pair a driver with a Hardware Support App.

Methods

DisableBackoffAsync()	Disables SAR backoff functionality on the device. Note To use this API you will need to contact Microsoft to request the custom capability microsoft.cellularSARConfiguration_8wekyb3d8bbwe. For more info, see the Custom capabilities section in the App capability declarations topic, and Creating a custom capability to pair a driver with a Hardware Support App.
EnableBackoffAsync()	Enables SAR backoff functionality on the device. Note To use this API you will need to contact Microsoft to request the custom capability microsoft.cellularSARConfiguration_8wekyb3d8bbwe. For more info, see the Custom capabilities section in the App capability declarations topic, and Creating a custom capability to pair a driver with a Hardware Support App.
GetIsTransmittingAsync()	Gets a value that indicates whether the modem is transmitting or idle. Note To use this API you will need to contact Microsoft to request the custom capability microsoft.cellularSARConfiguration_8wekyb3d8bbwe. For more info, see the Custom capabilities section in the App capability declarations topic, and Creating a custom capability to pair a driver with a Hardware Support App.
RevertSarToHardwareControlAsync()	Sets the device back to hardware control mode. The relevant SAR configuration values are reset to the hardware default settings. Note To use this API you will need to contact Microsoft to request the custom capability microsoft.cellularSARConfiguration_8wekyb3d8bbwe. For more info, see the Custom capabilities section in the App capability declarations topic, and Creating a custom capability to pair a driver with a Hardware Support App.
SetConfigurationAsync(IIterable<MobileBroadbandAntennaSar>)	Sends a request to the device to change the SAR configuration. Note This is a pre-release API. It will be fully usable in a future release, when the appropriate MobileBroadbandAntennaSar constructor is available. To use this API you will need to contact Microsoft to request the custom capability microsoft.cellularSARConfiguration_8wekyb3d8bbwe. For more info, see the Custom capabilities section in the App capability declarations topic, and Creating a custom capability to pair a driver with a Hardware Support App.
SetTransmissionStateChangedHysteresisAsync(TimeSpan)	Sets the hysteresis timer (1-5 seconds) used to determine if transmission activity is idle. Note To use this API you will need to contact Microsoft to request the custom capability microsoft.cellularSARConfiguration_8wekyb3d8bbwe. For more info, see the Custom capabilities section in the App capability declarations topic, and Creating a custom capability to pair a driver with a Hardware Support App.
StartTransmissionStateMonitoring()	Starts monitoring the transmission state change on the device. Note To use this API you will need to contact Microsoft to request the custom capability microsoft.cellularSARConfiguration_8wekyb3d8bbwe. For more info, see the Custom capabilities section in the App capability declarations topic, and Creating a custom capability to pair a driver with a Hardware Support App.
StopTransmissionStateMonitoring()	Stops monitoring the transmission state change on the device. Note To use this API you will need to contact Microsoft to request the custom capability microsoft.cellularSARConfiguration_8wekyb3d8bbwe. For more info, see the Custom capabilities section in the App capability declarations topic, and Creating a custom capability to pair a driver with a Hardware Support App.

Events

TransmissionStateChanged

Occurs when there is notification received from device that indicate a change in the current transmission state.