Represents a calendar item in the Exchange store. More...

#include <ews.hpp>

Inheritance diagram for ews::calendar_item:

Public Member Functions
	calendar_item (item_id id)
	Creates a `<CalendarItem>` with given id.

int	get_adjacent_meeting_count () const
	Returns the number of meetings that are adjacent to this meeting. More...

date_time	get_appointment_reply_time () const
	Returns the date and time when when this meeting was responded to. More...

int	get_appointment_sequence_number () const
	Returns the sequence number of this meetings version. More...

int	get_appointment_state () const
	Returns the status of this meeting. More...

calendar_item_type	get_calendar_item_type () const
	Returns the type of this calendar item. More...

int	get_conference_type () const
	Returns the type of conferencing that is performed with this calendar item. More...

int	get_conflicting_meeting_count () const
	Returns the number of meetings that are in conflict with this meeting. More...

std::vector< occurrence_info >	get_deleted_occurrences () const
	Returns the deleted occurrences.

duration	get_duration () const
	Returns the duration of this meeting. More...

date_time	get_end () const
	Returns the ending date and time for this calendar item.

time_zone	get_end_time_zone ()
	Returns the time zone for the ending date and time.

occurrence_info	get_first_occurrence () const
	Returns the first occurrence.

occurrence_info	get_last_occurrence () const
	Returns the last occurrence.

free_busy_status	get_legacy_free_busy_status () const
	Returns the free/busy status of this calendar item.

std::string	get_location () const
	Returns the location where a meeting or event is supposed to take place.

time_zone	get_meeting_time_zone ()
	Returns the time zone for the meeting date and time.

std::string	get_meeting_workspace_url () const
	Returns the URL for a meeting workspace.

std::vector< occurrence_info >	get_modified_occurrences () const
	Returns the modified occurrences.

response_type	get_my_response_type () const
	Returns the response of this calendar item's owner to the meeting. More...

std::string	get_net_show_url () const
	Returns a URL for Microsoft NetShow online meeting.

std::vector< attendee >	get_optional_attendees () const
	Returns all attendees not required to attend this meeting.

mailbox	get_organizer () const
	Returns the organizer of this calendar item. More...

date_time	get_original_start () const
	The original start time of a calendar item. More...

std::pair< std::unique_ptr< recurrence_pattern >, std::unique_ptr< recurrence_range > >	get_recurrence () const
	Returns the recurrence pattern for calendar items and meeting requests. More...

std::vector< attendee >	get_required_attendees () const
	Returns all attendees required to attend this meeting.

std::vector< attendee >	get_resources () const
	Returns all scheduled resources of this meeting.

date_time	get_start () const
	Returns the starting date and time for this calendar item.

time_zone	get_start_time_zone ()
	Returns the time zone for the starting date and time.

std::string	get_time_zone () const
	Returns the display name for the time zone associated with this calendar item. More...

std::string	get_when () const
	Returns a description of when this calendar item occurs.

bool	is_all_day_event () const
	True if this calendar item is lasting all day.

bool	is_cancelled () const
	Indicates whether this calendar item has been cancelled by the organizer. More...

bool	is_meeting () const
	Indicates whether this calendar item is a meeting. More...

bool	is_new_time_proposal_allowed () const
	Returns true if attendees are allowed to respond to the organizer with new time suggestions.

bool	is_online_meeting () const
	Returns whether this meeting is held online.

bool	is_recurring () const
	True if a calendar item is part of a recurring series. More...

bool	is_response_requested () const
	Indicates whether a response to a calendar item is needed. More...

bool	meeting_request_was_sent () const
	True if a meeting request for this calendar item has been sent to all attendees. More...

void	set_all_day_event_enabled (bool enabled)
	Makes this calendar item an all day event or not.

void	set_conference_type (int value)
	Sets the type of conferencing that is performed with this calendar item. More...

void	set_end (const date_time &datetime)
	Sets the ending date and time for this calendar item.

void	set_end_time_zone (time_zone tz)
	Sets the time zone of the ending date and time.

void	set_legacy_free_busy_status (free_busy_status status)
	Sets the free/busy status of this calendar item.

void	set_location (const std::string &location)
	Sets the location where a meeting or event is supposed to take place.

void	set_meeting_time_zone (time_zone tz)
	Sets the time zone for the meeting date and time.

void	set_meeting_workspace_url (const std::string &url)
	Sets the URL for a meeting workspace. More...

void	set_net_show_url (const std::string &url)
	Sets the URL for Microsoft NetShow online meeting. More...

void	set_new_time_proposal_allowed (bool allowed)
	If set to true, allows attendees to respond to the organizer with new time suggestions. More...

void	set_online_meeting_enabled (bool enabled)
	If set to true, this meeting is supposed to be held online. More...

void	set_optional_attendees (const std::vector< attendee > &attendees) const
	Sets the attendees not required to attend this meeting.

void	set_recurrence (const recurrence_pattern &pattern, const recurrence_range &range)
	Sets the recurrence pattern for calendar items and meeting requests.

void	set_required_attendees (const std::vector< attendee > &attendees) const
	Sets the attendees required to attend this meeting.

void	set_resources (const std::vector< attendee > &resources) const
	Sets the scheduled resources of this meeting.

void	set_start (const date_time &datetime)
	Sets the starting date and time for this calendar item.

void	set_start_time_zone (time_zone tz)
	Sets the time zone for the starting date and time.

void	set_when (const std::string &desc)
	Sets a description of when this calendar item occurs.

Public Member Functions inherited from ews::item
	item ()
	Constructs a new item.

	item (item_id id)
	Constructs a new item with the given id.

std::vector< std::string >	get_array_of_strings_helper (const char *name) const

std::vector< attachment >	get_attachments () const
	Returns the items or files that are attached to this item.

body	get_body () const
	Returns the body of this item.

std::vector< std::string >	get_categories () const
	Returns the categories associated with this item. More...

std::string	get_culture () const
	Returns the culture name associated with the body of this item.

date_time	get_date_time_created () const
	Returns the date/time this item was created. More...

date_time	get_date_time_received () const
	Date/Time an item was received. More...

date_time	get_date_time_sent () const
	Returns the date/time this item was sent. More...

std::string	get_display_cc () const
	Returns a nice string containing all Cc: recipients of this item. More...

std::string	get_display_to () const
	Returns a nice string containing all To: recipients of this item. More...

std::vector< extended_property >	get_extended_properties () const

importance	get_importance () const
	Returns the importance of this item.

std::string	get_in_reply_to () const
	Returns the identifier of the item to which this item is a reply. More...

std::vector< internet_message_header >	get_internet_message_headers () const
	Returns a collection of Internet message headers associated with this item. More...

std::string	get_item_class () const
	Returns the PR_MESSAGE_CLASS MAPI property (the message class) for an item.

const item_id &	get_item_id () const EWS_NOEXCEPT
	Returns the id of an item.

mime_content	get_mime_content () const
	Base64-encoded contents of the MIME stream of this item.

folder_id	get_parent_folder_id () const
	Returns a unique identifier for the folder that contains this item. More...

date_time	get_reminder_due_by () const
	Returns the due date of this item. More...

uint32_t	get_reminder_minutes_before_start () const
	Returns the number of minutes before due date that a reminder should be shown to the user.

sensitivity	get_sensitivity () const
	Returns the sensitivity level of this item.

size_t	get_size () const
	Size in bytes of an item. More...

std::string	get_subject () const
	Returns this item's subject.

bool	has_attachments () const
	True if this item has non-hidden attachments. More...

bool	is_draft () const
	True if this item is a draft. More...

bool	is_from_me () const
	True if this item is from you. More...

bool	is_reminder_enabled () const
	True if a reminder has been enabled on this item.

bool	is_resend () const
	True if this item a re-send. More...

bool	is_submitted () const
	True if this item has been submitted for delivery. More...

bool	is_unmodified () const
	True if this item is unmodified. More...

void	set_array_of_strings_helper (const std::vector< std::string > &strings, const char *name)

void	set_body (const body &b)
	Sets the body of this item.

void	set_categories (const std::vector< std::string > &categories)
	Sets this item's categories. More...

void	set_culture (const std::string &culture)
	Sets the culture name associated with the body of this item.

void	set_extended_property (const extended_property &extended_prop)
	Sets an extended property of an item.

void	set_importance (importance i)
	Sets the importance of the item.

void	set_reminder_due_by (const date_time &due_by)
	Sets the due date of this item. More...

void	set_reminder_enabled (bool enabled)
	Set a reminder on this item.

void	set_reminder_minutes_before_start (uint32_t minutes)
	Sets the minutes before due date that a reminder should be shown to the user.

void	set_sensitivity (sensitivity s)
	Sets the sensitivity level of this item.

void	set_subject (const std::string &subject)
	Sets this item's subject. Limited to 255 characters.

Static Public Member Functions
static calendar_item	from_xml_element (const rapidxml::xml_node<> &elem)
	Makes a calendar item instance from a <CalendarItem> XML element.

Friends
template<typename U >
class	basic_service

Detailed Description

Represents a calendar item in the Exchange store.

Member Function Documentation

int ews::calendar_item::get_adjacent_meeting_count ( ) const

inline

Returns the number of meetings that are adjacent to this meeting.

Note: this property is only included in <GetItem/> response when 'calendar:AdjacentMeetingCount' is passed in <AdditionalProperties/>. This is a read-only property.

See also: service::get_adjacent_meetings

date_time ews::calendar_item::get_appointment_reply_time ( ) const

inline

Returns the date and time when when this meeting was responded to.

Note: Applicable to meetings only. This is a read-only property

int ews::calendar_item::get_appointment_sequence_number ( ) const

inline

Returns the sequence number of this meetings version.

Note: Applicable to meetings only. This is a read-only property

int ews::calendar_item::get_appointment_state ( ) const

inline

Returns the status of this meeting.

The returned integer is a bitmask.

0x0000 - No flags have been set. This is only used for a calendar item that does not include attendees
0x0001 - Appointment is a meeting
0x0002 - Appointment has been received
0x0004 - Appointment has been canceled

Note: Applicable to meetings only and is only included in a meeting response. This is a read-only property

calendar_item_type ews::calendar_item::get_calendar_item_type ( ) const

inline

Returns the type of this calendar item.

This is a read-only property.

int ews::calendar_item::get_conference_type ( ) const

inline

Returns the type of conferencing that is performed with this calendar item.

Possible values:

0 - NetMeeting
1 - NetShow
2 - Chat

int ews::calendar_item::get_conflicting_meeting_count ( ) const

inline

Returns the number of meetings that are in conflict with this meeting.

Note: this property is only included in <GetItem/> response when 'calendar:ConflictingMeetingCount' is passed in <AdditionalProperties/>. This is a read-only property.

See also: service::get_conflicting_meetings

duration ews::calendar_item::get_duration ( ) const

inline

Returns the duration of this meeting.

This is a read-only property.

response_type ews::calendar_item::get_my_response_type ( ) const

inline

Returns the response of this calendar item's owner to the meeting.

This is a read-only property.

mailbox ews::calendar_item::get_organizer ( ) const

inline

Returns the organizer of this calendar item.

For meetings, the party responsible for coordinating attendance. This is a read-only property.

date_time ews::calendar_item::get_original_start ( ) const

inline

The original start time of a calendar item.

This is a read-only property.

std::pair<std::unique_ptr<recurrence_pattern>, std::unique_ptr<recurrence_range> > ews::calendar_item::get_recurrence ( ) const

inline

Returns the recurrence pattern for calendar items and meeting requests.

The returned pointers are null if this calendar item is not a recurring master.

std::string ews::calendar_item::get_time_zone ( ) const

inline

Returns the display name for the time zone associated with this calendar item.

Provides a text-only description of the time zone for a calendar item.

Note: This is a read-only property. EWS does not allow you to specify the name of a time zone for a calendar item with <CreateItem/> and <UpdateItem/>. Hence, any calendar items that is fetched with EWS that were also created with EWS will always have an empty <TimeZone/> property.

See also: get_meeting_time_zone, set_meeting_time_zone

bool ews::calendar_item::is_cancelled ( ) const

inline

Indicates whether this calendar item has been cancelled by the organizer.

This is a read-only property. It is only meaningful for meetings.

bool ews::calendar_item::is_meeting ( ) const

inline

Indicates whether this calendar item is a meeting.

This is a read-only property.

bool ews::calendar_item::is_recurring ( ) const

inline

True if a calendar item is part of a recurring series.

This is a read-only property. Note that a recurring master is not considered part of a recurring series, even though it holds the recurrence information.

bool ews::calendar_item::is_response_requested ( ) const

inline

Indicates whether a response to a calendar item is needed.

This is a read-only property.

bool ews::calendar_item::meeting_request_was_sent ( ) const

inline

True if a meeting request for this calendar item has been sent to all attendees.

This is a read-only property.

void ews::calendar_item::set_conference_type ( int value )

inline

Sets the type of conferencing that is performed with this calendar item.

See also: get_conference_type

void ews::calendar_item::set_meeting_workspace_url ( const std::string & url )

inline

Sets the URL for a meeting workspace.

Note: This property is read-writable for the organizer's calendar item. For meeting requests and for attendees' calendar items this is read-only .

void ews::calendar_item::set_net_show_url ( const std::string & url )

inline

Sets the URL for Microsoft NetShow online meeting.

Note: This property is read-writable for the organizer's calendar item. For meeting requests and for attendees' calendar items this is read-only .

void ews::calendar_item::set_new_time_proposal_allowed ( bool allowed )

inline

If set to true, allows attendees to respond to the organizer with new time suggestions.

Note: This property is read-writable for the organizer's calendar item. For meeting requests and for attendees' calendar items this is read-only .

void ews::calendar_item::set_online_meeting_enabled ( bool enabled )

inline

If set to true, this meeting is supposed to be held online.

Note: This property is read-writable for the organizer's calendar item. For meeting requests and for attendees' calendar items this is read-only .

The documentation for this class was generated from the following file:

/home/travis/build/otris/ews-cpp/include/ews/ews.hpp

Public Member Functions

Static Public Member Functions

Friends

Detailed Description

Member Function Documentation