MobileBroadbandPin
MobileBroadbandPin
MobileBroadbandPin
MobileBroadbandPin
Class
Definition
Contains the properties and methods associated with a mobile broadband PIN.
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 MobileBroadbandPin : IMobileBroadbandPinpublic sealed class MobileBroadbandPin : IMobileBroadbandPinPublic NotInheritable Class MobileBroadbandPin Implements IMobileBroadbandPin// 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)
|
Remarks
The usage and content of a Universal Integrated Circuit Card (UICC), normally called a SIM Card, can be protected by use of a code called the Personal Identification Number (PIN). PIN1 is defined to control normal use of the phone or data modem. PIN2 can be set to allow the use of special functions such as limiting outbound calls to a list of numbers.
A MobileBroadbandPin object is returned by the GetPin method on the MobileBroadbandPinManager .
Properties
AttemptsRemaining AttemptsRemaining AttemptsRemaining AttemptsRemaining
Gets the number of attempts remaining before the mobile broadband PIN is blocked.
public : unsigned int AttemptsRemaining { get; }public uint AttemptsRemaining { get; }Public ReadOnly Property AttemptsRemaining As uint// You can use this property in JavaScript.
- Value
- unsigned int uint uint uint
The number of attempts remaining before the mobile broadband PIN is blocked.
Enabled Enabled Enabled Enabled
Gets a boolean value that indicates if the mobile broadband PIN is enabled.
public : PlatForm::Boolean Enabled { get; }public bool Enabled { get; }Public ReadOnly Property Enabled As bool// You can use this property in JavaScript.
- Value
- PlatForm::Boolean bool bool bool
A boolean value that indicates if the mobile broadband PIN is enabled.
Format Format Format Format
Gets the format for a mobile broadband PIN.
public : MobileBroadbandPinFormat Format { get; }public MobileBroadbandPinFormat Format { get; }Public ReadOnly Property Format As MobileBroadbandPinFormat// You can use this property in JavaScript.
- Value
- MobileBroadbandPinFormat MobileBroadbandPinFormat MobileBroadbandPinFormat MobileBroadbandPinFormat
The format for a mobile broadband PIN.
- See Also
LockState LockState LockState LockState
Gets the lock state for a mobile broadband PIN.
public : MobileBroadbandPinLockState LockState { get; }public MobileBroadbandPinLockState LockState { get; }Public ReadOnly Property LockState As MobileBroadbandPinLockState// You can use this property in JavaScript.
- Value
- MobileBroadbandPinLockState MobileBroadbandPinLockState MobileBroadbandPinLockState MobileBroadbandPinLockState
The lock state for a mobile broadband PIN.
- See Also
MaxLength MaxLength MaxLength MaxLength
Gets the maximum length, in bytes, of the mobile broadband PIN.
public : unsigned int MaxLength { get; }public uint MaxLength { get; }Public ReadOnly Property MaxLength As uint// You can use this property in JavaScript.
- Value
- unsigned int uint uint uint
The maximum length, in bytes, of the mobile broadband PIN.
MinLength MinLength MinLength MinLength
Gets the minimum length, in bytes, of the mobile broadband PIN.
public : unsigned int MinLength { get; }public uint MinLength { get; }Public ReadOnly Property MinLength As uint// You can use this property in JavaScript.
- Value
- unsigned int uint uint uint
The minimum length, in bytes, of the mobile broadband PIN.
Type Type Type Type
Gets the PIN type for a mobile broadband PIN.
public : MobileBroadbandPinType Type { get; }public MobileBroadbandPinType Type { get; }Public ReadOnly Property Type As MobileBroadbandPinType// You can use this property in JavaScript.
The PIN type for a mobile broadband PIN.
Remarks
The usage and content of a Universal Integrated Circuit Card (UICC), normally called a SIM Card, can be protected by use of a code called the Personal Identification Number (PIN). PIN1 is defined to control normal use of the phone or data modem. PIN2 can be set to allow the use of special functions such as limiting outbound calls to a list of numbers.
- See Also
Methods
ChangeAsync(String, String) ChangeAsync(String, String) ChangeAsync(String, String) ChangeAsync(String, String)
Starts an asynchronous operation to change an already-enabled mobile broadband PIN.
public : IAsyncOperation<MobileBroadbandPinOperationResult> ChangeAsync(PlatForm::String currentPin, PlatForm::String newPin)public IAsyncOperation<MobileBroadbandPinOperationResult> ChangeAsync(String currentPin, String newPin)Public Function ChangeAsync(currentPin As String, newPin As String) As IAsyncOperation( Of MobileBroadbandPinOperationResult )// You can use this method in JavaScript.
- currentPin
- PlatForm::String String String String
The current mobile broadband PIN.
- newPin
- PlatForm::String String String String
The new mobile broadband PIN.
An asynchronous operation that returns the result.
DisableAsync(String) DisableAsync(String) DisableAsync(String) DisableAsync(String)
Starts an asynchronous operation to disable a previously-enabled mobile broadband PIN.
public : IAsyncOperation<MobileBroadbandPinOperationResult> DisableAsync(PlatForm::String currentPin)public IAsyncOperation<MobileBroadbandPinOperationResult> DisableAsync(String currentPin)Public Function DisableAsync(currentPin As String) As IAsyncOperation( Of MobileBroadbandPinOperationResult )// You can use this method in JavaScript.
- currentPin
- PlatForm::String String String String
The current mobile broadband PIN.
An asynchronous operation that returns the result.
EnableAsync(String) EnableAsync(String) EnableAsync(String) EnableAsync(String)
Starts an asynchronous operation to enable a previously-disabled mobile broadband PIN.
public : IAsyncOperation<MobileBroadbandPinOperationResult> EnableAsync(PlatForm::String currentPin)public IAsyncOperation<MobileBroadbandPinOperationResult> EnableAsync(String currentPin)Public Function EnableAsync(currentPin As String) As IAsyncOperation( Of MobileBroadbandPinOperationResult )// You can use this method in JavaScript.
- currentPin
- PlatForm::String String String String
The current mobile broadband PIN.
An asynchronous operation that returns the result.
EnterAsync(String) EnterAsync(String) EnterAsync(String) EnterAsync(String)
Starts an asynchronous operation to get the current mobile broadband PIN from the user.
public : IAsyncOperation<MobileBroadbandPinOperationResult> EnterAsync(PlatForm::String currentPin)public IAsyncOperation<MobileBroadbandPinOperationResult> EnterAsync(String currentPin)Public Function EnterAsync(currentPin As String) As IAsyncOperation( Of MobileBroadbandPinOperationResult )// You can use this method in JavaScript.
- currentPin
- PlatForm::String String String String
The current mobile broadband PIN.
An asynchronous operation that returns the result.
UnblockAsync(String, String) UnblockAsync(String, String) UnblockAsync(String, String) UnblockAsync(String, String)
Starts an asynchronous operation to unblock a previously-blocked mobile broadband PIN using a PIN unlock key (PUK).
public : IAsyncOperation<MobileBroadbandPinOperationResult> UnblockAsync(PlatForm::String pinUnblockKey, PlatForm::String newPin)public IAsyncOperation<MobileBroadbandPinOperationResult> UnblockAsync(String pinUnblockKey, String newPin)Public Function UnblockAsync(pinUnblockKey As String, newPin As String) As IAsyncOperation( Of MobileBroadbandPinOperationResult )// You can use this method in JavaScript.
- pinUnblockKey
- PlatForm::String String String String
The PIN unblock key.
- newPin
- PlatForm::String String String String
The new mobile broadband PIN.
An asynchronous operation that returns the result.
Remarks
A PIN unlock key is a code used to reset a PIN that may have been blocked due to too many attempts to unlock it. PUK1 and PUK2 are used to reset PIN1 and PIN2 respectively.