SignalingSession.BeginRefer Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
| BeginRefer(RealTimeAddress, ReferStatus, IEnumerable<SignalingHeader>, ContentType, Byte[], AsyncCallback, Object) |
Refers a URI to the remote participant. |
| BeginRefer(RealTimeAddress, ReferStatus, AsyncCallback, Object) |
Refers a URI to the remote participant. |
| BeginRefer(RealTimeAddress, ReferStatus, IEnumerable<SignalingHeader>, AsyncCallback, Object) |
Refers a URI to the remote participant. |
BeginRefer(RealTimeAddress, ReferStatus, IEnumerable<SignalingHeader>, ContentType, Byte[], AsyncCallback, Object)
Refers a URI to the remote participant.
public:
IAsyncResult ^ BeginRefer(Microsoft::Rtc::Signaling::RealTimeAddress ^ referTarget, Microsoft::Rtc::Signaling::ReferStatus ^ referStatus, System::Collections::Generic::IEnumerable<Microsoft::Rtc::Signaling::SignalingHeader ^> ^ signalingHeaders, System::Net::Mime::ContentType ^ contentType, cli::array <System::Byte> ^ body, AsyncCallback ^ userCallback, System::Object ^ state);public IAsyncResult BeginRefer (Microsoft.Rtc.Signaling.RealTimeAddress referTarget, Microsoft.Rtc.Signaling.ReferStatus referStatus, System.Collections.Generic.IEnumerable<Microsoft.Rtc.Signaling.SignalingHeader> signalingHeaders, System.Net.Mime.ContentType contentType, byte[] body, AsyncCallback userCallback, object state);member this.BeginRefer : Microsoft.Rtc.Signaling.RealTimeAddress * Microsoft.Rtc.Signaling.ReferStatus * seq<Microsoft.Rtc.Signaling.SignalingHeader> * System.Net.Mime.ContentType * byte[] * AsyncCallback * obj -> IAsyncResultParameters
- referTarget
- RealTimeAddress
RealTimeAddress that contains the refer URI
- referStatus
- ReferStatus
The refer status object provided by the caller to signal refer state change
- signalingHeaders
- IEnumerable<SignalingHeader>
Headers required for this refer. Can be null.
- contentType
- ContentType
Content type describing the body. Can be null if body is null.
- body
- Byte[]
The body for the data. Can be null.
- userCallback
- AsyncCallback
The method to be called when the asynchronous operation is completed.
- state
- Object
A user-provided object that distinguishes this particular asynchronous operation from other asynchronous operations.
Returns
An IAsyncResult that references the asynchronous operation.
Exceptions
Thrown when the refer status object is not Idle or is already used by another session.
Thrown when called in an invalid state.
Remarks
The platform supports multiple Refer operations at the same time. Some clients may not support parallel Refer operations. Until the first notification is received, the capability of the remote client is not known. For this reason, the first Refer operation is special in the sense the subsequent Refer operations are queued until first notify is received to learn the capability of the remote client. If the remote supports parallel Refer operations, the queued Refer operations are all released. If the remote does not support parallel Refer operations, the Refer operations are carried out one at a time. When the terminating notify is received, the next Refer operation is started. For this reason, calling synchronous method to send Refer or waiting on the operation to complete (EndRefer) before the callback is called are highly discouraged.
Applies to
BeginRefer(RealTimeAddress, ReferStatus, AsyncCallback, Object)
Refers a URI to the remote participant.
public:
IAsyncResult ^ BeginRefer(Microsoft::Rtc::Signaling::RealTimeAddress ^ referTarget, Microsoft::Rtc::Signaling::ReferStatus ^ referStatus, AsyncCallback ^ userCallback, System::Object ^ state);public IAsyncResult BeginRefer (Microsoft.Rtc.Signaling.RealTimeAddress referTarget, Microsoft.Rtc.Signaling.ReferStatus referStatus, AsyncCallback userCallback, object state);member this.BeginRefer : Microsoft.Rtc.Signaling.RealTimeAddress * Microsoft.Rtc.Signaling.ReferStatus * AsyncCallback * obj -> IAsyncResultParameters
- referTarget
- RealTimeAddress
The Refer target URI.
- referStatus
- ReferStatus
The ReferStatus object provided by the caller to signal Refer state changes.
- userCallback
- AsyncCallback
The method to be called when the asynchronous operation is completed.
- state
- Object
A user-provided object that distinguishes this particular asynchronous operation from other asynchronous operations.
Returns
An IAsyncResult that references the asynchronous operation.
Exceptions
Thrown when the session is an invalid state to send a Refer.
Thrown when invalid arguments are passed.
Thrown when arguments are null.
Remarks
The platform supports multiple Refer operations at the same time. Some clients may not support parallel Refer operations. Until the first notification is received, the capability of the remote client is not known. For this reason, the first Refer operation is special in the sense the subsequent Refer operations are queued until first notify is received to learn the capability of the remote client. If the remote supports parallel Refer operations, the queued Refer operations are all released. If the remote does not support parallel Refer operations, the Refer operations are carried out one at a time. When the terminating notify is received, the next Refer operation is started. For this reason, calling synchronous method to send Refer or waiting on the operation to complete (EndRefer) before the callback is called are highly discouraged.
Applies to
BeginRefer(RealTimeAddress, ReferStatus, IEnumerable<SignalingHeader>, AsyncCallback, Object)
Refers a URI to the remote participant.
public:
IAsyncResult ^ BeginRefer(Microsoft::Rtc::Signaling::RealTimeAddress ^ referTarget, Microsoft::Rtc::Signaling::ReferStatus ^ referStatus, System::Collections::Generic::IEnumerable<Microsoft::Rtc::Signaling::SignalingHeader ^> ^ signalingHeaders, AsyncCallback ^ userCallback, System::Object ^ state);public IAsyncResult BeginRefer (Microsoft.Rtc.Signaling.RealTimeAddress referTarget, Microsoft.Rtc.Signaling.ReferStatus referStatus, System.Collections.Generic.IEnumerable<Microsoft.Rtc.Signaling.SignalingHeader> signalingHeaders, AsyncCallback userCallback, object state);member this.BeginRefer : Microsoft.Rtc.Signaling.RealTimeAddress * Microsoft.Rtc.Signaling.ReferStatus * seq<Microsoft.Rtc.Signaling.SignalingHeader> * AsyncCallback * obj -> IAsyncResultParameters
- referTarget
- RealTimeAddress
RealTimeAddress that contains the refer URI
- referStatus
- ReferStatus
The refer status object provided by the caller to signal refer state change
- signalingHeaders
- IEnumerable<SignalingHeader>
Headers required for this refer. Can be null.
- userCallback
- AsyncCallback
The method to be called when the asynchronous operation is completed.
- state
- Object
A user-provided object that distinguishes this particular asynchronous operation from other asynchronous operations.
Returns
An IAsyncResult that references the asynchronous operation.
Exceptions
Thrown when the refer status object is not Idle or is already used by another session.
Thrown when called in an invalid state.
Remarks
The platform supports multiple Refer operations at the same time. Some clients may not support parallel Refer operations. Until the first notification is received, the capability of the remote client is not known. For this reason, the first Refer operation is special in the sense the subsequent Refer operations are queued until first notify is received to learn the capability of the remote client. If the remote supports parallel Refer operations, the queued Refer operations are all released. If the remote does not support parallel Refer operations, the Refer operations are carried out one at a time. When the terminating notify is received, the next Refer operation is started. For this reason, calling synchronous method to send Refer or waiting on the operation to complete (EndRefer) before the callback is called are highly discouraged.