BeginDecline Method
Decline the offer with a specific reason.
Namespace: Microsoft.Rtc.Signaling
Assembly: Microsoft.Rtc.Collaboration (in Microsoft.Rtc.Collaboration.dll)
Syntax
'Declaration
Public MustOverride Function BeginDecline ( _
responseCode As Integer, _
reasonPhrase As String, _
signalingHeaders As IEnumerable(Of SignalingHeader), _
contentType As ContentType, _
body As Byte(), _
userCallback As AsyncCallback, _
state As Object _
) As IAsyncResult
'Usage
Dim instance As OfferInReInviteEventArgs
Dim responseCode As Integer
Dim reasonPhrase As String
Dim signalingHeaders As IEnumerable(Of SignalingHeader)
Dim contentType As ContentType
Dim body As Byte()
Dim userCallback As AsyncCallback
Dim state As Object
Dim returnValue As IAsyncResult
returnValue = instance.BeginDecline(responseCode, _
reasonPhrase, signalingHeaders, _
contentType, body, userCallback, _
state)
public abstract IAsyncResult BeginDecline(
int responseCode,
string reasonPhrase,
IEnumerable<SignalingHeader> signalingHeaders,
ContentType contentType,
byte[] body,
AsyncCallback userCallback,
Object state
)
Parameters
- responseCode
Type: System..::..Int32
The response code to decline with.
- reasonPhrase
Type: System..::..String
The reason phrase to use, which can be nullNothingnullptrunita null reference (Nothing in Visual Basic).
- signalingHeaders
Type: System.Collections.Generic..::..IEnumerable<(Of <(<'SignalingHeader>)>)>
The signaling headers to use in the response, which can be nullNothingnullptrunita null reference (Nothing in Visual Basic).
- contentType
Type: System.Net.Mime..::..ContentType
The content type of the body, which can be nullNothingnullptrunita null reference (Nothing in Visual Basic) if body is nullNothingnullptrunita null reference (Nothing in Visual Basic).
- body
Type: array<System..::..Byte>[]()[][]
The body to send.
- userCallback
Type: System..::..AsyncCallback
The method to be called when the async operation is completed.
- state
Type: System..::..Object
The state to be passed back to the callback.
Return Value
Type: System..::..IAsyncResult
An [IAsyncResult] that references this operation.
Exceptions
Exception | Condition |
---|---|
ArgumentOutOfRangeException | Thrown when the response code is not in the range expected. |
ArgumentException | Thrown when there are problems with arguments supplied. |
InvalidOperationException | Thrown when called in an invalid state or a final response has already been sent. |
RealTimeException | Thrown when the response cannot be sent for other reasons. |
Remarks
The operation completes when the ACK message is received.
See Also
Reference
OfferInReInviteEventArgs Class