ApplicationPinServices.BeginVerifyPin Method
Begins an asynchronous operation to verify given pin for the uri.
Namespace: Microsoft.Rtc.Collaboration.PinManagement
Assembly: Microsoft.Rtc.Collaboration (in Microsoft.Rtc.Collaboration.dll)
Syntax
'Declaration
Public Function BeginVerifyPin ( _
uriToVerify As String, _
pin As String, _
options As VerifyPinOptions, _
userCallback As AsyncCallback, _
state As Object _
) As IAsyncResult
'Usage
Dim instance As ApplicationPinServices
Dim uriToVerify As String
Dim pin As String
Dim options As VerifyPinOptions
Dim userCallback As AsyncCallback
Dim state As Object
Dim returnValue As IAsyncResult
returnValue = instance.BeginVerifyPin(uriToVerify, _
pin, options, userCallback, state)
public IAsyncResult BeginVerifyPin(
string uriToVerify,
string pin,
VerifyPinOptions options,
AsyncCallback userCallback,
Object state
)
Parameters
- uriToVerify
Type: System.String
The uri for which we need to verify the pin. This can be a global telephone uri, telephone extension or a SIP uri. Cannot be null or empty.
- pin
Type: System.String
Pin to be verified. Cannot be null or empty.
- options
Type: Microsoft.Rtc.Collaboration.PinManagement.VerifyPinOptions
The optional parameters to be used when verifying given pin.
- userCallback
Type: System.AsyncCallback
The method to be called when the asynchronous operation is completed.
- state
Type: System.Object
A user-provided object that distinguishes this particular asynchronous operation from other asynchronous operations.
Return Value
Type: System.IAsyncResult
An IAsyncResult that references the asynchronous operation.
Exceptions
| Exception | Condition |
|---|---|
| ArgumentException | uriToVerify parameter is null, empty or invalid sip URI or tel URI. pin parameter is null or empty. options parameter contains invalid or restricted signaling headers. |
| InvalidOperationException | Endpoint is not in valid state to perform this operation. Pin services uri is not available. |