AppointmentManagerForUser AppointmentManagerForUser AppointmentManagerForUser AppointmentManagerForUser Class

Definition

Represents an appointment manager for a specific user.

public : sealed class AppointmentManagerForUser : IAppointmentManagerForUserpublic sealed class AppointmentManagerForUser : IAppointmentManagerForUserPublic NotInheritable Class AppointmentManagerForUser Implements IAppointmentManagerForUser// You can use this class in JavaScript.
Attributes
Windows 10 requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

Remarks

Call the AppointmentManager.GetForUser method to get an instance of this class.

Properties

User User User User

Gets the User represented by this appointment manager.

public : User User { get; }public User User { get; }Public ReadOnly Property User As User// You can use this property in JavaScript.
Value
User User User User

The User represented by this appointment manager.

Methods

RequestStoreAsync(AppointmentStoreAccessType) RequestStoreAsync(AppointmentStoreAccessType) RequestStoreAsync(AppointmentStoreAccessType) RequestStoreAsync(AppointmentStoreAccessType)

Retrieves an AppointmentStore object that enables searching or retrieving appointments on the device.

public : IAsyncOperation<AppointmentStore> RequestStoreAsync(AppointmentStoreAccessType options)public IAsyncOperation<AppointmentStore> RequestStoreAsync(AppointmentStoreAccessType options)Public Function RequestStoreAsync(options As AppointmentStoreAccessType) As IAsyncOperation( Of AppointmentStore )// You can use this method in JavaScript.
Parameters
Returns

ShowAddAppointmentAsync(Appointment, Rect) ShowAddAppointmentAsync(Appointment, Rect) ShowAddAppointmentAsync(Appointment, Rect) ShowAddAppointmentAsync(Appointment, Rect)

Shows the Appointments provider Add Appointment UI, to enable the user to add an appointment.

public : IAsyncOperation<PlatForm::String> ShowAddAppointmentAsync(Appointment appointment, Rect selection)public IAsyncOperation<string> ShowAddAppointmentAsync(Appointment appointment, Rect selection)Public Function ShowAddAppointmentAsync(appointment As Appointment, selection As Rect) As IAsyncOperation( Of string )// You can use this method in JavaScript.
Parameters
appointment
Appointment Appointment Appointment Appointment

The object representing the information for the appointment to add.

selection
Rect Rect Rect Rect

The Rect is the rectangular area of user selection (for example, pressing a button), around which the operating system displays the Add Appointment UI, not within that rectangular area. For example, if an app uses a button to show the Rect, pass the Rect of the button so the Add Appointment UI displays around the button, not overlapping it.

Returns

When this method completes, it returns a String object that represents the appointment. This serves as an appointment identifier for future reference when updating or removing. If the appointment identifier returned is an empty string, the appointment was not added to the Appointments provider app.

Remarks

When you call this method, the Appointment provider app displays in a light-dismiss pane that is hosted by your app.

On Windows Phone, this method behaves the same as ShowEditNewAppointmentAsync, in that the fields in the Add Appointment UI are editable by the user.

See Also

ShowAddAppointmentAsync(Appointment, Rect, Placement) ShowAddAppointmentAsync(Appointment, Rect, Placement) ShowAddAppointmentAsync(Appointment, Rect, Placement) ShowAddAppointmentAsync(Appointment, Rect, Placement)

Shows the Appointments provider Add Appointment UI, to enable the user to add an appointment.

public : IAsyncOperation<PlatForm::String> ShowAddAppointmentAsync(Appointment appointment, Rect selection, Placement preferredPlacement)public IAsyncOperation<string> ShowAddAppointmentAsync(Appointment appointment, Rect selection, Placement preferredPlacement)Public Function ShowAddAppointmentAsync(appointment As Appointment, selection As Rect, preferredPlacement As Placement) As IAsyncOperation( Of string )// You can use this method in JavaScript.
Parameters
appointment
Appointment Appointment Appointment Appointment

The object representing the information for the appointment to add.

selection
Rect Rect Rect Rect

The Rect is the rectangular area of user selection (for example, pressing a button), around which the operating system displays the Add Appointment UI, not within that rectangular area. For example, if an app uses a button to show the Rect, pass the Rect of the button so the Add Appointment UI displays around the button, not overlapping it.

preferredPlacement
Placement Placement Placement Placement

The Placement that describes the preferred placement of the Add Appointment UI.

Returns

When this method completes, it returns a String object that represents the appointment. This serves as an appointment identifier for future reference when updating or removing. If the appointment identifier returned is an empty string, the appointment was not added to the Appointments provider app.

Remarks

When you call this method, the Appointment provider app displays in a light-dismiss pane that is hosted by your app.

On Windows Phone, this method behaves the same as ShowEditNewAppointmentAsync, in that the fields in the Add Appointment UI are editable by the user.

See Also

ShowAppointmentDetailsAsync(String) ShowAppointmentDetailsAsync(String) ShowAppointmentDetailsAsync(String) ShowAppointmentDetailsAsync(String)

Shows the Appointments provider Appointment Details UI, to enable the user to view the specified appointment.

public : IAsyncAction ShowAppointmentDetailsAsync(PlatForm::String appointmentId)public IAsyncAction ShowAppointmentDetailsAsync(String appointmentId)Public Function ShowAppointmentDetailsAsync(appointmentId As String) As IAsyncAction// You can use this method in JavaScript.
Parameters
appointmentId
PlatForm::String String String String

The LocalId of the appointment to be displayed.

Returns

When this method returns, it does not return a result. On completion, the AsyncActionCompletedHandler specified by get_Completed / Completed is invoked.

See Also

ShowAppointmentDetailsAsync(String, DateTime) ShowAppointmentDetailsAsync(String, DateTime) ShowAppointmentDetailsAsync(String, DateTime) ShowAppointmentDetailsAsync(String, DateTime)

Shows the Appointments provider Appointment Details UI, to enable the user to view the specified appointment.

public : IAsyncAction ShowAppointmentDetailsAsync(PlatForm::String appointmentId, DateTime instanceStartDate)public IAsyncAction ShowAppointmentDetailsAsync(String appointmentId, DateTimeOffset instanceStartDate)Public Function ShowAppointmentDetailsAsync(appointmentId As String, instanceStartDate As DateTimeOffset) As IAsyncAction// You can use this method in JavaScript.
Parameters
appointmentId
PlatForm::String String String String

The LocalId of the appointment to be displayed.

instanceStartDate
DateTime DateTimeOffset DateTimeOffset DateTimeOffset

A DateTime object with the start time of the appointment instance to be displayed.

Returns

When this method returns, it does not return a result. On completion, the AsyncActionCompletedHandler specified by get_Completed / Completed is invoked.

See Also

ShowEditNewAppointmentAsync(Appointment) ShowEditNewAppointmentAsync(Appointment) ShowEditNewAppointmentAsync(Appointment) ShowEditNewAppointmentAsync(Appointment)

Shows the Appointments provider Add Appointment UI including the full edit experience, to enable the user to add an appointment.

public : IAsyncOperation<PlatForm::String> ShowEditNewAppointmentAsync(Appointment appointment)public IAsyncOperation<string> ShowEditNewAppointmentAsync(Appointment appointment)Public Function ShowEditNewAppointmentAsync(appointment As Appointment) As IAsyncOperation( Of string )// You can use this method in JavaScript.
Parameters
appointment
Appointment Appointment Appointment Appointment

The new appointment to be added.

Returns

An asynchronous operation that returns a string containing an appointment ID upon successful completion.

ShowRemoveAppointmentAsync(String, Rect) ShowRemoveAppointmentAsync(String, Rect) ShowRemoveAppointmentAsync(String, Rect) ShowRemoveAppointmentAsync(String, Rect)

Shows the Appointments provider Remove Appointment UI, to enable the user to remove an appointment.

public : IAsyncOperation<PlatForm::Boolean> ShowRemoveAppointmentAsync(PlatForm::String appointmentId, Rect selection)public IAsyncOperation<bool> ShowRemoveAppointmentAsync(String appointmentId, Rect selection)Public Function ShowRemoveAppointmentAsync(appointmentId As String, selection As Rect) As IAsyncOperation( Of bool )// You can use this method in JavaScript.
Parameters
appointmentId
PlatForm::String String String String

The appointment identifier. This is typically obtained from the async return value of a previous ShowAddAppointmentAsync call.

selection
Rect Rect Rect Rect

The Rect is the rectangular area of user selection (for example, pressing a button), around which the operating system displays the Remove Appointment UI, not within that rectangular area. For example, if an app uses a button to show the Rect, pass the Rect of the button so the Remove Appointment UI displays around the button, not overlapping it.

Returns

When this method completes, it returns a Boolean value that indicates whether the Appointment provider app removed the appointment.

Remarks

When you call this method, the Appointment provider app displays in a light-dismiss pane that is hosted by your app.

This method may return false, even when the appointment was successfully removed.

See Also

ShowRemoveAppointmentAsync(String, Rect, Placement) ShowRemoveAppointmentAsync(String, Rect, Placement) ShowRemoveAppointmentAsync(String, Rect, Placement) ShowRemoveAppointmentAsync(String, Rect, Placement)

Shows the Appointments provider Remove Appointment UI, to enable the user to remove an appointment.

public : IAsyncOperation<PlatForm::Boolean> ShowRemoveAppointmentAsync(PlatForm::String appointmentId, Rect selection, Placement preferredPlacement)public IAsyncOperation<bool> ShowRemoveAppointmentAsync(String appointmentId, Rect selection, Placement preferredPlacement)Public Function ShowRemoveAppointmentAsync(appointmentId As String, selection As Rect, preferredPlacement As Placement) As IAsyncOperation( Of bool )// You can use this method in JavaScript.
Parameters
appointmentId
PlatForm::String String String String

The appointment identifier. This is typically obtained from the async return value of a previous ShowAddAppointmentAsync call.

selection
Rect Rect Rect Rect

The Rect is the rectangular area of user selection (for example, pressing a button), around which the operating system displays the Remove Appointment UI, not within that rectangular area. For example, if an app uses a button to show the Rect, pass the Rect of the button so the Remove Appointment UI displays around the button, not overlapping it.

preferredPlacement
Placement Placement Placement Placement

The Placement that describes the preferred placement of the Remove Appointment UI.

Returns

When this method completes, it returns a Boolean value that indicates whether the Appointment provider app removed the appointment.

Remarks

When you call this method, the Appointment provider app displays in a light-dismiss pane that is hosted by your app.

This method may return false, even when the appointment was successfully removed.

See Also

ShowRemoveAppointmentAsync(String, Rect, Placement, DateTime) ShowRemoveAppointmentAsync(String, Rect, Placement, DateTime) ShowRemoveAppointmentAsync(String, Rect, Placement, DateTime) ShowRemoveAppointmentAsync(String, Rect, Placement, DateTime)

Shows the Appointments provider Remove Appointment UI, to enable the user to remove an appointment.

public : IAsyncOperation<PlatForm::Boolean> ShowRemoveAppointmentAsync(PlatForm::String appointmentId, Rect selection, Placement preferredPlacement, DateTime instanceStartDate)public IAsyncOperation<bool> ShowRemoveAppointmentAsync(String appointmentId, Rect selection, Placement preferredPlacement, DateTimeOffset instanceStartDate)Public Function ShowRemoveAppointmentAsync(appointmentId As String, selection As Rect, preferredPlacement As Placement, instanceStartDate As DateTimeOffset) As IAsyncOperation( Of bool )// You can use this method in JavaScript.
Parameters
appointmentId
PlatForm::String String String String

The appointment identifier. This is typically obtained from the async return value of a previous ShowAddAppointmentAsync call.

selection
Rect Rect Rect Rect

The Rect is the rectangular area of user selection (for example, pressing a button), around which the operating system displays the Remove Appointment UI, not within that rectangular area. For example, if an app uses a button to show the Rect, pass the Rect of the button so the Remove Appointment UI displays around the button, not overlapping it.

preferredPlacement
Placement Placement Placement Placement

The Placement that describes the preferred placement of the Remove Appointment UI.

instanceStartDate
DateTime DateTimeOffset DateTimeOffset DateTimeOffset

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

Returns

When this method completes, it returns a Boolean value that indicates whether the Appointment provider app removed the appointment.

Remarks

When you call this method, the Appointment provider app displays in a light-dismiss pane that is hosted by your app.

This method may return false, even when the appointment was successfully removed.

See Also

ShowReplaceAppointmentAsync(String, Appointment, Rect) ShowReplaceAppointmentAsync(String, Appointment, Rect) ShowReplaceAppointmentAsync(String, Appointment, Rect) ShowReplaceAppointmentAsync(String, Appointment, Rect)

Shows the Appointments provider Replace Appointment UI, to enable the user to replace an appointment.

public : IAsyncOperation<PlatForm::String> ShowReplaceAppointmentAsync(PlatForm::String appointmentId, Appointment appointment, Rect selection)public IAsyncOperation<string> ShowReplaceAppointmentAsync(String appointmentId, Appointment appointment, Rect selection)Public Function ShowReplaceAppointmentAsync(appointmentId As String, appointment As Appointment, selection As Rect) As IAsyncOperation( Of string )// You can use this method in JavaScript.
Parameters
appointmentId
PlatForm::String String String String

The appointment identifier of the current appointment. This is typically obtained from the async return value of a previous ShowAddAppointmentAsync or ShowReplaceAppointmentAsync call.

appointment
Appointment Appointment Appointment Appointment

The object representing the information for the appointment to replace the current appointment.

selection
Rect Rect Rect Rect

The Rect is the rectangular area of user selection (for example, pressing a button), around which the operating system displays the Replace Appointment UI, not within that rectangular area. For example, if an app uses a button to show the Rect, pass the Rect of the button so the Replace Appointment UI displays around the button, not overlapping it.

Returns

When this method completes, it returns a String object that represents the appointment. This serves as an appointment identifier for future reference when updating or removing. If the appointment identifier returned is an empty string, the appointment was not replaced in the Appointments provider app.

See Also

ShowReplaceAppointmentAsync(String, Appointment, Rect, Placement) ShowReplaceAppointmentAsync(String, Appointment, Rect, Placement) ShowReplaceAppointmentAsync(String, Appointment, Rect, Placement) ShowReplaceAppointmentAsync(String, Appointment, Rect, Placement)

Shows the Appointments provider Replace Appointment UI, to enable the user to replace an appointment.

public : IAsyncOperation<PlatForm::String> ShowReplaceAppointmentAsync(PlatForm::String appointmentId, Appointment appointment, Rect selection, Placement preferredPlacement)public IAsyncOperation<string> ShowReplaceAppointmentAsync(String appointmentId, Appointment appointment, Rect selection, Placement preferredPlacement)Public Function ShowReplaceAppointmentAsync(appointmentId As String, appointment As Appointment, selection As Rect, preferredPlacement As Placement) As IAsyncOperation( Of string )// You can use this method in JavaScript.
Parameters
appointmentId
PlatForm::String String String String

The appointment identifier of the current appointment. This is typically obtained from the async return value of a previous ShowAddAppointmentAsync or ShowReplaceAppointmentAsync call.

appointment
Appointment Appointment Appointment Appointment

The object representing the information for the appointment to replace the current appointment.

selection
Rect Rect Rect Rect

The Rect is the rectangular area of user selection (for example, pressing a button), around which the operating system displays the Replace Appointment UI, not within that rectangular area. For example, if an app uses a button to show the Rect, pass the Rect of the button so the Replace Appointment UI displays around the button, not overlapping it.

preferredPlacement
Placement Placement Placement Placement

The Placement that describes the preferred placement of the Replace Appointment UI.

Returns

When this method completes, it returns a String object that represents the appointment. This serves as an appointment identifier for future reference when updating or removing. If the appointment identifier returned is an empty string, the appointment was not replaced in the Appointments provider app.

See Also

ShowReplaceAppointmentAsync(String, Appointment, Rect, Placement, DateTime) ShowReplaceAppointmentAsync(String, Appointment, Rect, Placement, DateTime) ShowReplaceAppointmentAsync(String, Appointment, Rect, Placement, DateTime) ShowReplaceAppointmentAsync(String, Appointment, Rect, Placement, DateTime)

Shows the Appointments provider Replace Appointment UI, to enable the user to replace an appointment.

public : IAsyncOperation<PlatForm::String> ShowReplaceAppointmentAsync(PlatForm::String appointmentId, Appointment appointment, Rect selection, Placement preferredPlacement, DateTime instanceStartDate)public IAsyncOperation<string> ShowReplaceAppointmentAsync(String appointmentId, Appointment appointment, Rect selection, Placement preferredPlacement, DateTimeOffset instanceStartDate)Public Function ShowReplaceAppointmentAsync(appointmentId As String, appointment As Appointment, selection As Rect, preferredPlacement As Placement, instanceStartDate As DateTimeOffset) As IAsyncOperation( Of string )// You can use this method in JavaScript.
Parameters
appointmentId
PlatForm::String String String String

The appointment identifier of the current appointment. This is typically obtained from the async return value of a previous ShowAddAppointmentAsync or ShowReplaceAppointmentAsync call.

appointment
Appointment Appointment Appointment Appointment

The object representing the information for the appointment to replace the current appointment.

selection
Rect Rect Rect Rect

The Rect is the rectangular area of user selection (for example, pressing a button), around which the operating system displays the Replace Appointment UI, not within that rectangular area. For example, if an app uses a button to show the Rect, pass the Rect of the button so the Replace Appointment UI displays around the button, not overlapping it.

preferredPlacement
Placement Placement Placement Placement

The Placement that describes the preferred placement of the Replace Appointment UI.

instanceStartDate
DateTime DateTimeOffset DateTimeOffset DateTimeOffset

The start date and time of the appointment instance to replace.

Returns

When this method completes, it returns a String object that represents the appointment. This serves as an appointment identifier for future reference when updating or removing. If the appointment identifier returned is an empty string, the appointment was not replaced in the Appointments provider app.

See Also

ShowTimeFrameAsync(DateTime, TimeSpan) ShowTimeFrameAsync(DateTime, TimeSpan) ShowTimeFrameAsync(DateTime, TimeSpan) ShowTimeFrameAsync(DateTime, TimeSpan)

Shows the Appointments provider app's primary UI. This typically displays a time frame from an appointments calendar.

public : IAsyncAction ShowTimeFrameAsync(DateTime timeToShow, TimeSpan duration)public IAsyncAction ShowTimeFrameAsync(DateTimeOffset timeToShow, TimeSpan duration)Public Function ShowTimeFrameAsync(timeToShow As DateTimeOffset, duration As TimeSpan) As IAsyncAction// You can use this method in JavaScript.
Parameters
timeToShow
DateTime DateTimeOffset DateTimeOffset DateTimeOffset

A date and time object that specifies the beginning of the time frame that the Appointments provider app should display.

duration
TimeSpan TimeSpan TimeSpan TimeSpan

A timespan that hints to the Appointments provider app how long the time frame shown should be.

Returns

When this method returns, it does not return a result. On completion, the AsyncActionCompletedHandler specified by get_Completed / Completed is invoked.

Remarks

This method uses parameter values representing date-time and timespan that are represented differently depending on which language you are programming with.

  • In JavaScript, set the timeToShow value with a Date object. Set the duration value with a TimeSpan representing a time span in 100-nanosecond units.
  • In Visual C++ component extensions (C++/CX), set the timeToShow value with a DateTime structure. Set the duration value with a TimeSpan representing a time span in 100-nanosecond units.
  • In C#, use a System.DateTimeOffset value for timeToShow, and a System.TimeSpan value for duration. You can use utility API of these structures to declare the values.

For info about how to manage appointments, see Manage appointments.