Appointment Appointment Appointment Appointment Class

Definition

Represents an appointment in a calendar. This class is used when an app is activated using the AppointmentsProvider value for ActivationKind, as a value for AppointmentInformation properties.

public : sealed class Appointment : IAppointment, IAppointment2, IAppointment3public sealed class Appointment : IAppointment, IAppointment2, IAppointment3Public NotInheritable Class Appointment Implements IAppointment, IAppointment2, IAppointment3// 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

For info about how to manage appointments, see Managing appointments and Quickstart: Managing appointments .

Constructors

Appointment() Appointment() Appointment() Appointment()

Initializes a new instance of the Appointment class.

public : Appointment()public Appointment()Public Sub New()// You can use this method in JavaScript.

Properties

AllDay AllDay AllDay AllDay

Gets or sets a Boolean value that indicates whether the appointment will last all day. The default is FALSE for won't last all day.

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

A Boolean value that indicates whether the appointment will last all day. TRUE indicates that the appointment will last all day; otherwise FALSE.

Remarks

When creating an appointment with AllDay set to true, you should set the StartTime of the appointment to midnight (00:00:00).

AllowNewTimeProposal AllowNewTimeProposal AllowNewTimeProposal AllowNewTimeProposal

Gets or sets a value that indicates whether the appointment will allow users to propose a new time.

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

A Boolean value that indicates whether the appointment will allow users to propose a new time. TRUE indicates that the appointment does allow new time proposal; otherwise FALSE.

BusyStatus BusyStatus BusyStatus BusyStatus

Gets or sets a AppointmentBusyStatus -typed value that indicates the busy status for a participant of an appointment.

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

A AppointmentBusyStatus -typed value that indicates the busy status for a participant of an appointment.

CalendarId CalendarId CalendarId CalendarId

Gets the unique identifier for the calendar associated with the appointment.

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

The unique identifier for the calendar associated with the appointment.

ChangeNumber ChangeNumber ChangeNumber ChangeNumber

Gets the current change number of the local version of the Appointment.

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

The current change number of the local version of the Appointment.

Details Details Details Details

Gets or sets a string value. The string contains extended details that describe the appointment. Details is of type String and a maximum of 1,073,741,823 characters in length, which is the maximum length of a JET database string.

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

The extended details that describe the appointment.

Remarks

DetailsKind DetailsKind DetailsKind DetailsKind

Gets or sets the type of appointment details, plain text or HTML.

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

Duration Duration Duration Duration

Gets or sets a time span that represents the time duration of the appointment. Duration is of type TimeSpan and must be non-negative.

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

A time span that represents the duration of the appointment. The duration can't be a negative value.

Remarks

This property uses a time span value, which is represented differently depending on which language you are programming with.

  • In JavaScript, set the Duration value with a Number that represents the time interval. Each unit for a TimeSpan value represents 1 millisecond. For example, this code sets a Duration value to 60 minutes (one hour). ```javascript appointment.duration = (60 * 60 * 1000); // 1 hour in 1-millisecond units

    
    
    
  • In Visual C++ component extensions (C++/CX), use a TimeSpan structure value with a Duration value. In Visual C++ component extensions (C++/CX), each unit for a Duration value represents 100 nanoseconds.

  • In C# or Microsoft Visual Basic, you use a System.TimeSpan value. You can use utility API of System.TimeSpan such as FromSeconds to generate a System.TimeSpan and set the value.
Note

In JavaScript, TimeSpan is accessed as a value, not as an object. For example, use var a = 10000, not var a = { duration: 10000 }. Also, in JavaScript, TimeSpan is treated as the number of millisecond intervals, not the number of 100-nanosecond intervals so you can lose precision when you port TimeSpan values between languages.

HasInvitees HasInvitees HasInvitees HasInvitees

Gets a value that indicates whether the appointment has invitees.

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

A value that indicates whether the appointment has invitees.

Invitees Invitees Invitees Invitees

Gets the list of participants for the appointment. Invitees is of type IVector(AppointmentInvitee). If an organizer is set and invitee length is greater than 0, a call to an AppointmentManager API fails with E_INVALIDARG. The number of invitees is unlimited.

public : IVector<AppointmentInvitee> Invitees { get; }public IList<AppointmentInvitee> Invitees { get; }Public ReadOnly Property Invitees As IList<AppointmentInvitee>// You can use this property in JavaScript.
Value
IVector<AppointmentInvitee> IList<AppointmentInvitee> IList<AppointmentInvitee> IList<AppointmentInvitee>

The list of participants for the appointment.

IsCanceledMeeting IsCanceledMeeting IsCanceledMeeting IsCanceledMeeting

Gets or sets a value that indicates whether the appointment has been cancelled.

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

A Boolean value that indicates whether the appointment has been cancelled. TRUE indicates that the appointment has been cancelled; otherwise FALSE.

IsOrganizedByUser IsOrganizedByUser IsOrganizedByUser IsOrganizedByUser

Gets or sets a value that indicates whether the appointment was organized by the current user.

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

A Boolean value that indicates whether the appointment was organized by the current user TRUE indicates that the appointment was organized by the user; otherwise FALSE.

IsResponseRequested IsResponseRequested IsResponseRequested IsResponseRequested

Gets or sets a value that indicates whether a response to the appointment invitation is requested.

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

A Boolean value that indicates whether a response is requested. TRUE indicates that a response is requested; otherwise FALSE.

LocalId LocalId LocalId LocalId

Gets a string that uniquely identifies the appointment 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 on the local device.

Remarks

The ID retrieved with this property is guaranteed to be unique on the local device. To associate appointments across devices, use RoamingId.

Location Location Location Location

Gets or sets a string that communicates the physical location of the appointment. Location is of type String and a maximum of 32,768 characters in length.

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

The location of the appointment.

OnlineMeetingLink OnlineMeetingLink OnlineMeetingLink OnlineMeetingLink

Gets or sets a string value that is a URL used to join the online meeting for the appointment.

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

A string value that is a URL used to join the online meeting for the appointment.

Organizer Organizer Organizer Organizer

Gets or sets the organizer of the appointment. Organizer is of type AppointmentOrganizer. If an organizer is set and invitee length is greater than 0, a call to an AppointmentManager API fails with E_INVALIDARG. The number of invitees is unlimited.

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

A AppointmentOrganizer object that indicates the organizer of the appointment.

OriginalStartTime OriginalStartTime OriginalStartTime OriginalStartTime

Gets the original starting time for a recurring appointment.

public : IReference<DateTime> OriginalStartTime { get; }public Nullable<DateTimeOffset> OriginalStartTime { get; }Public ReadOnly Property OriginalStartTime As Nullable<DateTimeOffset>// You can use this property in JavaScript.
Value
IReference<DateTime> Nullable<DateTimeOffset> Nullable<DateTimeOffset> Nullable<DateTimeOffset>

The original starting time for a recurring appointment..

Recurrence Recurrence Recurrence Recurrence

Gets or sets the object that describes when and how often the appointment occurs. Recurrence is of type AppointmentRecurrence.

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

A AppointmentRecurrence object that describes when and how often the appointment occurs.

Reminder Reminder Reminder Reminder

Gets or sets a time span value. The value declares the amount of time to subtract from the StartTime, and that time used as the issue time for a reminder for an appointment. A null value indicates that the appointment will not issue a reminder. Reminder is of type IReference(TimeSpan).

public : IReference<TimeSpan> Reminder { get; set; }public Nullable<TimeSpan> Reminder { get; set; }Public ReadWrite Property Reminder As Nullable<TimeSpan>// You can use this property in JavaScript.
Value
IReference<TimeSpan> Nullable<TimeSpan> Nullable<TimeSpan> Nullable<TimeSpan>

A time span value, or null to issue no reminder.

Remarks

This property uses a time span value, which is represented differently depending on which language you are programming with. For more information about how to use a time span value, see the Duration property.

RemoteChangeNumber RemoteChangeNumber RemoteChangeNumber RemoteChangeNumber

Gets or sets the current change number of the server version of the Appointment.

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

The current change number of the server version of the Appointment.

ReplyTime ReplyTime ReplyTime ReplyTime

Gets or sets the date and time that the user responded to the appointment request.

public : IReference<DateTime> ReplyTime { get; set; }public Nullable<DateTimeOffset> ReplyTime { get; set; }Public ReadWrite Property ReplyTime As Nullable<DateTimeOffset>// You can use this property in JavaScript.
Value
IReference<DateTime> Nullable<DateTimeOffset> Nullable<DateTimeOffset> Nullable<DateTimeOffset>

The date and time that the user responded to the appointment request.

Remarks

The ReplyTime date you provide should be in the local time of the device since 12:01 AM, January 1, 1601 A.D. (C.E.) .

RoamingId RoamingId RoamingId RoamingId

Gets or sets a string that uniquely identifies an appointment across devices.

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

A string that uniquely identifies an appointment across devices.

Sensitivity Sensitivity Sensitivity Sensitivity

Gets or sets a AppointmentSensitivity -typed value that indicates the sensitivity of the appointment.

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

A AppointmentSensitivity -typed value that indicates the sensitivity of the appointment.

StartTime StartTime StartTime StartTime

Gets or sets the starting time for the appointment. StartTime is of type DateTime.

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

The date and time to use as the starting time for the appointment.

Remarks

This property uses an object representing date and time, and that object is represented differently depending on which language you are programming with.

  • In JavaScript, set the StartTime value with a Date object. For example, this code sets a StartTime value to a specific date and time. ```javascript appointment.startTime = new Date(2015, 9, 10, 9); // October 10th, 2015 at 9:00am

    
    
    
  • In Visual C++ component extensions (C++/CX), use a DateTime structure value.

  • In C# or Microsoft Visual Basic, you use a System.DateTimeOffset value. You can use utility API of System.DateTimeOffset to generate a DateTimeOffset from different inputs (local time, parsed strings, and so on) and set the value.

Subject Subject Subject Subject

Gets or sets a string that communicates the subject of the appointment. Subject is of type String and a maximum of 255 characters in length.

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

The subject of the appointment.

Uri Uri Uri Uri

Gets the Uniform Resource Identifier (Uri ) for the appointment. Allows the Calendar app to perform an association launch to go back to the source app or other URI that represents this appointment.

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

The URI for the appointment.

UserResponse UserResponse UserResponse UserResponse

Gets or sets the user's response to the appointment request.

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

See Also