Conversation.BeginInviteRemoteParticipants Method (IEnumerable<String>, ToastMessage, AsyncCallback, Object)
NOTE: This API is now obsolete.
This method will be removed from future versions. Instead, use ConferenceInvitation.BeginDeliver(). Begins an asynchronous operation to invite remote participants to the conversation’s conference.
Namespace: Microsoft.Rtc.Collaboration
Assembly: Microsoft.Rtc.Collaboration (in Microsoft.Rtc.Collaboration.dll)
Syntax
'Declaration
<ObsoleteAttribute("This method will be removed from future versions. See ConferenceInvitation.BeginDeliver for more information")> _
Public Function BeginInviteRemoteParticipants ( _
destinationUris As IEnumerable(Of String), _
toastMessage As ToastMessage, _
userCallback As AsyncCallback, _
state As Object _
) As IAsyncResult
'Usage
Dim instance As Conversation
Dim destinationUris As IEnumerable(Of String)
Dim toastMessage As ToastMessage
Dim userCallback As AsyncCallback
Dim state As Object
Dim returnValue As IAsyncResult
returnValue = instance.BeginInviteRemoteParticipants(destinationUris, _
toastMessage, userCallback, state)
[ObsoleteAttribute("This method will be removed from future versions. See ConferenceInvitation.BeginDeliver for more information")]
public IAsyncResult BeginInviteRemoteParticipants(
IEnumerable<string> destinationUris,
ToastMessage toastMessage,
AsyncCallback userCallback,
Object state
)
Parameters
- destinationUris
Type: System.Collections.Generic.IEnumerable<String>
A enumeration of URIs to which invitations to the conference will be sent.
- toastMessage
Type: Microsoft.Rtc.Collaboration.ToastMessage
A short message that can be displayed to the recipient upon receipt. This parameter can be null.
- userCallback
Type: System.AsyncCallback
The method to be called when the asynchronous operation is completed.
- state
Type: System.Object
A user-provided object that distinguishes this particular asynchronous operation from other asynchronous operations.
Return Value
Type: System.IAsyncResult
An IAsyncResult that references the asynchronous operation.
Exceptions
| Exception | Condition |
|---|---|
| ArgumentException | Thrown if any of the method parameters fail validation. |
| InvalidOperationException | Thrown if the conversation does not have a valid conference session. |
Remarks
Sends a conference invitation to each of the destinationUris.
The conversation must already be joined to a conference before calling this method.