Interface IEvent

The Event object contains info about events on a user's Outlook.com calendars. The Live Connect REST API supports creating Event objects. Use the wl.events_create scope to create Event objects on the user's default calendar only. Use the wl.calendars scope to read Event objects on the user's calendars. Use wl.calendars_update to create Event objects on any of the user's calendars. Use the wl.contacts_calendars scope to read Event objects from the user's friend's calendars.

Index

Properties

Properties

public availability: string

The user's availability status for the event. Valid values are:

  • free
  • busy
  • tentative
  • out_of_office
default

"free"

public calendar_id: string

The ID of the calendar that contains the event.

public created_time: string

The time, in ISO 8601 format, at which the event was created.

public description: string

A description of the event, with a maximum length of 32,768 characters. This structure is required.

public end_time: string

The end time, in ISO 8601 format, of the event. If no end time is specified, the default value is 30 minutes after start_time. This structure is optional when creating an event. When the event is being read, the time will be the user's local time, in ISO 8601 format.

public from: IUserInfo

The object that contains the name and ID of the organizer.

public id: string

The ID of the event.

public is_all_day_event: boolean

A value that specifies whether the event is an all-day event. If the event is an all-day event, this value is true; otherwise, it is false. If this structure is missing, the default value is false.

public is_recurrent: boolean

A value that specifies whether the event is recurring. If the event is recurring, this value is true; otherwise, it is false.

public location: string

The name of the location at which the event will take place. The maximum length is 1,000 characters.

public name: string

The name of the event, with a maximum length of 255 characters. This structure is required.

public recurrence: string

The text description of the recurrence pattern, for example, "Occurs every week on Tuesday". The value is Null if this is not a recurrent event.

public reminder_time: number

The time, in minutes, before the event for the reminder alarm.

public start_time: string

The start time, in ISO 8601 format, of the event. When the event is being read, the time will be the user's local time, in ISO 8601 format.

public updated_time: string

The time, in ISO 8601 format, at which the event was updated. This structure is visible only in the Event object that is returned if the event was successfully created.

public visibility: string

A value that specifies whether the event is publicly visible. Valid values are:

  • public�the event is visible to anyone who can view the calendar.
  • private"�the event is visible only to the event owner.
default

"public"