Redirect the audiovideo call to a different
target URI.
Namespace:
Microsoft.Rtc.Collaboration.AudioVideo
Assembly: Microsoft.Rtc.Collaboration(in Microsoft.Rtc.Collaboration.dll)
Syntax
Visual Basic (Declaration) |
---|
Public Sub Forward ( _ targetUri As String, _ forwardOptions As CallForwardOptions _ ) |
C# |
---|
public void Forward( string targetUri, CallForwardOptions forwardOptions ) |
Visual C++ |
---|
public: void Forward( String^ targetUri, CallForwardOptions^ forwardOptions ) |
JavaScript |
---|
function forward( targetUri, forwardOptions); |
Parameters
- targetUri
- Type:
String
The forward target URI.
- forwardOptions
- Type:
Microsoft.Rtc.Collaboration
.
.
::
.
CallForwardOptions
Optional parameters to forward the audiovideo call. This includes using a specific response code for forwarding the audiovideo call.
Remarks
When the
forwardOptionsparameter is null,
this call will be forwarded with a response code of 303. Redirects
the audiovideo call to a different target. Depending on the
response code, the forward is either carried out by the proxy when
supported or by the user agent client that sent the invite
request.
Exceptions
Exception | Condition |
---|---|
ArgumentException | Thrown when the targetUriparameter is null, empty or invalid. |
InvalidOperationException | Thrown when the call is not in valid state to perform this operation. |
Microsoft.Rtc.Signaling . . :: . RealTimeException | Thrown when the forward operation failed to complete successfully. |