AppointmentCalendar AppointmentCalendar AppointmentCalendar AppointmentCalendar Class

Definition

Represents a calendar with appointments.

public : sealed class AppointmentCalendar : IAppointmentCalendar, IAppointmentCalendar2, IAppointmentCalendar3public sealed class AppointmentCalendar : IAppointmentCalendar, IAppointmentCalendar2, IAppointmentCalendar3Public NotInheritable Class AppointmentCalendar Implements IAppointmentCalendar, IAppointmentCalendar2, IAppointmentCalendar3// You can use this class in JavaScript.
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Remarks

Call the AppointmentStore.CreateAppointmentCalendarAsync, the AppointmentStore.FindAppointmentCalendarsAsync, or the AppointmentStore.GetAppointmentCalendarAsync method to obtain an instance of this class.

Properties

CanCancelMeetings CanCancelMeetings CanCancelMeetings CanCancelMeetings

Gets or sets a Boolean value that indicates if the calendar supports cancelling meetings.

public : PlatForm::Boolean CanCancelMeetings { get; set; }public bool CanCancelMeetings { get; set; }Public ReadWrite Property CanCancelMeetings As bool// You can use this property in JavaScript.
Value
PlatForm::Boolean bool bool bool

Boolean value that indicates if the calendar supports cancelling meetings.

CanCreateOrUpdateAppointments CanCreateOrUpdateAppointments CanCreateOrUpdateAppointments CanCreateOrUpdateAppointments

Gets or sets a Boolean value that indicates if the calendar supports creating or updating appointments.

public : PlatForm::Boolean CanCreateOrUpdateAppointments { get; set; }public bool CanCreateOrUpdateAppointments { get; set; }Public ReadWrite Property CanCreateOrUpdateAppointments As bool// You can use this property in JavaScript.
Value
PlatForm::Boolean bool bool bool

Boolean value that indicates if the calendar supports creating or updating appointments.

CanForwardMeetings CanForwardMeetings CanForwardMeetings CanForwardMeetings

Gets or sets a Boolean value that indicates if the calendar supports forwarding meetings.

public : PlatForm::Boolean CanForwardMeetings { get; set; }public bool CanForwardMeetings { get; set; }Public ReadWrite Property CanForwardMeetings As bool// You can use this property in JavaScript.
Value
PlatForm::Boolean bool bool bool

Boolean value that indicates if the calendar supports forwarding meetings.

CanNotifyInvitees CanNotifyInvitees CanNotifyInvitees CanNotifyInvitees

Gets or sets a Boolean value that indicates if the calendar supports notifying attendees.

public : PlatForm::Boolean CanNotifyInvitees { get; set; }public bool CanNotifyInvitees { get; set; }Public ReadWrite Property CanNotifyInvitees As bool// You can use this property in JavaScript.
Value
PlatForm::Boolean bool bool bool

Boolean value that indicates if the calendar supports notifying attendees.

CanProposeNewTimeForMeetings CanProposeNewTimeForMeetings CanProposeNewTimeForMeetings CanProposeNewTimeForMeetings

Gets or sets a Boolean value that indicates if the calendar supports proposing new meeting times.

public : PlatForm::Boolean CanProposeNewTimeForMeetings { get; set; }public bool CanProposeNewTimeForMeetings { get; set; }Public ReadWrite Property CanProposeNewTimeForMeetings As bool// You can use this property in JavaScript.
Value
PlatForm::Boolean bool bool bool

Boolean value that indicates if the calendar supports proposing new meeting times.

CanUpdateMeetingResponses CanUpdateMeetingResponses CanUpdateMeetingResponses CanUpdateMeetingResponses

Gets or sets a Boolean value that indicates if the calendar supports updating meeting responses.

public : PlatForm::Boolean CanUpdateMeetingResponses { get; set; }public bool CanUpdateMeetingResponses { get; set; }Public ReadWrite Property CanUpdateMeetingResponses As bool// You can use this property in JavaScript.
Value
PlatForm::Boolean bool bool bool

Boolean value that indicates if the calendar supports updating meeting responses.

DisplayColor DisplayColor DisplayColor DisplayColor

Gets the color that the built-in calendar app uses for appointments associated with the calendar.

public : Color DisplayColor { get; set; }public Color DisplayColor { get; set; }Public ReadWrite Property DisplayColor As Color// You can use this property in JavaScript.
Value
Color Color Color Color

An unsigned integer representing the color that the built-in calendar app uses for appointments associated with the calendar.

DisplayName DisplayName DisplayName DisplayName

Gets a string representing the display name for the AppointmentCalendar.

public : PlatForm::String DisplayName { get; set; }public string DisplayName { get; set; }Public ReadWrite Property DisplayName As string// You can use this property in JavaScript.
Value
PlatForm::String string string string

A string representing the display name for the AppointmentCalendar.

IsHidden IsHidden IsHidden IsHidden

Gets whether the AppointmentCalendar is hidden in the device's built-in calendar UI.

public : PlatForm::Boolean IsHidden { get; set; }public bool IsHidden { get; set; }Public ReadWrite Property IsHidden As bool// You can use this property in JavaScript.
Value
PlatForm::Boolean bool bool bool

A boolean value indicating whether the AppointmentCalendar is hidden in the device's built-in calendar UI.

LocalId LocalId LocalId LocalId

Gets a string that uniquely identifies the appointment calendar on the local device.

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

A string that uniquely identifies the appointment calendar on the local device.

MustNofityInvitees MustNofityInvitees MustNofityInvitees MustNofityInvitees

Gets or sets a Boolean value that indicates if invitees must be sent notifications.

public : PlatForm::Boolean MustNofityInvitees { get; set; }public bool MustNofityInvitees { get; set; }Public ReadWrite Property MustNofityInvitees As bool// You can use this property in JavaScript.
Value
PlatForm::Boolean bool bool bool

A Boolean value that indicates if invitees must be sent notifications.

OtherAppReadAccess OtherAppReadAccess OtherAppReadAccess OtherAppReadAccess

Gets or sets a boolean value indicating whether other apps on the device have read access to the appointment calendar.

public : AppointmentCalendarOtherAppReadAccess OtherAppReadAccess { get; set; }public AppointmentCalendarOtherAppReadAccess OtherAppReadAccess { get; set; }Public ReadWrite Property OtherAppReadAccess As AppointmentCalendarOtherAppReadAccess// You can use this property in JavaScript.
Value
AppointmentCalendarOtherAppReadAccess AppointmentCalendarOtherAppReadAccess AppointmentCalendarOtherAppReadAccess AppointmentCalendarOtherAppReadAccess

A boolean value indicating whether other apps on the device have read access to the appointment calendar.

OtherAppWriteAccess OtherAppWriteAccess OtherAppWriteAccess OtherAppWriteAccess

Gets or sets a boolean value indicating whether other apps on the device have write access to the appointment calendar.

public : AppointmentCalendarOtherAppWriteAccess OtherAppWriteAccess { get; set; }public AppointmentCalendarOtherAppWriteAccess OtherAppWriteAccess { get; set; }Public ReadWrite Property OtherAppWriteAccess As AppointmentCalendarOtherAppWriteAccess// You can use this property in JavaScript.
Value
AppointmentCalendarOtherAppWriteAccess AppointmentCalendarOtherAppWriteAccess AppointmentCalendarOtherAppWriteAccess AppointmentCalendarOtherAppWriteAccess

A boolean value indicating whether other apps on the device have write access to the appointment calendar.

RemoteId RemoteId RemoteId RemoteId

Gets the remote ID for the AppointmentCalendar.

public : PlatForm::String RemoteId { get; set; }public string RemoteId { get; set; }Public ReadWrite Property RemoteId As string// You can use this property in JavaScript.
Value
PlatForm::String string string string

The remote ID for the AppointmentCalendar.

SourceDisplayName SourceDisplayName SourceDisplayName SourceDisplayName

Gets a string that describes the provider for the appointment calendar.

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

A string that describes the provider for the appointment calendar.

SummaryCardView SummaryCardView SummaryCardView SummaryCardView

Gets or sets how the summary card for the calendar's appointments are displayed.

public : AppointmentSummaryCardView SummaryCardView { get; set; }public AppointmentSummaryCardView SummaryCardView { get; set; }Public ReadWrite Property SummaryCardView As AppointmentSummaryCardView// You can use this property in JavaScript.
Value
AppointmentSummaryCardView AppointmentSummaryCardView AppointmentSummaryCardView AppointmentSummaryCardView

An AppointmentSummaryCardView value indicating how the summary card for the calendar's appointments are displayed.

SyncManager SyncManager SyncManager SyncManager

Gets the AppointmentCalendarSyncManager which can be used to sync with the remote server.

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

UserDataAccountId UserDataAccountId UserDataAccountId UserDataAccountId

Get the identifier of the user account data for the AppointmentCalendar.

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

The identifier of the user account data for the AppointmentCalendar.

Methods

DeleteAppointmentAsync(String) DeleteAppointmentAsync(String) DeleteAppointmentAsync(String) DeleteAppointmentAsync(String)

Asynchronously deletes the appointment with the specified ID.

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

The LocalId of the appointment to be deleted.

Returns

DeleteAppointmentInstanceAsync(String, DateTime) DeleteAppointmentInstanceAsync(String, DateTime) DeleteAppointmentInstanceAsync(String, DateTime) DeleteAppointmentInstanceAsync(String, DateTime)

Asynchronously deletes the appointment instance with the specified start time of a master appointment with the specified ID.

public : IAsyncAction DeleteAppointmentInstanceAsync(PlatForm::String localId, DateTime instanceStartTime)public IAsyncAction DeleteAppointmentInstanceAsync(String localId, DateTimeOffset instanceStartTime)Public Function DeleteAppointmentInstanceAsync(localId As String, instanceStartTime As DateTimeOffset) As IAsyncAction// You can use this method in JavaScript.
Parameters
localId
PlatForm::String String String String

The LocalId of the master appointment associated with the appointment instance to be deleted.

instanceStartTime
DateTime DateTimeOffset DateTimeOffset DateTimeOffset

The start time of the appointment instance to be deleted. This must be the original start date of the instance.

Returns

DeleteAsync() DeleteAsync() DeleteAsync() DeleteAsync()

Asynchronously deletes the appointment calendar.

public : IAsyncAction DeleteAsync()public IAsyncAction DeleteAsync()Public Function DeleteAsync() As IAsyncAction// You can use this method in JavaScript.
Returns

FindAllInstancesAsync(String, DateTime, TimeSpan) FindAllInstancesAsync(String, DateTime, TimeSpan) FindAllInstancesAsync(String, DateTime, TimeSpan) FindAllInstancesAsync(String, DateTime, TimeSpan)

Asynchronously retrieves a list of appointment instances of the specified master appointment that meet the specified criteria.

public : IAsyncOperation<IVectorView<Appointment>> FindAllInstancesAsync(PlatForm::String masterLocalId, DateTime rangeStart, TimeSpan rangeLength)public IAsyncOperation<IReadOnlyList<Appointment>> FindAllInstancesAsync(String masterLocalId, DateTimeOffset rangeStart, TimeSpan rangeLength)Public Function FindAllInstancesAsync(masterLocalId As String, rangeStart As DateTimeOffset, rangeLength As TimeSpan) As IAsyncOperation( Of IReadOnlyListAppointment )// You can use this method in JavaScript.
Parameters
masterLocalId
PlatForm::String String String String

The LocalId of the master appointment for which appointment instances are retrieved.

rangeStart
DateTime DateTimeOffset DateTimeOffset DateTimeOffset

The start time of the time window for which appointment instances are retrieved.

rangeLength
TimeSpan TimeSpan TimeSpan TimeSpan

The length of the time window for which appointment instances are retrieved.

Returns
IAsyncOperation<IVectorView<Appointment>> IAsyncOperation<IReadOnlyList<Appointment>> IAsyncOperation<IReadOnlyList<Appointment>> IAsyncOperation<IReadOnlyList<Appointment>>

An asynchronous operation that returns IVectorView on successful completion.

See Also

FindAllInstancesAsync(String, DateTime, TimeSpan, FindAppointmentsOptions) FindAllInstancesAsync(String, DateTime, TimeSpan, FindAppointmentsOptions) FindAllInstancesAsync(String, DateTime, TimeSpan, FindAppointmentsOptions) FindAllInstancesAsync(String, DateTime, TimeSpan, FindAppointmentsOptions)

Asynchronously retrieves a list of appointment instances of the specified master appointment that meet the specified criteria.

public : IAsyncOperation<IVectorView<Appointment>> FindAllInstancesAsync(PlatForm::String masterLocalId, DateTime rangeStart, TimeSpan rangeLength, FindAppointmentsOptions pOptions)public IAsyncOperation<IReadOnlyList<Appointment>> FindAllInstancesAsync(String masterLocalId, DateTimeOffset rangeStart, TimeSpan rangeLength, FindAppointmentsOptions pOptions)Public Function FindAllInstancesAsync(masterLocalId As String, rangeStart As DateTimeOffset, rangeLength As TimeSpan, pOptions As FindAppointmentsOptions) As IAsyncOperation( Of IReadOnlyListAppointment )// You can use this method in JavaScript.
Parameters
masterLocalId
PlatForm::String String String String

The LocalId of the master appointment for which appointment instances are retrieved.

rangeStart
DateTime DateTimeOffset DateTimeOffset DateTimeOffset

The start time of the time window for which appointment instances are retrieved.

rangeLength
TimeSpan TimeSpan TimeSpan TimeSpan

The length of the time window for which appointment instances are retrieved.

pOptions
FindAppointmentsOptions FindAppointmentsOptions FindAppointmentsOptions FindAppointmentsOptions

A FindAppointmentsOptions object that is used to specify more options for this operation.

Returns
IAsyncOperation<IVectorView<Appointment>> IAsyncOperation<IReadOnlyList<Appointment>> IAsyncOperation<IReadOnlyList<Appointment>> IAsyncOperation<IReadOnlyList<Appointment>>

An asynchronous operation that returns IVectorView on successful completion.

See Also

FindAppointmentsAsync(DateTime, TimeSpan) FindAppointmentsAsync(DateTime, TimeSpan) FindAppointmentsAsync(DateTime, TimeSpan) FindAppointmentsAsync(DateTime, TimeSpan)

Asynchronously retrieves a list of appointments belonging to the current AppointmentCalendar that meet the specified criteria.

public : IAsyncOperation<IVectorView<Appointment>> FindAppointmentsAsync(DateTime rangeStart, TimeSpan rangeLength)public IAsyncOperation<IReadOnlyList<Appointment>> FindAppointmentsAsync(DateTimeOffset rangeStart, TimeSpan rangeLength)Public Function FindAppointmentsAsync(rangeStart As DateTimeOffset, rangeLength As TimeSpan) As IAsyncOperation( Of IReadOnlyListAppointment )// You can use this method in JavaScript.
Parameters
rangeStart
DateTime DateTimeOffset DateTimeOffset DateTimeOffset

The start time of the time window for which appointments are retrieved.

rangeLength
TimeSpan TimeSpan TimeSpan TimeSpan

The length of the time window for which appointments are retrieved. If the rangeLength parameter is set to 0, no appointments will be returned. Even if appointments exist on the device that have a StartTime that is exactly the same as the rangeStart value, the returned list will be empty.

Returns
IAsyncOperation<IVectorView<Appointment>> IAsyncOperation<IReadOnlyList<Appointment>> IAsyncOperation<IReadOnlyList<Appointment>> IAsyncOperation<IReadOnlyList<Appointment>>

An asynchronous operation that returns an IVectorView list of Appointment objects upon successful completion.

See Also

FindAppointmentsAsync(DateTime, TimeSpan, FindAppointmentsOptions) FindAppointmentsAsync(DateTime, TimeSpan, FindAppointmentsOptions) FindAppointmentsAsync(DateTime, TimeSpan, FindAppointmentsOptions) FindAppointmentsAsync(DateTime, TimeSpan, FindAppointmentsOptions)

Asynchronously retrieves a list of appointments belonging to the current AppointmentCalendar that meet the specified criteria.

public : IAsyncOperation<IVectorView<Appointment>> FindAppointmentsAsync(DateTime rangeStart, TimeSpan rangeLength, FindAppointmentsOptions options)public IAsyncOperation<IReadOnlyList<Appointment>> FindAppointmentsAsync(DateTimeOffset rangeStart, TimeSpan rangeLength, FindAppointmentsOptions options)Public Function FindAppointmentsAsync(rangeStart As DateTimeOffset, rangeLength As TimeSpan, options As FindAppointmentsOptions) As IAsyncOperation( Of IReadOnlyListAppointment )// You can use this method in JavaScript.
Parameters
rangeStart
DateTime DateTimeOffset DateTimeOffset DateTimeOffset

The start time of the time window for which appointments are retrieved.

rangeLength
TimeSpan TimeSpan TimeSpan TimeSpan

The length of the time window for which appointments are retrieved. If the rangeLength parameter is set to 0, no appointments will be returned. Even if appointments exist on the device that have a StartTime that is exactly the same as the rangeStart value, the returned list will be empty.

options
FindAppointmentsOptions FindAppointmentsOptions FindAppointmentsOptions FindAppointmentsOptions

A FindAppointmentsOptions object that is used to specify more options for this operation. You must set the options parameter to specify the values to retrieve.

Returns
IAsyncOperation<IVectorView<Appointment>> IAsyncOperation<IReadOnlyList<Appointment>> IAsyncOperation<IReadOnlyList<Appointment>> IAsyncOperation<IReadOnlyList<Appointment>>

An asynchronous operation that returns an IVectorView list of Appointment objects upon successful completion.

Examples

Set FindAppointmentOptions.FetchProperties to specify the values to retrieve.

AppointmentStore calendar = await AppointmentManager.RequestStoreAsync(AppointmentStoreAccessType.AllCalendarsReadOnly);

// Specify which values to retrieve
FindAppointmentsOptions options = new FindAppointmentsOptions(); 
options.FetchProperties.Add(AppointmentProperties.Subject); 
options.FetchProperties.Add(AppointmentProperties.Details); 
options.FetchProperties.Add(AppointmentProperties.DetailsKind);

var iteratingAppointments = await calendar.FindAppointmentsAsync(DateTimeOffset.Now, TimeSpan.FromDays(31), options);

foreach (var i in iteratingAppointments) 
{ 
  // do stuff with each appointment 
}

Remarks

Important

For performance reasons, FindAppointmentsAsync will not load most properties. To load specific properties, add values to the FindAppointmentsOptions.FetchProperties member in the options parameter.

See Also

FindExceptionsFromMasterAsync(String) FindExceptionsFromMasterAsync(String) FindExceptionsFromMasterAsync(String) FindExceptionsFromMasterAsync(String)

Asynchronously retrieves a list of appointment instances that are exceptions from the specified master appointment.

public : IAsyncOperation<IVectorView<AppointmentException>> FindExceptionsFromMasterAsync(PlatForm::String masterLocalId)public IAsyncOperation<IReadOnlyList<AppointmentException>> FindExceptionsFromMasterAsync(String masterLocalId)Public Function FindExceptionsFromMasterAsync(masterLocalId As String) As IAsyncOperation( Of IReadOnlyListAppointmentException )// You can use this method in JavaScript.
Parameters
masterLocalId
PlatForm::String String String String

The LocalId of the master appointment for which exceptional appointment instances are retrieved.

Returns
IAsyncOperation<IVectorView<AppointmentException>> IAsyncOperation<IReadOnlyList<AppointmentException>> IAsyncOperation<IReadOnlyList<AppointmentException>> IAsyncOperation<IReadOnlyList<AppointmentException>>

An asynchronous operation that returns IVectorView on successful completion.

FindUnexpandedAppointmentsAsync() FindUnexpandedAppointmentsAsync() FindUnexpandedAppointmentsAsync() FindUnexpandedAppointmentsAsync()

Asynchronously retrieves a list of appointments that meet the specified criteria.

public : IAsyncOperation<IVectorView<Appointment>> FindUnexpandedAppointmentsAsync()public IAsyncOperation<IReadOnlyList<Appointment>> FindUnexpandedAppointmentsAsync()Public Function FindUnexpandedAppointmentsAsync() As IAsyncOperation( Of IReadOnlyListAppointment )// You can use this method in JavaScript.
Returns
IAsyncOperation<IVectorView<Appointment>> IAsyncOperation<IReadOnlyList<Appointment>> IAsyncOperation<IReadOnlyList<Appointment>> IAsyncOperation<IReadOnlyList<Appointment>>

An asynchronous operation that returns IVectorView on successful completion.

See Also

FindUnexpandedAppointmentsAsync(FindAppointmentsOptions) FindUnexpandedAppointmentsAsync(FindAppointmentsOptions) FindUnexpandedAppointmentsAsync(FindAppointmentsOptions) FindUnexpandedAppointmentsAsync(FindAppointmentsOptions)

Asynchronously retrieves a list of appointments that meet the specified criteria.

public : IAsyncOperation<IVectorView<Appointment>> FindUnexpandedAppointmentsAsync(FindAppointmentsOptions options)public IAsyncOperation<IReadOnlyList<Appointment>> FindUnexpandedAppointmentsAsync(FindAppointmentsOptions options)Public Function FindUnexpandedAppointmentsAsync(options As FindAppointmentsOptions) As IAsyncOperation( Of IReadOnlyListAppointment )// You can use this method in JavaScript.
Parameters
options
FindAppointmentsOptions FindAppointmentsOptions FindAppointmentsOptions FindAppointmentsOptions

A FindAppointmentsOptions object that is used to specify more options for this operation.

Returns
IAsyncOperation<IVectorView<Appointment>> IAsyncOperation<IReadOnlyList<Appointment>> IAsyncOperation<IReadOnlyList<Appointment>> IAsyncOperation<IReadOnlyList<Appointment>>

An asynchronous operation that returns IVectorView on successful completion.

See Also

GetAppointmentAsync(String) GetAppointmentAsync(String) GetAppointmentAsync(String) GetAppointmentAsync(String)

Asynchronously retrieves the Appointment with the specified ID.

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

The LocalId of the appointment to be retrieved.

Returns

GetAppointmentInstanceAsync(String, DateTime) GetAppointmentInstanceAsync(String, DateTime) GetAppointmentInstanceAsync(String, DateTime) GetAppointmentInstanceAsync(String, DateTime)

Asynchronously retrieves the appointment instance of the specified master appointment that has the specified start time.

public : IAsyncOperation<Appointment> GetAppointmentInstanceAsync(PlatForm::String localId, DateTime instanceStartTime)public IAsyncOperation<Appointment> GetAppointmentInstanceAsync(String localId, DateTimeOffset instanceStartTime)Public Function GetAppointmentInstanceAsync(localId As String, instanceStartTime As DateTimeOffset) As IAsyncOperation( Of Appointment )// You can use this method in JavaScript.
Parameters
localId
PlatForm::String String String String

The ID of the master appointment to which the retrieved appointment instance belongs.

instanceStartTime
DateTime DateTimeOffset DateTimeOffset DateTimeOffset

The start time of the appointment instance to be retrieved.

Returns

Remarks

The instanceStartTime parameter must be the original start date of the instance.

RegisterSyncManagerAsync() RegisterSyncManagerAsync() RegisterSyncManagerAsync() RegisterSyncManagerAsync()

Registers the AppointmentCalendar as a sync provider.

public : IAsyncAction RegisterSyncManagerAsync()public IAsyncAction RegisterSyncManagerAsync()Public Function RegisterSyncManagerAsync() As IAsyncAction// You can use this method in JavaScript.
Returns
Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

SaveAppointmentAsync(Appointment) SaveAppointmentAsync(Appointment) SaveAppointmentAsync(Appointment) SaveAppointmentAsync(Appointment)

Asynchronously saves the provided appointment to the calendar.

public : IAsyncAction SaveAppointmentAsync(Appointment pAppointment)public IAsyncAction SaveAppointmentAsync(Appointment pAppointment)Public Function SaveAppointmentAsync(pAppointment As Appointment) As IAsyncAction// You can use this method in JavaScript.
Parameters
pAppointment
Appointment Appointment Appointment Appointment

The appointment to be saved.

Returns

SaveAsync() SaveAsync() SaveAsync() SaveAsync()

Asynchronously saves changes to the appointment calendar.

public : IAsyncAction SaveAsync()public IAsyncAction SaveAsync()Public Function SaveAsync() As IAsyncAction// You can use this method in JavaScript.
Returns

TryCancelMeetingAsync(Appointment, String, String, Boolean) TryCancelMeetingAsync(Appointment, String, String, Boolean) TryCancelMeetingAsync(Appointment, String, String, Boolean) TryCancelMeetingAsync(Appointment, String, String, Boolean)

Asynchronously attempts to cancel a meeting.

public : IAsyncOperation<PlatForm::Boolean> TryCancelMeetingAsync(Appointment meeting, PlatForm::String subject, PlatForm::String comment, bool notifyInvitees)public IAsyncOperation<bool> TryCancelMeetingAsync(Appointment meeting, String subject, String comment, Boolean notifyInvitees)Public Function TryCancelMeetingAsync(meeting As Appointment, subject As String, comment As String, notifyInvitees As Boolean) As IAsyncOperation( Of bool )// You can use this method in JavaScript.
Parameters
meeting
Appointment Appointment Appointment Appointment

The meeting to cancel.

subject
PlatForm::String String String String

The subject for the cancellation notification.

comment
PlatForm::String String String String

The body of the cancellation notification.

notifyInvitees
bool Boolean Boolean Boolean

A Boolean value indicating if invitees should be notified.

Returns

A Boolean value indicating if the operation was successful.

TryCreateOrUpdateAppointmentAsync(Appointment, Boolean) TryCreateOrUpdateAppointmentAsync(Appointment, Boolean) TryCreateOrUpdateAppointmentAsync(Appointment, Boolean) TryCreateOrUpdateAppointmentAsync(Appointment, Boolean)

Asynchronously attempts to create or update a meeting.

public : IAsyncOperation<PlatForm::Boolean> TryCreateOrUpdateAppointmentAsync(Appointment appointment, bool notifyInvitees)public IAsyncOperation<bool> TryCreateOrUpdateAppointmentAsync(Appointment appointment, Boolean notifyInvitees)Public Function TryCreateOrUpdateAppointmentAsync(appointment As Appointment, notifyInvitees As Boolean) As IAsyncOperation( Of bool )// You can use this method in JavaScript.
Parameters
appointment
Appointment Appointment Appointment Appointment

The meeting to create or update.

notifyInvitees
bool Boolean Boolean Boolean

A Boolean value indicating if invitees should be notified.

Returns

A Boolean value indicating if the operation was successful.

TryForwardMeetingAsync(Appointment, IIterable, String, String, String) TryForwardMeetingAsync(Appointment, IIterable, String, String, String) TryForwardMeetingAsync(Appointment, IIterable, String, String, String) TryForwardMeetingAsync(Appointment, IIterable, String, String, String)

Asynchronously attempts to forward a meeting.

public : IAsyncOperation<PlatForm::Boolean> TryForwardMeetingAsync(Appointment meeting, IIterable<AppointmentInvitee> invitees, PlatForm::String subject, PlatForm::String forwardHeader, PlatForm::String comment)public IAsyncOperation<bool> TryForwardMeetingAsync(Appointment meeting, IEnumerable<AppointmentInvitee> invitees, String subject, String forwardHeader, String comment)Public Function TryForwardMeetingAsync(meeting As Appointment, invitees As IEnumerable<AppointmentInvitee>, subject As String, forwardHeader As String, comment As String) As IAsyncOperation( Of bool )// You can use this method in JavaScript.
Parameters
meeting
Appointment Appointment Appointment Appointment

The meeting to forward.

invitees
IIterable<AppointmentInvitee> IEnumerable<AppointmentInvitee> IEnumerable<AppointmentInvitee> IEnumerable<AppointmentInvitee>

A list of new invitees to receive the forwarded meeting.

subject
PlatForm::String String String String

The subject of the meeting invitation.

forwardHeader
PlatForm::String String String String

A new meeting header that includes the new invitees.

comment
PlatForm::String String String String

The body of the forwarded meeting invitation.

Returns

A Boolean value indicating if the operation was successful.

TryProposeNewTimeForMeetingAsync(Appointment, DateTime, TimeSpan, String, String) TryProposeNewTimeForMeetingAsync(Appointment, DateTime, TimeSpan, String, String) TryProposeNewTimeForMeetingAsync(Appointment, DateTime, TimeSpan, String, String) TryProposeNewTimeForMeetingAsync(Appointment, DateTime, TimeSpan, String, String)

Asynchronously attempts to propose a new meeting time.

public : IAsyncOperation<PlatForm::Boolean> TryProposeNewTimeForMeetingAsync(Appointment meeting, DateTime newStartTime, TimeSpan newDuration, PlatForm::String subject, PlatForm::String comment)public IAsyncOperation<bool> TryProposeNewTimeForMeetingAsync(Appointment meeting, DateTimeOffset newStartTime, TimeSpan newDuration, String subject, String comment)Public Function TryProposeNewTimeForMeetingAsync(meeting As Appointment, newStartTime As DateTimeOffset, newDuration As TimeSpan, subject As String, comment As String) As IAsyncOperation( Of bool )// You can use this method in JavaScript.
Parameters
meeting
Appointment Appointment Appointment Appointment

The meeting to update.

newStartTime
DateTime DateTimeOffset DateTimeOffset DateTimeOffset

The proposed new start time.

newDuration
TimeSpan TimeSpan TimeSpan TimeSpan

A new duration for the meeting.

subject
PlatForm::String String String String

The subject of the meeting invitation.

comment
PlatForm::String String String String

The body of the meeting invitation.

Returns

A Boolean value indicating if the operation was successful.

TryUpdateMeetingResponseAsync(Appointment, AppointmentParticipantResponse, String, String, Boolean) TryUpdateMeetingResponseAsync(Appointment, AppointmentParticipantResponse, String, String, Boolean) TryUpdateMeetingResponseAsync(Appointment, AppointmentParticipantResponse, String, String, Boolean) TryUpdateMeetingResponseAsync(Appointment, AppointmentParticipantResponse, String, String, Boolean)

Asynchronously attempts to update the response to a meeting invitation.

public : IAsyncOperation<PlatForm::Boolean> TryUpdateMeetingResponseAsync(Appointment meeting, AppointmentParticipantResponse response, PlatForm::String subject, PlatForm::String comment, bool sendUpdate)public IAsyncOperation<bool> TryUpdateMeetingResponseAsync(Appointment meeting, AppointmentParticipantResponse response, String subject, String comment, Boolean sendUpdate)Public Function TryUpdateMeetingResponseAsync(meeting As Appointment, response As AppointmentParticipantResponse, subject As String, comment As String, sendUpdate As Boolean) As IAsyncOperation( Of bool )// You can use this method in JavaScript.
Parameters
meeting
Appointment Appointment Appointment Appointment

The meeting to update.

response
AppointmentParticipantResponse AppointmentParticipantResponse AppointmentParticipantResponse AppointmentParticipantResponse

The response to the meeting invitation, such as accept, tentative or decline.

subject
PlatForm::String String String String

The subject of the response.

comment
PlatForm::String String String String

The body of the response.

sendUpdate
bool Boolean Boolean Boolean

A Boolean value indicating whether or not to send the response to the meeting organizer.

Returns

A Boolean value indicating if the operation was successful.

See Also