RemoveAppointmentOperation class

RemoveAppointmentOperation class

Represents the operation object associated with removing an appointment. Appointments provider apps use this info to perform the operation.

Syntax


var removeAppointmentOperation = promise.operation;

Members

The RemoveAppointmentOperation class has these types of members:

Methods

The RemoveAppointmentOperation class has these methods. With C#, Visual Basic, and C++, it also inherits methods from the Object class.

MethodDescription
DismissUI Dismisses the UI for the operation that removes an appointment.
ReportCanceled Call this method to inform the activating app that the operation was canceled by the user.
ReportCompleted Informs the activating app that the operation was completed successfully.
ReportError Informs the activating app that the operation couldn't be completed because of a provider error.

 

Properties

The RemoveAppointmentOperation class has these properties.

PropertyAccess typeDescription

AppointmentId

Read-only

Gets the unique identifier of the appointment to remove.

InstanceStartDate

Read-only

Gets the start date and time of the appointment instance to remove.

SourcePackageFamilyName

Read-only

Gets the package family name of the app that is requesting the operation.

 

Remarks

This class is used as the value of the RemoveAppointmentOperation event data property from the AppointmentsProviderRemoveAppointmentActivatedEventArgs event data class. An appointments provider app typically goes through a series of casts and property checks starting from the IActivatedEventArgs event data of a general activation event handler. If the activation indicates that it's an AppointmentsProvider app activation kind with Remove as the verb, then it's appropriate to cast event data to AppointmentsProviderRemoveAppointmentActivatedEventArgs.

Providers call methods of RemoveAppointmentOperation to indicate whether the operation was completed, was canceled, or when a provider error prevented the operation from being completed. Calling these methods influences the async results that the activating app gets back from its ShowRemoveAppointmentAsync call. All of the reporting methods (ReportCompleted, ReportCanceled, ReportError) dismiss the Remove Appointment UI.

Requirements (Windows 10 device family)

Device family

Universal, introduced version 10.0.10240.0

API contract

Windows.Foundation.UniversalApiContract, introduced version 1.0

Namespace

Windows.ApplicationModel.Appointments.AppointmentsProvider
Windows::ApplicationModel::Appointments::AppointmentsProvider [C++]

Metadata

Windows.Foundation.UniversalApiContract.winmd

Requirements (Windows 8.x and Windows Phone 8.x)

Minimum supported client

Windows 8.1 [Windows Store apps only]

Minimum supported server

Windows Server 2012 R2 [Windows Store apps only]

Minimum supported phone

None supported

Namespace

Windows.ApplicationModel.Appointments.AppointmentsProvider
Windows::ApplicationModel::Appointments::AppointmentsProvider [C++]

Metadata

Windows.winmd

Attributes

[MarshalingBehavior(Agile)]
[Version(0x06030000)]

 

 

Show:
© 2016 Microsoft