SignalingSession.Participate Method

Definition

Namespace:

Microsoft.Rtc.Signaling

Assembly:

Microsoft.Rtc.Collaboration.dll

Overloads

Participate()	Synchronously participates in a session. This method is not recommended for UI threads or scalable server applications.
Participate(IEnumerable<SignalingHeader>)	Synchronously participates in a session. This method is not recommended for UI threads or scalable server applications.

Participate()

Synchronously participates in a session. This method is not recommended for UI threads or scalable server applications.

public:
 Microsoft::Rtc::Signaling::SipMessageData ^ Participate();

public Microsoft.Rtc.Signaling.SipMessageData Participate ();

member this.Participate : unit -> Microsoft.Rtc.Signaling.SipMessageData

Public Function Participate () As SipMessageData

Returns

SipMessageData

Returns SIP message data th

Exceptions

InvalidOperationException

Thrown when the session is not in a valid state to Participate.

ArgumentException

Thrown when invalid arguments are passed.

ArgumentNullException

Thrown when a non-null value is expected for an argument.

RealTimeException

Thrown when an exception is thrown by the application while generating offer/answer that is not handled by the platform.

Remarks

This method is now deprecated in favor of the BeginEstablish and BeginAccept APIs.

Participate(IEnumerable<SignalingHeader>)

Synchronously participates in a session. This method is not recommended for UI threads or scalable server applications.

public:
 Microsoft::Rtc::Signaling::SipMessageData ^ Participate(System::Collections::Generic::IEnumerable<Microsoft::Rtc::Signaling::SignalingHeader ^> ^ signalingHeaders);

public Microsoft.Rtc.Signaling.SipMessageData Participate (System.Collections.Generic.IEnumerable<Microsoft.Rtc.Signaling.SignalingHeader> signalingHeaders);

member this.Participate : seq<Microsoft.Rtc.Signaling.SignalingHeader> -> Microsoft.Rtc.Signaling.SipMessageData

Public Function Participate (signalingHeaders As IEnumerable(Of SignalingHeader)) As SipMessageData

Parameters

signalingHeaders

IEnumerable<SignalingHeader>

The signaling headers to add. Can be null.

Returns

SipMessageData

Returns the Sip message (200 response or ACK request)

Exceptions

InvalidOperationException

Thrown when the session is not in a valid state to accept, or when Accept is called again while another Accept is pending.

ArgumentException

Thrown when invalid arguments are passed.

ArgumentNullException

Thrown when some other failure occurs.

Remarks

This method is now deprecated in favor of the BeginEstablish and BeginAccept APIs.