ParticipateState Enumeration
Enumerates the participate states of [Activity] and [CollaborationSession] objects.
Namespace: Microsoft.Rtc.Signaling
Assembly: Microsoft.Rtc.Collaboration (in Microsoft.Rtc.Collaboration.dll)
Syntax
'Declaration
Public Enumeration ParticipateState
'Usage
Dim instance As ParticipateState
public enum ParticipateState
Members
| Member name | Description | |
|---|---|---|
| Idle | Neither the Participate nor Terminate state have been called. The Idle state can go to Participate or Terminate states. | |
| Participated | Participate has been called. Participate can only be reached from the Idle state. | |
| Terminating | Terminate has been called. The terminate work is in progress. | |
| Terminated | Terminate has been called. The Terminate state can be reached from the Idle or Participate states. When in the Terminate state, the state can no longer change and calling Participate is an [InvalidOperationException]. |
Remarks
Indicates what methods have been called on the object ([Activity]/[CollaborationSession]). The [ParticipateState] records which methods have been called when the object is in the Idle or Incoming [SignalingState]. It can be used to determine whether a Participate or Terminate is being processed before the state change happens.