MobileBroadbandModem
MobileBroadbandModem
MobileBroadbandModem
MobileBroadbandModem
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.]
Represents a mobile broadband modem.
Note
This functionality is only available to mobile operator apps and Windows Store apps given privileged access by mobile network operators.
If you want to use this API and publish your app to the Store, you will need special approval. For more information, see the Special and restricted capabilities section under App capability declarations.
public : sealed class MobileBroadbandModem : IMobileBroadbandModempublic sealed class MobileBroadbandModem : IMobileBroadbandModemPublic NotInheritable Class MobileBroadbandModem Implements IMobileBroadbandModem// You can use this class in JavaScript.
- Attributes
| Device family |
Windows 10 (introduced v10.0.10240.0 - for Xbox, see UWP features that aren't yet supported on Xbox)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v1)
|
Properties
CurrentAccount CurrentAccount CurrentAccount CurrentAccount
Gets the MobileBroadbandAccount associated currently with the mobile broadband modem.
public : MobileBroadbandAccount CurrentAccount { get; }public MobileBroadbandAccount CurrentAccount { get; }Public ReadOnly Property CurrentAccount As MobileBroadbandAccount// You can use this property in JavaScript.
The account associated currently with the mobile broadband modem.
- See Also
CurrentNetwork CurrentNetwork CurrentNetwork CurrentNetwork
Gets an object that describes the mobile broadband network that this modem us currently attached to.
public : MobileBroadbandNetwork CurrentNetwork { get; }public MobileBroadbandNetwork CurrentNetwork { get; }Public ReadOnly Property CurrentNetwork As MobileBroadbandNetwork// You can use this property in JavaScript.
Describes the current broadband network.
DeviceInformation DeviceInformation DeviceInformation DeviceInformation
Gets the MobileBroadbandDeviceInformation for the mobile broadband modem.
public : MobileBroadbandDeviceInformation DeviceInformation { get; }public MobileBroadbandDeviceInformation DeviceInformation { get; }Public ReadOnly Property DeviceInformation As MobileBroadbandDeviceInformation// You can use this property in JavaScript.
- Value
- MobileBroadbandDeviceInformation MobileBroadbandDeviceInformation MobileBroadbandDeviceInformation MobileBroadbandDeviceInformation
The device information for the mobile broadband modem.
- See Also
DeviceServices DeviceServices DeviceServices DeviceServices
Gets a list of the device services available for the mobile broadband modem.
public : IVectorView<MobileBroadbandDeviceServiceInformation> DeviceServices { get; }public IReadOnlyList<MobileBroadbandDeviceServiceInformation> DeviceServices { get; }Public ReadOnly Property DeviceServices As IReadOnlyList<MobileBroadbandDeviceServiceInformation>// You can use this property in JavaScript.
- Value
- IVectorView<MobileBroadbandDeviceServiceInformation> IReadOnlyList<MobileBroadbandDeviceServiceInformation> IReadOnlyList<MobileBroadbandDeviceServiceInformation> IReadOnlyList<MobileBroadbandDeviceServiceInformation>
A list of the device services available for the mobile broadband modem.
IsResetSupported IsResetSupported IsResetSupported IsResetSupported
Gets a value indicating whether the mobile broadband modem allows a reset operation.
public : PlatForm::Boolean IsResetSupported { get; }public bool IsResetSupported { get; }Public ReadOnly Property IsResetSupported As bool// You can use this property in JavaScript.
- Value
- PlatForm::Boolean bool bool bool
If true, then the modem may be reset by calling ResetAsync. When this value is false, calling ResetAsync will surely fail.
MaxDeviceServiceCommandSizeInBytes MaxDeviceServiceCommandSizeInBytes MaxDeviceServiceCommandSizeInBytes MaxDeviceServiceCommandSizeInBytes
Gets the maximum device service command size, in bytes, for the mobile broadband modem.
public : unsigned int MaxDeviceServiceCommandSizeInBytes { get; }public uint MaxDeviceServiceCommandSizeInBytes { get; }Public ReadOnly Property MaxDeviceServiceCommandSizeInBytes As uint// You can use this property in JavaScript.
- Value
- unsigned int uint uint uint
The maximum device service command size, in bytes, for the mobile broadband modem.
MaxDeviceServiceDataSizeInBytes MaxDeviceServiceDataSizeInBytes MaxDeviceServiceDataSizeInBytes MaxDeviceServiceDataSizeInBytes
Gets the maximum device service data size, in bytes, for the mobile broadband modem.
public : unsigned int MaxDeviceServiceDataSizeInBytes { get; }public uint MaxDeviceServiceDataSizeInBytes { get; }Public ReadOnly Property MaxDeviceServiceDataSizeInBytes As uint// You can use this property in JavaScript.
- Value
- unsigned int uint uint uint
the maximum device service data size, in bytes, for the mobile broadband modem.
Methods
FromId(String) FromId(String) FromId(String) FromId(String)
Determine if a mobile broadband device is a Wireless WAN device.
public : static MobileBroadbandModem FromId(PlatForm::String deviceId)public static MobileBroadbandModem FromId(String deviceId)Public Static Function FromId(deviceId As String) As MobileBroadbandModem// You can use this method in JavaScript.
- deviceId
- PlatForm::String String String String
The mobile broadband device ID
The mobile broadband modem.
GetCurrentConfigurationAsync() GetCurrentConfigurationAsync() GetCurrentConfigurationAsync() GetCurrentConfigurationAsync()
Asynchronously retrieves mobile broadband modem configuration information.
public : IAsyncOperation<MobileBroadbandModemConfiguration> GetCurrentConfigurationAsync()public IAsyncOperation<MobileBroadbandModemConfiguration> GetCurrentConfigurationAsync()Public Function GetCurrentConfigurationAsync() As IAsyncOperation( Of MobileBroadbandModemConfiguration )// You can use this method in JavaScript.
An asynchronous retrieval operation. On successful completion, contains a MobileBroadbandModemConfiguration object representing the current configuration.
GetDefault() GetDefault() GetDefault() GetDefault()
Determines the default mobile broadband modem.
public : static MobileBroadbandModem GetDefault()public static MobileBroadbandModem GetDefault()Public Static Function GetDefault() As MobileBroadbandModem// You can use this method in JavaScript.
The mobile broadband modem.
GetDeviceSelector() GetDeviceSelector() GetDeviceSelector() GetDeviceSelector()
Gets a device selector for the mobile broadband modem.
public : static PlatForm::String GetDeviceSelector()public static string GetDeviceSelector()Public Static Function GetDeviceSelector() As string// You can use this method in JavaScript.
A device selector for the mobile broadband modem.
GetDeviceService(Guid) GetDeviceService(Guid) GetDeviceService(Guid) GetDeviceService(Guid)
Gets a specific device service for the mobile broadband modem.
public : MobileBroadbandDeviceService GetDeviceService(PlatForm::Guid deviceServiceId)public MobileBroadbandDeviceService GetDeviceService(Guid deviceServiceId)Public Function GetDeviceService(deviceServiceId As Guid) As MobileBroadbandDeviceService// You can use this method in JavaScript.
- deviceServiceId
- PlatForm::Guid Guid Guid Guid
The unique device service identifier for the device service to be retrieved.
The mobile broadband device service retrieved.
- See Also
GetIsPassthroughEnabledAsync() GetIsPassthroughEnabledAsync() GetIsPassthroughEnabledAsync() GetIsPassthroughEnabledAsync()
Prerelease. Gets a value indicating whether passthrough mode is enabled.
public : IAsyncOperation<PlatForm::Boolean> GetIsPassthroughEnabledAsync()public IAsyncOperation<bool> GetIsPassthroughEnabledAsync()Public Function GetIsPassthroughEnabledAsync() As IAsyncOperation( Of bool )// You can use this method in JavaScript.
An asynchronous operation that returns a boolean value on completion. The value is true if passthrough is enabled; otherwise, false.
| Device family |
Windows 10 Insider Preview (introduced v10.0.16257.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v5)
|
ResetAsync() ResetAsync() ResetAsync() ResetAsync()
Asynchronously performs a reset operation on the mobile broadband modem.
public : IAsyncAction ResetAsync()public IAsyncAction ResetAsync()Public Function ResetAsync() As IAsyncAction// You can use this method in JavaScript.
An asynchronous reset operation.
SetIsPassthroughEnabledAsync(Boolean) SetIsPassthroughEnabledAsync(Boolean) SetIsPassthroughEnabledAsync(Boolean) SetIsPassthroughEnabledAsync(Boolean)
Prerelease. Asynchronously enables or disables passthrough mode.
public : IAsyncOperation<MobileBroadbandModemStatus> SetIsPassthroughEnabledAsync(bool value)public IAsyncOperation<MobileBroadbandModemStatus> SetIsPassthroughEnabledAsync(Boolean value)Public Function SetIsPassthroughEnabledAsync(value As Boolean) As IAsyncOperation( Of MobileBroadbandModemStatus )// You can use this method in JavaScript.
- value
- bool Boolean Boolean Boolean
True if passthrough should be enabled; otherwise, false.
An asynchronous operation that returns a MobileBroadbandModemStatus value on completion.
| Device family |
Windows 10 Insider Preview (introduced v10.0.16257.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v5)
|