Asynchronously invites a party to a conference.
Namespace: ININ.IceLib.InteractionsAssembly: ININ.IceLib.Interactions (in ININ.IceLib.Interactions.dll) Version: 0.0.0.0 (22.3.0.218)
Syntax
C# |
---|
public void InvitePartyAsync( InteractionId inviteTo, InvitePartyParameters inviteParameters, EventHandler<InvitePartyCompletedEventArgs> completedCallback, Object userState ) |
Visual Basic |
---|
Public Sub InvitePartyAsync ( _ inviteTo As InteractionId, _ inviteParameters As InvitePartyParameters, _ completedCallback As EventHandler(Of InvitePartyCompletedEventArgs), _ userState As Object _ ) |
Parameters
- inviteTo
- Type: ININ.IceLib.Interactions..::..InteractionId
The interaction ID to invite to.
- inviteParameters
- Type: ININ.IceLib.Interactions..::..InvitePartyParameters
The invite parameters.
- completedCallback
- Type: System..::..EventHandler<(Of <(<'InvitePartyCompletedEventArgs>)>)>
The callback to invoke when the asynchronous operation completes.
- userState
- Type: System..::..Object
An object that contains state information for this request.
Remarks
When completed, the completedCallback delegate is invoked on a thread appropriate to the application-model, such as the GUI thread in a UI application. The Error property of the AsyncCompletedEventArgs-derived object passed to the delegate will contain any exceptions thrown while executing the asynchronous task. See the synchronous version of this method for more detailed error information.
Exceptions
Exception | Condition |
---|---|
System..::..ArgumentNullException | A parameter is a null reference (Nothing in Visual Basic). |
System..::..ArgumentException | A parameter contains an invalid value. |
System..::..NotSupportedException | inviteParameters is Started. |
ININ.IceLib..::..NotCachedException | The associated attribute is not being watched. |
ININ.IceLib.Connection..::..RequestTimeoutException | The request timed out while waiting for a response. |
ININ.IceLib.Connection..::..SessionDisconnectedException | The Session does not have a valid connection. |
System..::..ObjectDisposedException | The Session has been disposed. |
Version Information
Supported for IC Server version 2015 R1 and beyond.
For 4.0, supported for IC Server version 4.0 GA and beyond.
For 4.0, supported for IC Server version 4.0 GA and beyond.