Microsoft.Rtc.Collaboration Namespace
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.
Classes
ActiveConferenceService |
Represents a service that the participant may be using and indicates whether the service is active. |
AddToDefaultRoutingOptions |
Represents the options to customize adding an endpoint to the MCU default routing. |
ApplicationEndpoint |
ApplicationEndpoint is a specialization of LocalEndpoint for communication on behalf of services and applications. |
ApplicationEndpointOwnerPropertiesChangedEventArgs |
Represents owner properties that have changed on an endpoint. |
ApplicationEndpointPresenceServices |
This class provides common presence services for ApplicationEndpoint. |
ApplicationEndpointPresenceSettings |
Represents the automatic presence publishing information and settings for RemotePresenceView. |
ApplicationEndpointSettings |
Represents the settings needed to initialize an ApplicationEndpoint. |
ApplicationEndpointSettingsDiscoveredEventArgs |
Represents the information received when an application endpoint owner is discovered. |
ApplicationTopologyData |
Represents topology information related to the application. |
AutoAcceptNeededEventArgs |
AutoAcceptNeededEventArgs is the event argument for the AutoAcceptNeeded event in InstantMessagingCall and ConferenceInvitation. |
BackToBackCall |
Represents a logical SIP network element that resides between two Calls to mediate SIP signaling between both ends of the call. |
BackToBackCallSettings |
Represents the settings for one call leg for a BackToBackCall instance. |
BackToBackCallStateChangedEventArgs |
Represents the information associated with a BackToBackCall state transition. |
BackToBackCallTerminateOptions |
Optional parameters for terminating the BackToBackCall. |
Call |
Represents the signaling path that is established between two endpoints to set up and tear down media channels. |
CallAcceptOptions |
Optional parameters for accepting the incoming call. |
CallDeclineOptions |
Optional parameters for declining the incoming call. |
CallDialogContext |
Represents information specific to a dialog. |
CallEstablishOptions |
Optional parameter for establishing the call. |
CallForwardOptions |
Optional parameter for forwarding the call. |
CallForwardReceivedEventArgs |
Represents information received when a call is forwarded by the remote endpoint. |
CallMessageData |
Represents protocol requests and responses relevant to the operation that completed. |
CallMessageReceivedEventArgs |
Represents the information associated with a message received on Call. |
CallOperationFailureException |
Defines the exception to capture error conditions associated with call failures. |
CallOrbit |
Represents orbit details for parking and retrieving a call. |
CallParkOptions |
Optional parameters for parking the call. |
CallParkResponseData |
Represents response data associated with the call park operation. |
CallParticipantEndpointProperties |
Represents the properties of the call remote endpoint. |
CallProvisionalResponseOptions |
Optional parameter for sending the provisional response on incoming call. |
CallProvisionalResponseReceivedEventArgs |
Represents information associated with the reception of a provisional response (advanced usage.) |
CallReceivedEventArgs<TCall> |
Contains information regarding an incoming call. |
CallReceivedEventArgsBase |
Contains information regarding an incoming call. |
CallSendMessageRequestOptions |
Optional parameters for sending message request in a call. |
CallSendMessageResponseOptions |
Optional parameters for sending response for incoming message request in a call. |
CallStateChangedEventArgs |
Represents the information associated with a Call state transition. |
CallTerminateOptions |
Optional parameters for terminating the call. |
CallTransferNotificationOptions |
Optional parameters for sending explicit transfer notifications. |
CallTransferOptions |
Optional parameters for transfering the call. |
CallTransferReceivedEventArgs |
Represents information associated with the reception of a transfer. |
ClientPlatformSettings |
Represents the settings typically used for creating a client platform instance. |
CollaborationPlatform |
Represents an instance of the SIP stack. |
CommandFailureReasons |
Constants defining known command failure codes. |
ComposingStateChangedEventArgs |
Event arguments that contain the data related to composing state of the remote participant. on the InstantMessagingCall. |
Conference |
Full conference information. |
ConferenceCommandOptions |
Represents common options that an application can set to customize a specific conference command. |
ConferenceCommandResponse |
Contains basic information about a completed command. |
ConferenceFailureException |
Defines the exception to capture error conditions associated with conference commands. |
ConferenceInvitation |
Receives and responds to an invitation to join a conference. |
ConferenceInvitationAcceptOptions |
A data struture containing options which can be applied when accepting a ConferenceInvitation. |
ConferenceInvitationDeclineOptions |
A data structure containing options which can be applied when declining a ConferenceInvitation. |
ConferenceInvitationDeliverOptions |
Optional parameter for delivering a conference invitation. |
ConferenceInvitationDialOutOptions |
Options to be used when a ConferenceInvitation falls back to a dial-out from the conference. |
ConferenceInvitationReceivedEventArgs |
Data structure containing the arguments for the ConferenceInvitationReceivedevent. |
ConferenceInvitationResponse |
Contains the remote participant’s response to the conference invitation. |
ConferenceInvitationSettings |
Captures the initial ConferenceInvitation settings. |
ConferenceInvitationStateChangedEventArgs |
ConferenceInvitationStateChangedEventArgs is the event argument for the StateChanged event. |
ConferenceJoinInformation |
This class will be removed from future versions. Instead, use ConferenceJoinOptions to customize joining a conference. Contains information to customize joining a conference. |
ConferenceJoinOptions |
Contains options to customize joining a conference. |
ConferenceParticipantEndpointProperties |
Reports property values for participant endpoints with the focus. |
ConferenceSession |
ConferenceSession enables an application to join a conference and perform other operations related to an activated conference. |
ConferenceSessionExtendedProperties |
Represents extended properties of the conference. |
ConferenceSessionProperties |
Properties of the conference. |
ConferencingCapabilities |
Conferencing capabilities. |
Conversation |
Represents a multi-party, multi-modal call contexts between a local participant and one or more remote participants. |
ConversationChangedEventArgs |
Represents the information supplied when a call is moved to a derived Conversation. |
ConversationContextChannel |
Represents a channel to communicate with a custom application running on remote endpoint. |
ConversationContextChannelDataReceivedEventArgs |
Represents the data received on a ConversationContextChannel. |
ConversationContextChannelEstablishOptions |
Represents optional parameters for establishing a ConversationContextChannel. |
ConversationContextChannelStateChangedEventArgs |
Represents the information associated with a ConversationContextChannel state transition. |
ConversationParticipant |
Represents a participant in the conversation. |
ConversationParticipantProperties |
Represents the properties of a conversation used for property changed event. |
ConversationPriority |
Conversation Priority values. |
ConversationProperties |
Represents the properties of a conversation used for property changed event. |
ConversationSettings |
Represents settings that can be applied when creating a conversation. |
ConversationTerminateOptions |
Represents optional parameters for terminating the conversation. |
DeliveryNotificationReceivedEventArgs |
Provides information regarding delivery status of a previously sent message. |
DiversionContext |
This class represents information available in an incoming call that indicates the forwarding parties before the call was received. |
DivertedDestination |
This class provides information regarding a diverted destination for an incoming call. |
EjectOptions |
Represents options that an application can use to customize modifying the ejection of a participant. |
EscalateToConferenceRequestedEventArgs |
Data structure containing the arguments for the EscalateToConferenceRequested event. |
InstantMessageId |
Provides a unique identification (ID) for an instant message. |
InstantMessageReceivedEventArgs |
Gets the data in an incoming message from the conversation. |
InstantMessagingCall |
InstantMessagingCall is the class that supports instant messaging-based communication. |
InstantMessagingFlow |
Represents the media in and InstantMessagingCall. |
InstantMessagingFlowConfigurationRequestedEventArgs |
Represents EventArgs for the InstantMessagingFlowConfigurationRequested event. |
InstantMessagingFlowProperties |
Represents properties for instant messaging flow. |
InstantMessagingFlowPropertiesChangedEventArgs |
Represents information received when the properties of an InstantMessagingFlow instance changes. |
InstantMessagingFlowTemplate |
Represents settings for an InstantMessagingFlow instance. |
InstantMessagingMcuParticipantEndpointProperties |
Class to hold properties for participants joined to the Instant Messaging MCU. |
InstantMessagingMcuSession |
Allows requests to be made to the Instant Messaging MCU. |
InstantMessagingMcuSessionProperties |
Represents properties for the InstantMessagingMcuSession. |
InstantMessagingMediaCapabilities |
Represents instant messaging media capabilities. |
InviteParticipantUpdateEventArgs |
This class will be removed from future versions. Data structure containing the arguments for the InviteRemoteParticipantUpdate event. |
LobbyAdmitOptions |
Represents options that an application can use to customize admitting lobby participants into a conference. |
LobbyDenyOptions |
Represents options that an application can use to customize denying lobby participants admission into the conference. |
LobbyManager |
Represents operations that a conference leader can perform with respect to the lobby and lobby participants. |
LobbyOperationResponse |
Represents the results of admitting or denying lobby participants. |
LobbyParticipantAttendanceChangedEventArgs |
Represents information about participants who land into the conference lobby and participants who were admitted into the conference from the lobby or who left the lobby. |
LocalEndpoint |
Represents an endpoint used by the current application to communicate and collaborate with other endpoints. |
LocalEndpointPresenceServices |
Represents the base class which provide presence services related to publication of local presence data and subscription to remote presentities. |
LocalEndpointSettings |
Represents the base type for settings needed to initialize an LocalEndpoint. |
LocalEndpointStateChangedEventArgs |
Represents the information associated with a LocalEndpoint state transition. |
LockConferenceOptions |
Represents options that an application can use to customize locking a conference. |
McuDialInOptions |
Represents options that an application can use to customize when dialing-out to a participant through a MCU. |
McuDialOutOptions |
MCU Dial-out options. |
McuInformation |
Describes an allocated conference MCU address. |
McuMediaChannel |
Represents a media for an MCU or Endpoint. |
McuSession |
Encapsulates common MCU operations and events. |
McuSessionProperties |
Used to communicate parsed MCU properties in an MCU implementation. |
McuTransferOptions |
MCU Transfer options. |
MediaChannelEstablishmentData |
Represents Media channel establishment data. This class provides establishment details about a particular media channel. |
MediaFlowStateChangedEventArgs |
EventArgs for MediaFlow.StateChanged event. |
MediaTroubleshootingDataReportedEventArgs |
This class provides media troubleshooting information that can be used for monitoring purposes. |
MediaType |
The names of common media types. |
MeetNowOptions |
Represents the option to start an ad hoc meeting which is accessible to the widest possible audience. |
MessageDeliveryFailureData |
Provides information regarding delivery failure of a previously sent message to a specific participant. |
MimePartContentDescription |
Represents a part of a MIME body of a SIP message. A part can represent SDP part or a custom part or a mime/alternative part or a mime/mixed part of a mime body. |
ModifyConferenceConfigurationOptions |
Represents options to customize the operation of modifying a conference configuration. |
ModifyRoleOptions |
Represents options that an application can use to customize modifying the role of another conference participant. |
OfferAnswerException |
Indicates reason for offer/answer exception. |
ParticipantAttendanceChangedEventArgs |
Represents information regarding participants that get added or removed in a conversation or conference or MCU. |
ParticipantEndpoint |
Represents an endpoint for a participant in the conversation. |
ParticipantEndpointAttendanceChangedEventArgs<TProperties> | |
ParticipantEndpointPropertiesChangedEventArgs<TProperties> | |
ParticipantPropertiesChangedEventArgs |
Represents information about updated properties for a conversation participant. |
ParticipantPropertiesChangedEventArgs<TProperties> | |
PlatformExtension |
Class which holds common functionality for all extensions to the platform. |
PlatformExtensionType |
The list of supported extension types |
PreferredServiceCapabilities |
Specifies what should be the initial device capabilities of the endpoint. |
PresenceSettings |
Represents the presence settings that must be used during endpoint establishment. |
PropertiesChangedEventArgs<TProperties> |
Represents properties that have changed on an object. |
ProvisionedApplicationPlatformSettings |
Represents the settings needed to create an automatically provisioned server platform. |
ProvisioningFailedEventArgs |
Represents the information received when a failure occurs in applying or accessing provisioning information. |
ProvisioningFailureException |
Defines the exception to be thrown when auto provisioning fails. |
RemoteMediaFlowStateChangedEventArgs |
Represents the event argument for RemoteMediaFlowStateChanged event in back to back call. |
RemoteParticipantChangedEventArgs |
Represents the information received when the remote participant of the call changes. |
RemoveFromDefaultRoutingOptions |
Represents the options to customize removing an endpoint from the MCU default routing. |
RePublishingRequiredEventArgs |
Defines EventsArgs to be passed for republishing a required event raised by local endpoint. |
SdpAnswer |
SdpAnswer, contains the Sdp answer message being send out or receceived from remote endpoint. |
SdpContentDescription |
SdpContentDescription class contains the contentId and content type and content body. |
SdpOffer |
SdpOffer, contains the sdp offer message received from the remote endpoint or sdp offer being send to the remote endpoint. |
SendInstantMessageResult |
Represents the result of sending an instant message to remote participants in a conversation. |
ServerPlatformSettings |
Represents the settings typically used for creating a server platform instance. |
TerminationCountdownStatusChangedEventArgs |
Represents information about the status of automatic conference termination. |
ToastMessage |
Represents the toast message that can be sent along with an INVITE. |
TopologyConfiguration |
Represents various topology configuration data. |
TransferStateChangedEventArgs |
Represents the information associated with the status of a transfer accepted by the remote endpoint. |
TrustedDomain |
This class represents a domain and its type. |
UnlockConferenceOptions |
Represents options that an application can use to customize unlocking a conference. |
UserEndpoint |
UserEndpoint is a specialization of LocalEndpoint for communication on behalf of information workers. |
UserEndpointPresenceServices |
This class provides common presence services for UserEndpoint. |
UserEndpointSettings |
Represents the settings needed to initialize a User endpoint. |
UserPresenceSettings |
Represents the automatic presence publishing information and settings for RemotePresenceView. |
Enums
AttendanceAnnouncementsStatus |
Represents the different states for attendance announcements in a conference. |
AutomaticLeaderAssignment |
Defines which users are automatically promoted to leaders upon joining a conference. |
BackToBackCallState |
Defines the state of the BackToBackCall. |
CallOperationFailureReason |
Indicates the reason for the failure of a call operation. |
CallState |
Defines the state of the call. |
CallStateTransitionReason |
Defines the reasons for call state transitions. |
CallTransferType |
Type of call transfer - Attended or Unattended. |
CapabilitySupport |
Represents capabilities supported. |
CommandStatusCode |
Contains the known command status codes. |
ComposingState |
Represents the composing state for participant in a InstantMessagingCall. |
ConferenceAccessLevel |
Represents the access levels used to control access to a conference. |
ConferenceAccessMethod |
Represents whether the client is accessing from inside or outside the organization. |
ConferenceAuthenticationMethod |
Represents the types of authentication methods. |
ConferenceEndpointState |
Represents the status of the conference endpoint. |
ConferenceInvitationState |
An enumeration of possible conference invitation states. |
ConferenceInvitationStateTransitionReason |
Reasons for conference invitation state transition. |
ConferenceInvitationStatus |
This enumerated type will be removed from future versions. Instead use BeginDeliver and EndDeliver methods on ConferenceInvitation. Represents the possible responses to a ConferenceInvitation. |
ConferenceJoinMethod |
Represents how the conference was joined. |
ConferenceRecordingPolicy |
Represents the policy set by the enterprise administrator for recording conferences. |
ConferenceSessionState |
The state of the conference session. |
ConferencingRole |
Represents the participant conferencing role, if applicable. |
ConferencingRosterVisibility |
Represents the visibility of the participant in the conference roster. |
ConversationChangedReason |
Enumerates the reasons when the conversation of the call will be changed. |
ConversationContextChannelState |
Represents the state of a ConversationContextChannel. |
ConversationContextChannelStateTransitionReason |
Represents the reasons for changes in ConversationContextChannel states. |
ConversationState |
Represents the possible states for a conversation. |
DiversionContextSource |
Represents sources from which from which the diversion context information is derived from. |
EndpointSubtype |
Indicates the endpoint sub-type for an endpoint of type "Application". |
EndpointType |
Advertises the type of endpoint in a communication. |
InstantMessageConsumptionMode |
Indicates how the application handles instant messages. |
InstantMessagingBlockAllMode |
Represents whether instant messaging is blcoked in this conversation. |
InstantMessagingFormat |
Standard commonly used message formats. |
JoinMode |
Represents the conference join mode. |
LobbyBypass |
Represents types of users who bypass the lobby. |
LobbyOperationFailureReason |
Enumerates the failure reasons on admitting or denying a participant access to the lobby. |
LobbyRemovalReason |
Defines reasons for removing a participant from the lobby list. |
LocalEndpointState |
Represents the different values of the local endpoint state. |
LocalEndpointStateTransitionReason |
Indicates possible reasons for a LocalEndpoint's state transitions. |
McuMediaChannelStatus |
Represents the SDP media direction attributes. |
McuSessionState |
The states for the MCU. |
MediaChannelEstablishmentDiagnosticsReason |
Represents various media channel establishment diagnostics reasons. |
MediaChannelEstablishmentStatus |
Represents various media channel establishment status. |
MediaEdgeResourceAllocationDiagnosticsReason |
Represents various media edge resource allocation diagnostics reasons. |
MediaFlowState |
Represents the possible states for a media flow. |
OfferAnswerFailureReason |
Failure reason, used with OfferAnswerException to indicate the reason for the error. |
OperationState |
Represents the state of an operation. |
PrivacyOptions |
Various privacy options that will be part of Ms-Sensitivity-Header |
ProvisioningFailureReason |
Indicates the reason for the failure of a provisioning operation. |
RemoteMediaFlowState |
Provides hint for the state of the media flow between remote participants of a back to back call. |
SchedulingTemplate |
Represents the method used in scheduling a conference. |
SdpAnswerStatus |
Status of the SdpAnswer. |
SourceNetwork |
Represents the network type from which a user is connecting. |
TerminationCountdownStatus |
Represents the status of automatic conference termination timer. |
TrustedDomainMode |
This enum represents the mode of interoperability with a trusted domain for audio calls. |
Delegates
IncomingCallDelegate<TCall> |
Represents the delegate signature of a typical handler for an application to handle
an incoming call of type |