ConferenceServices.BeginCancelConference Method (String, SchedulingTemplate, AsyncCallback, Object)
Deletes a conference scheduled by the endpoint owner.
Namespace: Microsoft.Rtc.Collaboration.ConferenceManagement
Assembly: Microsoft.Rtc.Collaboration (in Microsoft.Rtc.Collaboration.dll)
Syntax
'Declaration
Public Function BeginCancelConference ( _
conferenceId As String, _
schedulingTemplate As SchedulingTemplate, _
userCallback As AsyncCallback, _
state As Object _
) As IAsyncResult
'Usage
Dim instance As ConferenceServices
Dim conferenceId As String
Dim schedulingTemplate As SchedulingTemplate
Dim userCallback As AsyncCallback
Dim state As Object
Dim returnValue As IAsyncResult
returnValue = instance.BeginCancelConference(conferenceId, _
schedulingTemplate, userCallback, _
state)
public IAsyncResult BeginCancelConference(
string conferenceId,
SchedulingTemplate schedulingTemplate,
AsyncCallback userCallback,
Object state
)
Parameters
- conferenceId
Type: System.String
The ID of the conference to delete.
- schedulingTemplate
Type: Microsoft.Rtc.Collaboration.SchedulingTemplate
The template used in scheduling the conference.
- 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 |
---|---|
InvalidOperationException | Thrown when the method failed to issue the request. |
ArgumentException | Thrown when the conference ID is not specified or invalid. |
Remarks
This operation is allowed by the server for existing conferences scheduled by the endpoint owner only.
In order to delete a conference scheduled based on an administrator template, schedulingTemplate should be set to AdministratorSupplied. Note that most UCMA applications should not cancel such conferences as this is an advanced scenario.