MobileBroadbandSarManager MobileBroadbandSarManager MobileBroadbandSarManager MobileBroadbandSarManager Class

Definition

Some information relates to pre-released product which may be substantially modified before it’s commercially released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Prerelease APIs are identified by a Prerelease label.

[Contains prerelease APIs.]
Contains the SAR configuration properties and the control method to change them on the device.

public : sealed class MobileBroadbandSarManager : IMobileBroadbandSarManagerpublic sealed class MobileBroadbandSarManager : IMobileBroadbandSarManagerPublic NotInheritable Class MobileBroadbandSarManager Implements IMobileBroadbandSarManager// You can use this class in JavaScript.
Attributes
Windows 10 requirements
Device family
Windows 10 Insider Preview (introduced v10.0.16257.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v5)

Properties

Antennas Antennas Antennas Antennas

Prerelease. Gets the collection of current SAR configuration models for each antenna on the device.

public : IVectorView<MobileBroadbandAntennaSar> Antennas { get; }public IReadOnlyList<MobileBroadbandAntennaSar> Antennas { get; }Public ReadOnly Property Antennas As IReadOnlyList<MobileBroadbandAntennaSar>// You can use this property in JavaScript.
Value
IVectorView<MobileBroadbandAntennaSar> IReadOnlyList<MobileBroadbandAntennaSar> IReadOnlyList<MobileBroadbandAntennaSar> IReadOnlyList<MobileBroadbandAntennaSar>

The collection of current SAR configuration models for each antenna on the device.

Remarks

The size of this collection is guaranteed to be the same as the number of antennas on device.

HysteresisTimerPeriod HysteresisTimerPeriod HysteresisTimerPeriod HysteresisTimerPeriod

Prerelease. Gets the time window of the hysteresis timer that is used to determine antenna's transmission state.

public : TimeSpan HysteresisTimerPeriod { get; }public TimeSpan HysteresisTimerPeriod { get; }Public ReadOnly Property HysteresisTimerPeriod As TimeSpan// You can use this property in JavaScript.
Value
TimeSpan TimeSpan TimeSpan TimeSpan

The time window of the hysteresis timer.

Remarks

This value is in the range 1 ~ 5, in seconds.

IsBackoffEnabled IsBackoffEnabled IsBackoffEnabled IsBackoffEnabled

Prerelease. Gets a value indicating whether SAR backoff functionality is enabled on the device.

public : PlatForm::Boolean IsBackoffEnabled { get; }public bool IsBackoffEnabled { get; }Public ReadOnly Property IsBackoffEnabled As bool// You can use this property in JavaScript.
Value
PlatForm::Boolean bool bool bool

True if SAR backoff functionality is enabled; otherwise, false.

IsSarControlledByHardware IsSarControlledByHardware IsSarControlledByHardware IsSarControlledByHardware

Prerelease. Gets a value indicating if SAR configuration is controlled by device hardware.

public : PlatForm::Boolean IsSarControlledByHardware { get; }public bool IsSarControlledByHardware { get; }Public ReadOnly Property IsSarControlledByHardware As bool// You can use this property in JavaScript.
Value
PlatForm::Boolean bool bool bool

True if SAR configuration is controlled by device hardware; otherwise, false.

IsWiFiHardwareIntegrated IsWiFiHardwareIntegrated IsWiFiHardwareIntegrated IsWiFiHardwareIntegrated

Prerelease. Gets a value indicating if WiFi and cellular SAR are integrated in the device.

public : PlatForm::Boolean IsWiFiHardwareIntegrated { get; }public bool IsWiFiHardwareIntegrated { get; }Public ReadOnly Property IsWiFiHardwareIntegrated As bool// You can use this property in JavaScript.
Value
PlatForm::Boolean bool bool bool

True if WiFi and cellular SAR are integrated in the device; otherwise, false.

Methods

DisableBackoffAsync() DisableBackoffAsync() DisableBackoffAsync() DisableBackoffAsync()

Prerelease. Disables SAR backoff functionality on the device.

public : IAsyncAction DisableBackoffAsync()public IAsyncAction DisableBackoffAsync()Public Function DisableBackoffAsync() As IAsyncAction// You can use this method in JavaScript.
Returns

EnableBackoffAsync() EnableBackoffAsync() EnableBackoffAsync() EnableBackoffAsync()

Prerelease. Enables SAR backoff functionality on the device.

public : IAsyncAction EnableBackoffAsync()public IAsyncAction EnableBackoffAsync()Public Function EnableBackoffAsync() As IAsyncAction// You can use this method in JavaScript.
Returns

GetIsTransmittingAsync() GetIsTransmittingAsync() GetIsTransmittingAsync() GetIsTransmittingAsync()

Prerelease. Gets a value that indicates whether the modem is transmitting or idle.

public : IAsyncOperation<PlatForm::Boolean> GetIsTransmittingAsync()public IAsyncOperation<bool> GetIsTransmittingAsync()Public Function GetIsTransmittingAsync() As IAsyncOperation( Of bool )// You can use this method in JavaScript.
Returns

True if the modem is transmitting; otherwise, it is idle.

RevertSarToHardwareControlAsync() RevertSarToHardwareControlAsync() RevertSarToHardwareControlAsync() RevertSarToHardwareControlAsync()

Prerelease. Sets the device back to hardware control mode. The relevant SAR configuration values are reset to the hardware default settings.

public : IAsyncAction RevertSarToHardwareControlAsync()public IAsyncAction RevertSarToHardwareControlAsync()Public Function RevertSarToHardwareControlAsync() As IAsyncAction// You can use this method in JavaScript.
Returns

SetConfigurationAsync(IIterable) SetConfigurationAsync(IIterable) SetConfigurationAsync(IIterable) SetConfigurationAsync(IIterable)

Prerelease. Sends a request to the device to change the SAR configuration.

public : IAsyncAction SetConfigurationAsync(IIterable<MobileBroadbandAntennaSar> antennas)public IAsyncAction SetConfigurationAsync(IEnumerable<MobileBroadbandAntennaSar> antennas)Public Function SetConfigurationAsync(antennas As IEnumerable<MobileBroadbandAntennaSar>) As IAsyncAction// You can use this method in JavaScript.
Parameters
antennas
IIterable<MobileBroadbandAntennaSar> IEnumerable<MobileBroadbandAntennaSar> IEnumerable<MobileBroadbandAntennaSar> IEnumerable<MobileBroadbandAntennaSar>

The collection of antennas containing the SAR backoff property to configure.

Returns

SetTransmissionStateChangedHysteresisAsync(TimeSpan) SetTransmissionStateChangedHysteresisAsync(TimeSpan) SetTransmissionStateChangedHysteresisAsync(TimeSpan) SetTransmissionStateChangedHysteresisAsync(TimeSpan)

Prerelease. Sets the hysteresis timer (1-5 seconds) used to determine if transmission activity is idle.

public : IAsyncAction SetTransmissionStateChangedHysteresisAsync(TimeSpan timerPeriod)public IAsyncAction SetTransmissionStateChangedHysteresisAsync(TimeSpan timerPeriod)Public Function SetTransmissionStateChangedHysteresisAsync(timerPeriod As TimeSpan) As IAsyncAction// You can use this method in JavaScript.
Parameters
timerPeriod
TimeSpan TimeSpan TimeSpan TimeSpan

/** The time-window size ranging from 1 to 5 seconds.

Returns

StartTransmissionStateMonitoring() StartTransmissionStateMonitoring() StartTransmissionStateMonitoring() StartTransmissionStateMonitoring()

Prerelease. Starts monitoring the transition state change on the device.

public : void StartTransmissionStateMonitoring()public void StartTransmissionStateMonitoring()Public Function StartTransmissionStateMonitoring() As void// You can use this method in JavaScript.

StopTransmissionStateMonitoring() StopTransmissionStateMonitoring() StopTransmissionStateMonitoring() StopTransmissionStateMonitoring()

Prerelease. Stops monitoring the transition state change on the device.

public : void StopTransmissionStateMonitoring()public void StopTransmissionStateMonitoring()Public Function StopTransmissionStateMonitoring() As void// You can use this method in JavaScript.

Events

TransmissionStateChanged TransmissionStateChanged TransmissionStateChanged TransmissionStateChanged

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

public : event TypedEventHandler TransmissionStateChanged<MobileBroadbandSarManager,  MobileBroadbandTransmissionStateChangedEventArgs>public event TypedEventHandler TransmissionStateChanged<MobileBroadbandSarManager,  MobileBroadbandTransmissionStateChangedEventArgs>Public Event TransmissionStateChanged<MobileBroadbandSarManager,  MobileBroadbandTransmissionStateChangedEventArgs>// You can use this event in JavaScript.