Represents a concrete task in the Exchange store. More...

#include <ews.hpp>

Inheritance diagram for ews::task:

Public Member Functions
	task (item_id id)
	Constructs a new task with the given item_id.

int	get_actual_work () const
	Returns the actual amount of work expended on the task. More...

date_time	get_assigned_time () const
	Returns the time this task was assigned to the current owner. More...

std::string	get_billing_information () const
	Returns the billing information associated with this task.

int	get_change_count () const
	Returns the change count of this task. More...

std::vector< std::string >	get_companies () const
	Returns the companies associated with this task. More...

date_time	get_complete_date () const
	Returns the time the task was completed.

std::vector< std::string >	get_contacts () const
	Returns a list of contacts associated with this task.

delegation_state	get_delegation_state () const
	Returns the delegation state of this task. More...

std::string	get_delegator () const
	Returns the name of the user that delegated the task.

date_time	get_due_date () const
	Returns the date that the task is due.

std::string	get_mileage () const
	Returns the mileage associated with the task. More...

int	get_percent_complete () const
	Returns the percentage of the task that has been completed. More...

date_time	get_start_date () const
	Returns the date that work on the task should start.

status	get_status () const
	Returns the status of the task.

std::string	get_status_description () const
	Returns the status description. More...

int	get_total_work () const
	Returns the total amount of work for this task.

bool	is_complete () const
	True if the task is marked as complete. More...

bool	is_recurring () const
	True if the task is recurring.

bool	is_team_task () const
	True if the task is a team task. More...

void	set_actual_work (int actual_work)
	Sets the actual amount of work expended on the task. More...

void	set_billing_information (const std::string &billing_info)
	Sets the billing information associated with this task.

void	set_companies (const std::vector< std::string > &companies)
	Sets the companies associated with this task. More...

void	set_contacts (const std::vector< std::string > &contacts)
	Sets the contacts associated with this task to `contacts`.

void	set_due_date (const date_time &due_date)
	Sets the date that the task is due.

void	set_mileage (const std::string &mileage)
	Sets the mileage associated with the task.

void	set_percent_complete (int value)
	Sets the percentage of the task that has been completed. More...

void	set_start_date (const date_time &start_date)
	Set the date that work on the task should start.

void	set_status (status s)
	Sets the status of the task to `s`.

void	set_total_work (int total_work)
	Sets the total amount of work for this task.

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 task	from_xml_element (const rapidxml::xml_node<> &elem)
	Makes a task instance from a `<Task>` XML element.

Friends
template<typename U >
class	basic_service

Detailed Description

Represents a concrete task in the Exchange store.

Member Function Documentation

int ews::task::get_actual_work ( ) const

inline

Returns the actual amount of work expended on the task.

Measured in minutes.

date_time ews::task::get_assigned_time ( ) const

inline

Returns the time this task was assigned to the current owner.

If this task is not a delegated task, this property is not set. This is a read-only property.

int ews::task::get_change_count ( ) const

inline

Returns the change count of this task.

How many times this task has been acted upon (sent, accepted, etc.). This is simply a way to resolve conflicts when the delegator sends multiple updates. Also known as TaskVersion Seems to be read-only.

std::vector<std::string> ews::task::get_companies ( ) const

inline

Returns the companies associated with this task.

A list of company names associated with this task.

Note: It seems that Exchange server accepts only one <String> element here, although it is an ArrayOfStringsType.

delegation_state ews::task::get_delegation_state ( ) const

inline

Returns the delegation state of this task.

This is a read-only property.

std::string ews::task::get_mileage ( ) const

inline

Returns the mileage associated with the task.

Potentially used for reimbursement purposes

int ews::task::get_percent_complete ( ) const

inline

Returns the percentage of the task that has been completed.

Valid values are 0-100.

std::string ews::task::get_status_description ( ) const

inline

Returns the status description.

A localized string version of the status. Useful for display purposes. This is a read-only property.

bool ews::task::is_complete ( ) const

inline

True if the task is marked as complete.

This is a read-only property. See also task_property_path::percent_complete

bool ews::task::is_team_task ( ) const

inline

True if the task is a team task.

This is a read-only property.

void ews::task::set_actual_work ( int actual_work )

inline

Sets the actual amount of work expended on the task.

Measured in minutes.

void ews::task::set_companies ( const std::vector< std::string > & companies )

inline

Sets the companies associated with this task.

Note: It seems that Exchange server accepts only one <String> element here, although it is an ArrayOfStringsType.

void ews::task::set_percent_complete ( int value )

inline

Sets the percentage of the task that has been completed.

Valid values are 0-100. Note that setting <PercentComplete> to 100 has the same effect as setting a <CompleteDate> or <Status> to ews::status::completed.

See MSDN for more on this.

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