Office365Tasks Class

Properties   Methods   Events   Config Settings   Errors  

The Office365Tasks class provides an easy way to manage todo tasks in Microsoft 365.

Syntax

Office365Tasks

Remarks

This class provides an easy to use interface for Office365 using the Microsoft Graph API v1.0. To use the class, first set the Authorization property to a valid OAuth token. The Office365Tasks class can be used for creating new tasks/task lists/checklist items; retrieving, updating, or deleting existing tasks/task lists/checklist items; and several other functionalities supported by the Microsoft Graph API.

This class requires authentication via OAuth 2.0. First, perform OAuth authentication using the OAuth property to set the appropriate fields for the chosen ClientProfile and GrantType.

The class has the following defaults:

Additionally, depending on how the application is registered (Ex. Multi-tenant) and what GrantType is selected (Ex. Client Credentials and Password), it may be required to use the tenant ID rather than "common" in the ServerAuthURL and ServerTokenURL fields. In the case of Client Credentials and Password grant types, it is also required to use the "default" scopes of the app registration. See below for examples of the modified URLs and scopes:

Below is a brief description of the different ClientProfile and GrantType values that are supported by this class. For a more in-depth description of what needs to be set, refer to the service documentation.

Application Profile

This profile encompasses the most basic grant types that OAuth supports. When this profile is set, all the requests and response handling is done by the class. Depending on the grant type, this may involve launching a browser so a user can login to authenticate with a authorization server. It may also involve starting an embedded web server to receive a response from a redirect.

To start the authentication and authorization process, the Authorize method should be called. If the authorization and authentication was successful, then the AccessToken field will be populated. Additionally, if a refresh token was provided the RefreshToken field will be populated as well. These values of the fields are for informational purposes. The class will also cache these tokens along with when the AccessToken will be expired. When a method that makes requests to the service provider is called or the Authorize method is called the class will automatically check to see if the access token is expired. If it is, it will then automatically try to get a new AccessToken. If the Authorize method was not used and user interaction would be required, the class will throw an error which can be caught. When user interaction is needed depends on what grant type is set in the GrantType field. To force the component to only check the access token when the Authorize method is called, the OAuthAutomaticRefresh configuration setting can be set to false.

A brief description of the supported values for the GrantType field are below. For more information, see the service documentation.

Authorization Code

When using the Authorization Code grant type, the class will use an authorization code to get an access token. For this GrantType the class expects a ClientId, ClientSecret, ServerAuthURL, and ServerTokenURL to be set. When the Authorize method is called, the component will start the embedded web server and launch the browser so the user can authorize the application. Once the user authorizes, the service provider will redirect them to the embedded web server and the class will parse the authorization code, setting the AuthorizationCode field, from the redirect. Immediately, the class will make a request to the token server to exchange the authorization code for an access token. The token server will return an access token and possibly a refresh token. If the RefreshToken field is set, or a refresh token is cached, then the class will not launch the browser and use the refresh token in its request to the token server instead of an authorization code.

Example: Office365Tasks office365task = new Office365Tasks(); office365task.OAuth.ClientProfile = CloudOAuthClientProfiles.cocpApplication; office365task.OAuth.GrantType = OAuthSettingsGrantTypes.cogtAuthorizationCode; office365task.OAuth.ClientId = CLIENT_ID; office365task.OAuth.ClientSecret = CLIENT_SECRET; office365task.Authorize();

Client Credentials

When using the Client Credentials grant type, the class will act as a service instead of authorizing and authenticating as a user. This allows for the class to avoid user interaction. This is typically used when running in an application that can not have user access. This grant type requires additional set up to be done in the service providers portal before it can be used. For this GrantType the class expects a ClientId, ClientSecret, and ServerTokenURL to be set. When the Authorize method is called, the component will make a request to the token server for an access token. The token server will return an access token if the application has the authorization to do so. When this access token is expired, the component will automatically (see above for detailed description) make a new request to get a fresh one.

Implicit

Note: This grant type is considered insecure and should only be used when necessary.

When using the Implicit grant type, the class will request the authorization server to get an access token. For this GrantType the class expects a ClientId, ClientSecret, and ServerAuthURL to be set. When the Authorize method is called, the component will start the embedded web server and launch the browser so the user can authorize the application. Once the user authorizes, the service provider will redirect them to the embedded web server and the class will parse the access token from the redirect.

A disadvantage of the grant type is that can not use a refresh token to silently get a new access token. Most service providers offer a way to silently get a new access token. See the service documentation for specifics. This means the class will not be able to automatically get a fresh token once it expires.

Password

Note: This grant type is considered insecure and should only be used when necessary.

When using the Resource Owner Password Credentials grant type, the class will authenticate as the resource owner. This allows for the class to avoid user interaction. This grant type often has specific limitations put on it by the service provider. See the service documentation for more details.

For this GrantType the class requires OAuthPasswordGrantUsername, ClientSecret, and ServerTokenURL to be set. The ClientSecret should be set to the password of the account instead of a typical secret. In some cases, the ClientId also needs to be set. When the Authorize method is called, the component will make a request to the token server for an access token using the username and password. The token server will return an access token if the authentication was successful. When this access token is expired, the component will automatically (see above for detailed description) make a new request to get a fresh one.

Web Profile

External OAuth Support

Bearer ACCESS_TOKEN_VALUE

Assign this value to the Authorization property before attempting any operations. Setting the Authorization property will cause the class to ignore the values set in the OAuth property.

For Example: Oauth oauth = new Oauth(); oauth.ClientId = "CLIENT_ID"; oauth.ClientSecret = "CLIENT_SECRET"; oauth.ServerAuthURL = "https://login.microsoftonline.com/common/oauth2/v2.0/authorize"; oauth.ServerTokenURL = "https://login.microsoftonline.com/common/oauth2/v2.0/token"; oauth.AuthorizationScope = "offline_access user.read mail.readwrite mail.send mailboxsettings.readwrite user.readwrite Contacts.Read Contacts.ReadWrite"; oauth.GrantType = OauthGrantTypes.ogtAuthorizationCode; office365task.Authorization = oauth.GetAuthorization(); Consult the documentation for the service for more information about supported scope values and more details on OAuth authentication.

Creating a Task List

To create a task list using the Office365Tasks components we make use of the CreateTaskList method. The CreateTaskList method will create a new task list with a name specified through the name parameter.

Creating a task list: office365task.CreateTaskList("My tasklist");

After creating a task list with the basic information, select the task list to be edited in the TaskLists collection, edit its fields and make a call to the UpdateTaskList method. To edit the newly created task list select the first task list in the collection.

Example (Update The First Task List Of The Collection) // Set a new name for the newly created task list office365task.TaskLists[0].DisplayName = "new name"; office365task.UpdateTaskList(0);

Listing Task Lists

Information about task lists fetched by the component can be accessed through the members of the TaskLists properties. The TaskLists properties is populated when the ListTaskLists method is called.

The ListTaskLists method will list the task lists and make the TaskListList event to fire with the appropriate data about the task lists received.

By default, the component will fetch one page of 100 task lists when ListTaskLists is called. If additional task lists remain, the ListTaskListsMarker property will be populated, it contains the nextPageToken that will be included in the next request as a parameter if ListTaskLists is then called again, if called the next page of task lists will be fetched. The example below populates the TaskLists properties with all the task lists associated with the account. do { office365task.ListTaskLists(); } while (office365task.Config("ListTaskListsMarker").Length > 0);

The task lists page size may also be changed by using the TaskListsPageSize configuration setting.

Deleting a Task List

To delete a task list use the DeleteTaskList method, provide the Id of the task list as the argument. The task list will stay in the TaskLists collection until ListTaskLists method is called again.

Example (Delete Task List)

// List task lists and deleting the task list named "new name" office365task.ListTaskLists(); for (int i = 0; i < office365task.TaskLists.Count; i++) { if (office365task.TaskLists[i].DisplayName == "new name") { office365task.DeleteTaskList(office365task.TaskLists[i].Id); break; } // Note: the component would let you name more than one task list with the same name so the example would delete the first encounter with the task list that has the specified name }

Creating a Task

To create a task using the Office365Tasks components we make use of the CreateTask method. The CreateTask method will create a new task with a name specified through the subject parameter inside the task list specified through the taskListId parameter.

Creating a task: office365task.CreateTaskList("My task list"); office365task.CreateTask("My task", office365task.TaskLists[0].Id); //creating a task named "My task" inside the "My task list" task list

After creating a task with the basic information, select the task to be edited in the Tasks collection, edit its fields and make a call to the UpdateTask method. To edit the newly created task select the first task in the collection.

Example (Update The First Task Of The Collection) // Set properties to update office365task.Tasks[0].Title = "new title"; office365task.Tasks[0].Categories = "new category"; office365task.Tasks[0].Importance = TOTImportances.otiNormal; office365task.Tasks[0].IsReminderOn = true; office365task.UpdateTask(0);

Listing Tasks

Information about tasks fetched by the component can be accessed through the members of the Tasks properties. The Tasks properties is populated when the ListTasks method is called.

The ListTasks method will list the tasks inside the task list specified through the taskListId parameter and make the TaskList event to fire with the appropriate data about the tasks received.

By default, the component will fetch one page of 100 tasks when ListTasks is called. If additional tasks remain, the ListTasksMarker property will be populated, it contains the nextPageToken that will be included in the next request as a parameter if ListTasks is then called again, if called the next page of tasks will be fetched. The example below populates the Tasks properties with all the tasks associated with a task list. do { office365task.ListTasks(office365task.TaskLists[0].Id); } while(office365task.ListTasksMarker.Length > 0)

Deleting a Task

To delete a task use the DeleteTask method, provide the Id of the task list where the task belongs to and the Id of the task you want to delete as arguments. The task will stay in the Tasks collection until ListTasks method is called again.

Example (Delete Task)

// List tasks and deleting the task named "new title" office365task.ListTasks(office365task.TaskLists[0].Id); for (int i = 0; i < office365task.Tasks.Count; i++) { if (office365task.Tasks[i].Title == "new title") { office365task.DeleteTask(office365task.TaskLists[0].Id, office365task.Task[i].Id); break; } // Note: the component would let you name more than one task with the same name so the example would delete the first encounter with the task that has the specified name }

Creating a Checklist Item

To create a checklist item using the Office365Tasks components we make use of the CreateCheckListItem. The CreateCheckListItem method will create a new checklist item with a name specified through the name parameter belonging to a task specified through the taskId parameter inside the task list specified through the taskListId parameter.

Creating a checklist item: office365task.CreateTaskList("My task list"); office365task.CreateTask("My task", office365task.TaskLists[0].Id); //creating a task named "My task" inside the "My task list" task list office365task.CreateCheckListItem("My checklist item", office365task.TaskLists[0].Id, office365task.Tasks[0].Id); // creating a checklist item named "My checklist item" inside the "My task" task

After creating a checklist item with the basic information, select the checklist item to be edited in the CheckListItems collection, edit its fields and make a call to the UpdateCheckListItem method. To edit the newly created checklist item select the first checklist item in the collection.

Example (Update The First checklist item Of The collection) // Set properties to update office365task.CheckListItems[0].DisplayName = "new name"; office365task.CheckListItems[0].IsChecked= true; office365task.UpdateCheckListItem(0);

Listing Checklist Items

Information about checklist item fetched by the component can be accessed through the members of the CheckListItems properties. The CheckListItems properties is populated when the ListCheckListItems method is called.

The ListCheckListItems method will list the checklist items belonging to a task specified through the taskId inside the task list specified through the taskListId parameter and make the CheckListItemList event to fire with the appropriate data about the checklist items received. office365task.ListCheckListItems(office365task.TaskLists[0].Id, office365task.Tasks[0].Id);

Deleting a Checklist Item

To delete a checklist item use the DeleteCheckListItem method, provide the Id of the task list where the task that has the checklist item you want to delete is, the id of the task that has the checklist item you want to delete and finally the Id of the checklist item you want to delete as arguments. The checklist item will stay in the CheckListItems collection until ListCheckListItems method is called again.

Example (Delete Checklist Item)

// List checklist items and deleting the checklist item named "new name" office365task.ListCheckListItems(office365task.TaskLists[0].Id, office365task.Tasks[0].Id); for (int i = 0; i < office365task.CheckListItems.Count; i++) { if (office365task.CheckListItems[i].DisplayName == "new name") { office365task.DeleteCheckListItem(office365task.TaskLists[0].Id, office365task.Tasks[0].Id, office365task.CheckListItems[i].Id); break; } // Note: the component would let you name more than one checklist item with the same name so the example would delete the first encounter with the checklist item that has the specified name }

Property List

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

Method List

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

Event List

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

Config Settings

The following is a list of config settings for the class with short descriptions. Click on the links for further details.

Attachments Property (Office365Tasks Class)

Collection of attachments listed by the server.

Syntax

• C++
• C
• Qt

CloudCalendarsList<CloudCalendarsOTAttachment>* GetAttachments();
int SetAttachments(CloudCalendarsList<CloudCalendarsOTAttachment>* val);

int cloudcalendars_office365tasks_getattachmentscount(void* lpObj);
int cloudcalendars_office365tasks_setattachmentscount(void* lpObj, int iAttachmentsCount);

char* cloudcalendars_office365tasks_getattachmentcontenttype(void* lpObj, int attachmentindex);

int cloudcalendars_office365tasks_getattachmentdata(void* lpObj, int attachmentindex, char** lpAttachmentData, int* lenAttachmentData);
int cloudcalendars_office365tasks_setattachmentdata(void* lpObj, int attachmentindex, const char* lpAttachmentData, int lenAttachmentData);

char* cloudcalendars_office365tasks_getattachmentfilename(void* lpObj, int attachmentindex);
int cloudcalendars_office365tasks_setattachmentfilename(void* lpObj, int attachmentindex, const char* lpszAttachmentFileName);

char* cloudcalendars_office365tasks_getattachmentid(void* lpObj, int attachmentindex);

int cloudcalendars_office365tasks_setattachmentinputstream(void* lpObj, int attachmentindex, CloudCalendarsStream* sAttachmentInputStream);

char* cloudcalendars_office365tasks_getattachmentjson(void* lpObj, int attachmentindex);
int cloudcalendars_office365tasks_setattachmentjson(void* lpObj, int attachmentindex, const char* lpszAttachmentJSON);

char* cloudcalendars_office365tasks_getattachmentlastmodifieddate(void* lpObj, int attachmentindex);
int cloudcalendars_office365tasks_setattachmentlastmodifieddate(void* lpObj, int attachmentindex, const char* lpszAttachmentLastModifiedDate);

char* cloudcalendars_office365tasks_getattachmentname(void* lpObj, int attachmentindex);
int cloudcalendars_office365tasks_setattachmentname(void* lpObj, int attachmentindex, const char* lpszAttachmentName);

int cloudcalendars_office365tasks_getattachmentsize(void* lpObj, int attachmentindex);
int cloudcalendars_office365tasks_setattachmentsize(void* lpObj, int attachmentindex, int iAttachmentSize);

char* cloudcalendars_office365tasks_getattachmenttaskid(void* lpObj, int attachmentindex);

char* cloudcalendars_office365tasks_getattachmenttasklistid(void* lpObj, int attachmentindex);

int GetAttachmentsCount();
int SetAttachmentsCount(int iAttachmentsCount);

QString GetAttachmentContentType(int iAttachmentIndex);

QByteArray GetAttachmentData(int iAttachmentIndex);
int SetAttachmentData(int iAttachmentIndex, QByteArray qbaAttachmentData);

QString GetAttachmentFileName(int iAttachmentIndex);
int SetAttachmentFileName(int iAttachmentIndex, QString qsAttachmentFileName);

QString GetAttachmentId(int iAttachmentIndex);

int SetAttachmentInputStream(int iAttachmentIndex, CloudCalendarsStream* sAttachmentInputStream);

QString GetAttachmentJSON(int iAttachmentIndex);
int SetAttachmentJSON(int iAttachmentIndex, QString qsAttachmentJSON);

QString GetAttachmentLastModifiedDate(int iAttachmentIndex);
int SetAttachmentLastModifiedDate(int iAttachmentIndex, QString qsAttachmentLastModifiedDate);

QString GetAttachmentName(int iAttachmentIndex);
int SetAttachmentName(int iAttachmentIndex, QString qsAttachmentName);

int GetAttachmentSize(int iAttachmentIndex);
int SetAttachmentSize(int iAttachmentIndex, int iAttachmentSize);

QString GetAttachmentTaskId(int iAttachmentIndex);

QString GetAttachmentTaskListId(int iAttachmentIndex);

Remarks

This collection contains a list of attachments returned by the server when ListAttachments is called.

This property is not available at design time.

Data Type

CloudCalendarsOTAttachment

Authorization Property (Office365Tasks Class)

An OAuth Authorization String.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAuthorization();
int SetAuthorization(const char* lpszAuthorization);

Unicode (Windows)
LPWSTR GetAuthorization();
INT SetAuthorization(LPCWSTR lpszAuthorization);

char* cloudcalendars_office365tasks_getauthorization(void* lpObj);
int cloudcalendars_office365tasks_setauthorization(void* lpObj, const char* lpszAuthorization);

QString GetAuthorization();
int SetAuthorization(QString qsAuthorization);

Default Value

""

Remarks

This property is used to specify an OAuth authorization string. Setting it is a requirement for using the component.

Example

Oauth oauth = new Oauth(); oauth.ClientId = "YourClientId"; oauth.ClientSecret = "YourClientSecret"; oauth.ServerAuthURL = "https://login.microsoftonline.com/common/oauth2/v2.0/authorize"; oauth.ServerTokenURL = "https://login.microsoftonline.com/common/oauth2/v2.0/token"; oauth.AuthorizationScope = "user.read"; oauth.GrantType = OauthGrantTypes.ogtAuthorizationCode; office365tasks.Authorization = oauth.GetAuthorization();

This property is not available at design time.

Data Type

String

CheckListItems Property (Office365Tasks Class)

The collection of subtasks listed by the server.

Syntax

• C++
• C
• Qt

CloudCalendarsList<CloudCalendarsOTCheckListItem>* GetCheckListItems();
int SetCheckListItems(CloudCalendarsList<CloudCalendarsOTCheckListItem>* val);

int cloudcalendars_office365tasks_getchecklistitemscount(void* lpObj);
int cloudcalendars_office365tasks_setchecklistitemscount(void* lpObj, int iCheckListItemsCount);

char* cloudcalendars_office365tasks_getchecklistitemcheckeddatetime(void* lpObj, int checklistitemindex);

char* cloudcalendars_office365tasks_getchecklistitemcreateddatetime(void* lpObj, int checklistitemindex);

char* cloudcalendars_office365tasks_getchecklistitemdisplayname(void* lpObj, int checklistitemindex);
int cloudcalendars_office365tasks_setchecklistitemdisplayname(void* lpObj, int checklistitemindex, const char* lpszCheckListItemDisplayName);

char* cloudcalendars_office365tasks_getchecklistitemid(void* lpObj, int checklistitemindex);

int cloudcalendars_office365tasks_getchecklistitemischecked(void* lpObj, int checklistitemindex);
int cloudcalendars_office365tasks_setchecklistitemischecked(void* lpObj, int checklistitemindex, int bCheckListItemIsChecked);

char* cloudcalendars_office365tasks_getchecklistitemtaskid(void* lpObj, int checklistitemindex);

char* cloudcalendars_office365tasks_getchecklistitemtasklistid(void* lpObj, int checklistitemindex);

int GetCheckListItemsCount();
int SetCheckListItemsCount(int iCheckListItemsCount);

QString GetCheckListItemCheckedDateTime(int iCheckListItemIndex);

QString GetCheckListItemCreatedDateTime(int iCheckListItemIndex);

QString GetCheckListItemDisplayName(int iCheckListItemIndex);
int SetCheckListItemDisplayName(int iCheckListItemIndex, QString qsCheckListItemDisplayName);

QString GetCheckListItemId(int iCheckListItemIndex);

bool GetCheckListItemIsChecked(int iCheckListItemIndex);
int SetCheckListItemIsChecked(int iCheckListItemIndex, bool bCheckListItemIsChecked);

QString GetCheckListItemTaskId(int iCheckListItemIndex);

QString GetCheckListItemTaskListId(int iCheckListItemIndex);

Remarks

This collection contains a list of subtasks returned by the server. It is populated when ListCheckListItems or GetCheckListItem is called. A GetCheckListItem call adds the retrieved subtask to the beginning of the list. If the subtask already exists in the CheckListItems collection, it will be removed and then added to the beginning, preventing duplication.

This property is not available at design time.

Data Type

CloudCalendarsOTCheckListItem

Firewall Property (Office365Tasks Class)

A set of properties related to firewall access.

Syntax

• C++
• C
• Qt

CloudCalendarsFirewall* GetFirewall();
int SetFirewall(CloudCalendarsFirewall* val);

int cloudcalendars_office365tasks_getfirewallautodetect(void* lpObj);
int cloudcalendars_office365tasks_setfirewallautodetect(void* lpObj, int bFirewallAutoDetect);

int cloudcalendars_office365tasks_getfirewalltype(void* lpObj);
int cloudcalendars_office365tasks_setfirewalltype(void* lpObj, int iFirewallType);

char* cloudcalendars_office365tasks_getfirewallhost(void* lpObj);
int cloudcalendars_office365tasks_setfirewallhost(void* lpObj, const char* lpszFirewallHost);

char* cloudcalendars_office365tasks_getfirewallpassword(void* lpObj);
int cloudcalendars_office365tasks_setfirewallpassword(void* lpObj, const char* lpszFirewallPassword);

int cloudcalendars_office365tasks_getfirewallport(void* lpObj);
int cloudcalendars_office365tasks_setfirewallport(void* lpObj, int iFirewallPort);

char* cloudcalendars_office365tasks_getfirewalluser(void* lpObj);
int cloudcalendars_office365tasks_setfirewalluser(void* lpObj, const char* lpszFirewallUser);

bool GetFirewallAutoDetect();
int SetFirewallAutoDetect(bool bFirewallAutoDetect);

int GetFirewallType();
int SetFirewallType(int iFirewallType);

QString GetFirewallHost();
int SetFirewallHost(QString qsFirewallHost);

QString GetFirewallPassword();
int SetFirewallPassword(QString qsFirewallPassword);

int GetFirewallPort();
int SetFirewallPort(int iFirewallPort);

QString GetFirewallUser();
int SetFirewallUser(QString qsFirewallUser);

Remarks

This is a Firewall-type property, which contains fields describing the firewall through which the class will attempt to connect.

Data Type

CloudCalendarsFirewall

ListTasksMarker Property (Office365Tasks Class)

The page marker for listing tasks.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetListTasksMarker();
int SetListTasksMarker(const char* lpszListTasksMarker);

Unicode (Windows)
LPWSTR GetListTasksMarker();
INT SetListTasksMarker(LPCWSTR lpszListTasksMarker);

char* cloudcalendars_office365tasks_getlisttasksmarker(void* lpObj);
int cloudcalendars_office365tasks_setlisttasksmarker(void* lpObj, const char* lpszListTasksMarker);

QString GetListTasksMarker();
int SetListTasksMarker(QString qsListTasksMarker);

Default Value

""

Remarks

This property is populated if there are still unlisted tasks after ListTasks is called. It contains the nextLink that will be included as an OData parameter if ListTasks is called again. This will cause the next page of tasks to be listed and added to the end of the Tasks collection.

This property is not available at design time.

Data Type

String

OAuth Property (Office365Tasks Class)

This property holds the OAuth Settings.

Syntax

• C++
• C
• Qt

CloudCalendarsOAuthSettings* GetOAuth();

char* cloudcalendars_office365tasks_getoauthaccesstoken(void* lpObj);
int cloudcalendars_office365tasks_setoauthaccesstoken(void* lpObj, const char* lpszOAuthAccessToken);

char* cloudcalendars_office365tasks_getoauthauthorizationcode(void* lpObj);
int cloudcalendars_office365tasks_setoauthauthorizationcode(void* lpObj, const char* lpszOAuthAuthorizationCode);

char* cloudcalendars_office365tasks_getoauthauthorizationscope(void* lpObj);
int cloudcalendars_office365tasks_setoauthauthorizationscope(void* lpObj, const char* lpszOAuthAuthorizationScope);

char* cloudcalendars_office365tasks_getoauthclientid(void* lpObj);
int cloudcalendars_office365tasks_setoauthclientid(void* lpObj, const char* lpszOAuthClientId);

int cloudcalendars_office365tasks_getoauthclientprofile(void* lpObj);
int cloudcalendars_office365tasks_setoauthclientprofile(void* lpObj, int iOAuthClientProfile);

char* cloudcalendars_office365tasks_getoauthclientsecret(void* lpObj);
int cloudcalendars_office365tasks_setoauthclientsecret(void* lpObj, const char* lpszOAuthClientSecret);

int cloudcalendars_office365tasks_getoauthgranttype(void* lpObj);
int cloudcalendars_office365tasks_setoauthgranttype(void* lpObj, int iOAuthGrantType);

char* cloudcalendars_office365tasks_getoauthrefreshtoken(void* lpObj);
int cloudcalendars_office365tasks_setoauthrefreshtoken(void* lpObj, const char* lpszOAuthRefreshToken);

int cloudcalendars_office365tasks_getoauthrequestrefreshtoken(void* lpObj);
int cloudcalendars_office365tasks_setoauthrequestrefreshtoken(void* lpObj, int bOAuthRequestRefreshToken);

char* cloudcalendars_office365tasks_getoauthreturnurl(void* lpObj);
int cloudcalendars_office365tasks_setoauthreturnurl(void* lpObj, const char* lpszOAuthReturnURL);

char* cloudcalendars_office365tasks_getoauthserverauthurl(void* lpObj);
int cloudcalendars_office365tasks_setoauthserverauthurl(void* lpObj, const char* lpszOAuthServerAuthURL);

char* cloudcalendars_office365tasks_getoauthservertokenurl(void* lpObj);
int cloudcalendars_office365tasks_setoauthservertokenurl(void* lpObj, const char* lpszOAuthServerTokenURL);

char* cloudcalendars_office365tasks_getoauthwebauthurl(void* lpObj);

QString GetOAuthAccessToken();
int SetOAuthAccessToken(QString qsOAuthAccessToken);

QString GetOAuthAuthorizationCode();
int SetOAuthAuthorizationCode(QString qsOAuthAuthorizationCode);

QString GetOAuthAuthorizationScope();
int SetOAuthAuthorizationScope(QString qsOAuthAuthorizationScope);

QString GetOAuthClientId();
int SetOAuthClientId(QString qsOAuthClientId);

int GetOAuthClientProfile();
int SetOAuthClientProfile(int iOAuthClientProfile);

QString GetOAuthClientSecret();
int SetOAuthClientSecret(QString qsOAuthClientSecret);

int GetOAuthGrantType();
int SetOAuthGrantType(int iOAuthGrantType);

QString GetOAuthRefreshToken();
int SetOAuthRefreshToken(QString qsOAuthRefreshToken);

bool GetOAuthRequestRefreshToken();
int SetOAuthRequestRefreshToken(bool bOAuthRequestRefreshToken);

QString GetOAuthReturnURL();
int SetOAuthReturnURL(QString qsOAuthReturnURL);

QString GetOAuthServerAuthURL();
int SetOAuthServerAuthURL(QString qsOAuthServerAuthURL);

QString GetOAuthServerTokenURL();
int SetOAuthServerTokenURL(QString qsOAuthServerTokenURL);

QString GetOAuthWebAuthURL();

Remarks

This property is used to define the necessary fields to authenticate with the service provider. See the introduction for more information.

This property is read-only and not available at design time.

Data Type

CloudCalendarsOAuthSettings

Proxy Property (Office365Tasks Class)

A set of properties related to proxy access.

Syntax

• C++
• C
• Qt

CloudCalendarsProxy* GetProxy();
int SetProxy(CloudCalendarsProxy* val);

int cloudcalendars_office365tasks_getproxyauthscheme(void* lpObj);
int cloudcalendars_office365tasks_setproxyauthscheme(void* lpObj, int iProxyAuthScheme);

int cloudcalendars_office365tasks_getproxyautodetect(void* lpObj);
int cloudcalendars_office365tasks_setproxyautodetect(void* lpObj, int bProxyAutoDetect);

char* cloudcalendars_office365tasks_getproxypassword(void* lpObj);
int cloudcalendars_office365tasks_setproxypassword(void* lpObj, const char* lpszProxyPassword);

int cloudcalendars_office365tasks_getproxyport(void* lpObj);
int cloudcalendars_office365tasks_setproxyport(void* lpObj, int iProxyPort);

char* cloudcalendars_office365tasks_getproxyserver(void* lpObj);
int cloudcalendars_office365tasks_setproxyserver(void* lpObj, const char* lpszProxyServer);

int cloudcalendars_office365tasks_getproxyssl(void* lpObj);
int cloudcalendars_office365tasks_setproxyssl(void* lpObj, int iProxySSL);

char* cloudcalendars_office365tasks_getproxyuser(void* lpObj);
int cloudcalendars_office365tasks_setproxyuser(void* lpObj, const char* lpszProxyUser);

int GetProxyAuthScheme();
int SetProxyAuthScheme(int iProxyAuthScheme);

bool GetProxyAutoDetect();
int SetProxyAutoDetect(bool bProxyAutoDetect);

QString GetProxyPassword();
int SetProxyPassword(QString qsProxyPassword);

int GetProxyPort();
int SetProxyPort(int iProxyPort);

QString GetProxyServer();
int SetProxyServer(QString qsProxyServer);

int GetProxySSL();
int SetProxySSL(int iProxySSL);

QString GetProxyUser();
int SetProxyUser(QString qsProxyUser);

Remarks

This property contains fields describing the proxy through which the class will attempt to connect.

Data Type

CloudCalendarsProxy

SSLAcceptServerCert Property (Office365Tasks Class)

Instructs the class to unconditionally accept the server certificate that matches the supplied certificate.

Syntax

• C++
• C
• Qt

CloudCalendarsCertificate* GetSSLAcceptServerCert();
int SetSSLAcceptServerCert(CloudCalendarsCertificate* val);

char* cloudcalendars_office365tasks_getsslacceptservercerteffectivedate(void* lpObj);

char* cloudcalendars_office365tasks_getsslacceptservercertexpirationdate(void* lpObj);

char* cloudcalendars_office365tasks_getsslacceptservercertextendedkeyusage(void* lpObj);

char* cloudcalendars_office365tasks_getsslacceptservercertfingerprint(void* lpObj);

char* cloudcalendars_office365tasks_getsslacceptservercertfingerprintsha1(void* lpObj);

char* cloudcalendars_office365tasks_getsslacceptservercertfingerprintsha256(void* lpObj);

char* cloudcalendars_office365tasks_getsslacceptservercertissuer(void* lpObj);

char* cloudcalendars_office365tasks_getsslacceptservercertprivatekey(void* lpObj);

int cloudcalendars_office365tasks_getsslacceptservercertprivatekeyavailable(void* lpObj);

char* cloudcalendars_office365tasks_getsslacceptservercertprivatekeycontainer(void* lpObj);

char* cloudcalendars_office365tasks_getsslacceptservercertpublickey(void* lpObj);

char* cloudcalendars_office365tasks_getsslacceptservercertpublickeyalgorithm(void* lpObj);

int cloudcalendars_office365tasks_getsslacceptservercertpublickeylength(void* lpObj);

char* cloudcalendars_office365tasks_getsslacceptservercertserialnumber(void* lpObj);

char* cloudcalendars_office365tasks_getsslacceptservercertsignaturealgorithm(void* lpObj);

int cloudcalendars_office365tasks_getsslacceptservercertstore(void* lpObj, char** lpSSLAcceptServerCertStore, int* lenSSLAcceptServerCertStore);
int cloudcalendars_office365tasks_setsslacceptservercertstore(void* lpObj, const char* lpSSLAcceptServerCertStore, int lenSSLAcceptServerCertStore);

char* cloudcalendars_office365tasks_getsslacceptservercertstorepassword(void* lpObj);
int cloudcalendars_office365tasks_setsslacceptservercertstorepassword(void* lpObj, const char* lpszSSLAcceptServerCertStorePassword);

int cloudcalendars_office365tasks_getsslacceptservercertstoretype(void* lpObj);
int cloudcalendars_office365tasks_setsslacceptservercertstoretype(void* lpObj, int iSSLAcceptServerCertStoreType);

char* cloudcalendars_office365tasks_getsslacceptservercertsubjectaltnames(void* lpObj);

char* cloudcalendars_office365tasks_getsslacceptservercertthumbprintmd5(void* lpObj);

char* cloudcalendars_office365tasks_getsslacceptservercertthumbprintsha1(void* lpObj);

char* cloudcalendars_office365tasks_getsslacceptservercertthumbprintsha256(void* lpObj);

char* cloudcalendars_office365tasks_getsslacceptservercertusage(void* lpObj);

int cloudcalendars_office365tasks_getsslacceptservercertusageflags(void* lpObj);

char* cloudcalendars_office365tasks_getsslacceptservercertversion(void* lpObj);

char* cloudcalendars_office365tasks_getsslacceptservercertsubject(void* lpObj);
int cloudcalendars_office365tasks_setsslacceptservercertsubject(void* lpObj, const char* lpszSSLAcceptServerCertSubject);

int cloudcalendars_office365tasks_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int cloudcalendars_office365tasks_setsslacceptservercertencoded(void* lpObj, const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);

QString GetSSLAcceptServerCertEffectiveDate();

QString GetSSLAcceptServerCertExpirationDate();

QString GetSSLAcceptServerCertExtendedKeyUsage();

QString GetSSLAcceptServerCertFingerprint();

QString GetSSLAcceptServerCertFingerprintSHA1();

QString GetSSLAcceptServerCertFingerprintSHA256();

QString GetSSLAcceptServerCertIssuer();

QString GetSSLAcceptServerCertPrivateKey();

bool GetSSLAcceptServerCertPrivateKeyAvailable();

QString GetSSLAcceptServerCertPrivateKeyContainer();

QString GetSSLAcceptServerCertPublicKey();

QString GetSSLAcceptServerCertPublicKeyAlgorithm();

int GetSSLAcceptServerCertPublicKeyLength();

QString GetSSLAcceptServerCertSerialNumber();

QString GetSSLAcceptServerCertSignatureAlgorithm();

QByteArray GetSSLAcceptServerCertStore();
int SetSSLAcceptServerCertStore(QByteArray qbaSSLAcceptServerCertStore);

QString GetSSLAcceptServerCertStorePassword();
int SetSSLAcceptServerCertStorePassword(QString qsSSLAcceptServerCertStorePassword);

int GetSSLAcceptServerCertStoreType();
int SetSSLAcceptServerCertStoreType(int iSSLAcceptServerCertStoreType);

QString GetSSLAcceptServerCertSubjectAltNames();

QString GetSSLAcceptServerCertThumbprintMD5();

QString GetSSLAcceptServerCertThumbprintSHA1();

QString GetSSLAcceptServerCertThumbprintSHA256();

QString GetSSLAcceptServerCertUsage();

int GetSSLAcceptServerCertUsageFlags();

QString GetSSLAcceptServerCertVersion();

QString GetSSLAcceptServerCertSubject();
int SetSSLAcceptServerCertSubject(QString qsSSLAcceptServerCertSubject);

QByteArray GetSSLAcceptServerCertEncoded();
int SetSSLAcceptServerCertEncoded(QByteArray qbaSSLAcceptServerCertEncoded);

Remarks

If it finds any issues with the certificate presented by the server, the class will normally terminate the connection with an error.

You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.

Note: This functionality is provided only for cases in which you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk.

Data Type

CloudCalendarsCertificate

SSLCert Property (Office365Tasks Class)

The certificate to be used during Secure Sockets Layer (SSL) negotiation.

Syntax

• C++
• C
• Qt

CloudCalendarsCertificate* GetSSLCert();
int SetSSLCert(CloudCalendarsCertificate* val);

char* cloudcalendars_office365tasks_getsslcerteffectivedate(void* lpObj);

char* cloudcalendars_office365tasks_getsslcertexpirationdate(void* lpObj);

char* cloudcalendars_office365tasks_getsslcertextendedkeyusage(void* lpObj);

char* cloudcalendars_office365tasks_getsslcertfingerprint(void* lpObj);

char* cloudcalendars_office365tasks_getsslcertfingerprintsha1(void* lpObj);

char* cloudcalendars_office365tasks_getsslcertfingerprintsha256(void* lpObj);

char* cloudcalendars_office365tasks_getsslcertissuer(void* lpObj);

char* cloudcalendars_office365tasks_getsslcertprivatekey(void* lpObj);

int cloudcalendars_office365tasks_getsslcertprivatekeyavailable(void* lpObj);

char* cloudcalendars_office365tasks_getsslcertprivatekeycontainer(void* lpObj);

char* cloudcalendars_office365tasks_getsslcertpublickey(void* lpObj);

char* cloudcalendars_office365tasks_getsslcertpublickeyalgorithm(void* lpObj);

int cloudcalendars_office365tasks_getsslcertpublickeylength(void* lpObj);

char* cloudcalendars_office365tasks_getsslcertserialnumber(void* lpObj);

char* cloudcalendars_office365tasks_getsslcertsignaturealgorithm(void* lpObj);

int cloudcalendars_office365tasks_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int cloudcalendars_office365tasks_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);

char* cloudcalendars_office365tasks_getsslcertstorepassword(void* lpObj);
int cloudcalendars_office365tasks_setsslcertstorepassword(void* lpObj, const char* lpszSSLCertStorePassword);

int cloudcalendars_office365tasks_getsslcertstoretype(void* lpObj);
int cloudcalendars_office365tasks_setsslcertstoretype(void* lpObj, int iSSLCertStoreType);

char* cloudcalendars_office365tasks_getsslcertsubjectaltnames(void* lpObj);

char* cloudcalendars_office365tasks_getsslcertthumbprintmd5(void* lpObj);

char* cloudcalendars_office365tasks_getsslcertthumbprintsha1(void* lpObj);

char* cloudcalendars_office365tasks_getsslcertthumbprintsha256(void* lpObj);

char* cloudcalendars_office365tasks_getsslcertusage(void* lpObj);

int cloudcalendars_office365tasks_getsslcertusageflags(void* lpObj);

char* cloudcalendars_office365tasks_getsslcertversion(void* lpObj);

char* cloudcalendars_office365tasks_getsslcertsubject(void* lpObj);
int cloudcalendars_office365tasks_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);

int cloudcalendars_office365tasks_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int cloudcalendars_office365tasks_setsslcertencoded(void* lpObj, const char* lpSSLCertEncoded, int lenSSLCertEncoded);

QString GetSSLCertEffectiveDate();

QString GetSSLCertExpirationDate();

QString GetSSLCertExtendedKeyUsage();

QString GetSSLCertFingerprint();

QString GetSSLCertFingerprintSHA1();

QString GetSSLCertFingerprintSHA256();

QString GetSSLCertIssuer();

QString GetSSLCertPrivateKey();

bool GetSSLCertPrivateKeyAvailable();

QString GetSSLCertPrivateKeyContainer();

QString GetSSLCertPublicKey();

QString GetSSLCertPublicKeyAlgorithm();

int GetSSLCertPublicKeyLength();

QString GetSSLCertSerialNumber();

QString GetSSLCertSignatureAlgorithm();

QByteArray GetSSLCertStore();
int SetSSLCertStore(QByteArray qbaSSLCertStore);

QString GetSSLCertStorePassword();
int SetSSLCertStorePassword(QString qsSSLCertStorePassword);

int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType);

QString GetSSLCertSubjectAltNames();

QString GetSSLCertThumbprintMD5();

QString GetSSLCertThumbprintSHA1();

QString GetSSLCertThumbprintSHA256();

QString GetSSLCertUsage();

int GetSSLCertUsageFlags();

QString GetSSLCertVersion();

QString GetSSLCertSubject();
int SetSSLCertSubject(QString qsSSLCertSubject);

QByteArray GetSSLCertEncoded();
int SetSSLCertEncoded(QByteArray qbaSSLCertEncoded);

Remarks

This property includes the digital certificate that the class will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the Encoded field to the encoded certificate. To select a certificate, use the store and subject fields.

Data Type

CloudCalendarsCertificate

SSLProvider Property (Office365Tasks Class)

The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLProvider();
int SetSSLProvider(int iSSLProvider);

Unicode (Windows)
INT GetSSLProvider();
INT SetSSLProvider(INT iSSLProvider);

SSLP_AUTOMATIC(0), 
SSLP_PLATFORM(1), 
SSLP_INTERNAL(2)

int cloudcalendars_office365tasks_getsslprovider(void* lpObj);
int cloudcalendars_office365tasks_setsslprovider(void* lpObj, int iSSLProvider);

int GetSSLProvider();
int SetSSLProvider(int iSSLProvider);

Default Value

0

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic), the class will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are as follows:

In most cases using the default value (Automatic) is recommended. The class will select a provider depending on the current platform.

When Automatic is selected, on Windows, the class will use the platform implementation. On Linux/macOS, the class will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols, the internal implementation is used on all platforms.

Data Type

Integer

SSLServerCert Property (Office365Tasks Class)

The server certificate for the last established connection.

Syntax

• C++
• C
• Qt

CloudCalendarsCertificate* GetSSLServerCert();

char* cloudcalendars_office365tasks_getsslservercerteffectivedate(void* lpObj);

char* cloudcalendars_office365tasks_getsslservercertexpirationdate(void* lpObj);

char* cloudcalendars_office365tasks_getsslservercertextendedkeyusage(void* lpObj);

char* cloudcalendars_office365tasks_getsslservercertfingerprint(void* lpObj);

char* cloudcalendars_office365tasks_getsslservercertfingerprintsha1(void* lpObj);

char* cloudcalendars_office365tasks_getsslservercertfingerprintsha256(void* lpObj);

char* cloudcalendars_office365tasks_getsslservercertissuer(void* lpObj);

char* cloudcalendars_office365tasks_getsslservercertprivatekey(void* lpObj);

int cloudcalendars_office365tasks_getsslservercertprivatekeyavailable(void* lpObj);

char* cloudcalendars_office365tasks_getsslservercertprivatekeycontainer(void* lpObj);

char* cloudcalendars_office365tasks_getsslservercertpublickey(void* lpObj);

char* cloudcalendars_office365tasks_getsslservercertpublickeyalgorithm(void* lpObj);

int cloudcalendars_office365tasks_getsslservercertpublickeylength(void* lpObj);

char* cloudcalendars_office365tasks_getsslservercertserialnumber(void* lpObj);

char* cloudcalendars_office365tasks_getsslservercertsignaturealgorithm(void* lpObj);

int cloudcalendars_office365tasks_getsslservercertstore(void* lpObj, char** lpSSLServerCertStore, int* lenSSLServerCertStore);

char* cloudcalendars_office365tasks_getsslservercertstorepassword(void* lpObj);

int cloudcalendars_office365tasks_getsslservercertstoretype(void* lpObj);

char* cloudcalendars_office365tasks_getsslservercertsubjectaltnames(void* lpObj);

char* cloudcalendars_office365tasks_getsslservercertthumbprintmd5(void* lpObj);

char* cloudcalendars_office365tasks_getsslservercertthumbprintsha1(void* lpObj);

char* cloudcalendars_office365tasks_getsslservercertthumbprintsha256(void* lpObj);

char* cloudcalendars_office365tasks_getsslservercertusage(void* lpObj);

int cloudcalendars_office365tasks_getsslservercertusageflags(void* lpObj);

char* cloudcalendars_office365tasks_getsslservercertversion(void* lpObj);

char* cloudcalendars_office365tasks_getsslservercertsubject(void* lpObj);

int cloudcalendars_office365tasks_getsslservercertencoded(void* lpObj, char** lpSSLServerCertEncoded, int* lenSSLServerCertEncoded);

QString GetSSLServerCertEffectiveDate();

QString GetSSLServerCertExpirationDate();

QString GetSSLServerCertExtendedKeyUsage();

QString GetSSLServerCertFingerprint();

QString GetSSLServerCertFingerprintSHA1();

QString GetSSLServerCertFingerprintSHA256();

QString GetSSLServerCertIssuer();

QString GetSSLServerCertPrivateKey();

bool GetSSLServerCertPrivateKeyAvailable();

QString GetSSLServerCertPrivateKeyContainer();

QString GetSSLServerCertPublicKey();

QString GetSSLServerCertPublicKeyAlgorithm();

int GetSSLServerCertPublicKeyLength();

QString GetSSLServerCertSerialNumber();

QString GetSSLServerCertSignatureAlgorithm();

QByteArray GetSSLServerCertStore();

QString GetSSLServerCertStorePassword();

int GetSSLServerCertStoreType();

QString GetSSLServerCertSubjectAltNames();

QString GetSSLServerCertThumbprintMD5();

QString GetSSLServerCertThumbprintSHA1();

QString GetSSLServerCertThumbprintSHA256();

QString GetSSLServerCertUsage();

int GetSSLServerCertUsageFlags();

QString GetSSLServerCertVersion();

QString GetSSLServerCertSubject();

QByteArray GetSSLServerCertEncoded();

Remarks

This property contains the server certificate for the last established connection.

SSLServerCert is reset every time a new connection is attempted.

This property is read-only.

Data Type

CloudCalendarsCertificate

TaskLists Property (Office365Tasks Class)

The collection of task lists listed by the server.

Syntax

• C++
• C
• Qt

CloudCalendarsList<CloudCalendarsOTTaskList>* GetTaskLists();
int SetTaskLists(CloudCalendarsList<CloudCalendarsOTTaskList>* val);

int cloudcalendars_office365tasks_gettasklistscount(void* lpObj);
int cloudcalendars_office365tasks_settasklistscount(void* lpObj, int iTaskListsCount);

char* cloudcalendars_office365tasks_gettasklistdisplayname(void* lpObj, int tasklistindex);
int cloudcalendars_office365tasks_settasklistdisplayname(void* lpObj, int tasklistindex, const char* lpszTaskListDisplayName);

char* cloudcalendars_office365tasks_gettasklistid(void* lpObj, int tasklistindex);

int cloudcalendars_office365tasks_gettasklistisdefault(void* lpObj, int tasklistindex);

int cloudcalendars_office365tasks_gettasklistisowner(void* lpObj, int tasklistindex);

int cloudcalendars_office365tasks_gettasklistisshared(void* lpObj, int tasklistindex);

int GetTaskListsCount();
int SetTaskListsCount(int iTaskListsCount);

QString GetTaskListDisplayName(int iTaskListIndex);
int SetTaskListDisplayName(int iTaskListIndex, QString qsTaskListDisplayName);

QString GetTaskListId(int iTaskListIndex);

bool GetTaskListIsDefault(int iTaskListIndex);

bool GetTaskListIsOwner(int iTaskListIndex);

bool GetTaskListIsShared(int iTaskListIndex);

Remarks

This collection contains a list of task lists returned by the server. It is populated when ListTaskLists is called.

This property is not available at design time.

Data Type

CloudCalendarsOTTaskList

Tasks Property (Office365Tasks Class)

The collection of tasks listed by the server.

Syntax

• C++
• C
• Qt

CloudCalendarsList<CloudCalendarsOTTaskItem>* GetTasks();
int SetTasks(CloudCalendarsList<CloudCalendarsOTTaskItem>* val);

int cloudcalendars_office365tasks_gettaskscount(void* lpObj);
int cloudcalendars_office365tasks_settaskscount(void* lpObj, int iTasksCount);

char* cloudcalendars_office365tasks_gettaskbody(void* lpObj, int taskindex);
int cloudcalendars_office365tasks_settaskbody(void* lpObj, int taskindex, const char* lpszTaskBody);

char* cloudcalendars_office365tasks_gettaskbodylastmodifieddatetime(void* lpObj, int taskindex);

char* cloudcalendars_office365tasks_gettaskcategories(void* lpObj, int taskindex);
int cloudcalendars_office365tasks_settaskcategories(void* lpObj, int taskindex, const char* lpszTaskCategories);

char* cloudcalendars_office365tasks_gettaskcompleteddatetime(void* lpObj, int taskindex);
int cloudcalendars_office365tasks_settaskcompleteddatetime(void* lpObj, int taskindex, const char* lpszTaskCompletedDateTime);

char* cloudcalendars_office365tasks_gettaskcompletedtimezone(void* lpObj, int taskindex);
int cloudcalendars_office365tasks_settaskcompletedtimezone(void* lpObj, int taskindex, const char* lpszTaskCompletedTimeZone);

char* cloudcalendars_office365tasks_gettaskcreateddatetime(void* lpObj, int taskindex);

char* cloudcalendars_office365tasks_gettaskduedatetime(void* lpObj, int taskindex);
int cloudcalendars_office365tasks_settaskduedatetime(void* lpObj, int taskindex, const char* lpszTaskDueDateTime);

char* cloudcalendars_office365tasks_gettaskduetimezone(void* lpObj, int taskindex);
int cloudcalendars_office365tasks_settaskduetimezone(void* lpObj, int taskindex, const char* lpszTaskDueTimeZone);

int cloudcalendars_office365tasks_gettaskhasattachments(void* lpObj, int taskindex);

char* cloudcalendars_office365tasks_gettaskid(void* lpObj, int taskindex);

int cloudcalendars_office365tasks_gettaskimportance(void* lpObj, int taskindex);
int cloudcalendars_office365tasks_settaskimportance(void* lpObj, int taskindex, int iTaskImportance);

int cloudcalendars_office365tasks_gettaskisreminderon(void* lpObj, int taskindex);
int cloudcalendars_office365tasks_settaskisreminderon(void* lpObj, int taskindex, int bTaskIsReminderOn);

char* cloudcalendars_office365tasks_gettaskjson(void* lpObj, int taskindex);
int cloudcalendars_office365tasks_settaskjson(void* lpObj, int taskindex, const char* lpszTaskJSON);

char* cloudcalendars_office365tasks_gettasklastmodifieddatetime(void* lpObj, int taskindex);

int cloudcalendars_office365tasks_gettaskrecurdayofmonth(void* lpObj, int taskindex);
int cloudcalendars_office365tasks_settaskrecurdayofmonth(void* lpObj, int taskindex, int iTaskRecurDayOfMonth);

char* cloudcalendars_office365tasks_gettaskrecurdaysofweek(void* lpObj, int taskindex);
int cloudcalendars_office365tasks_settaskrecurdaysofweek(void* lpObj, int taskindex, const char* lpszTaskRecurDaysOfWeek);

char* cloudcalendars_office365tasks_gettaskrecurenddate(void* lpObj, int taskindex);
int cloudcalendars_office365tasks_settaskrecurenddate(void* lpObj, int taskindex, const char* lpszTaskRecurEndDate);

char* cloudcalendars_office365tasks_gettaskrecurfirstdayofweek(void* lpObj, int taskindex);
int cloudcalendars_office365tasks_settaskrecurfirstdayofweek(void* lpObj, int taskindex, const char* lpszTaskRecurFirstDayOfWeek);

char* cloudcalendars_office365tasks_gettaskrecurindex(void* lpObj, int taskindex);
int cloudcalendars_office365tasks_settaskrecurindex(void* lpObj, int taskindex, const char* lpszTaskRecurIndex);

int cloudcalendars_office365tasks_gettaskrecurinterval(void* lpObj, int taskindex);
int cloudcalendars_office365tasks_settaskrecurinterval(void* lpObj, int taskindex, int iTaskRecurInterval);

int cloudcalendars_office365tasks_gettaskrecurmonth(void* lpObj, int taskindex);
int cloudcalendars_office365tasks_settaskrecurmonth(void* lpObj, int taskindex, int iTaskRecurMonth);

int cloudcalendars_office365tasks_gettaskrecurnumberofoccurrences(void* lpObj, int taskindex);
int cloudcalendars_office365tasks_settaskrecurnumberofoccurrences(void* lpObj, int taskindex, int iTaskRecurNumberOfOccurrences);

int cloudcalendars_office365tasks_gettaskrecurrangetype(void* lpObj, int taskindex);
int cloudcalendars_office365tasks_settaskrecurrangetype(void* lpObj, int taskindex, int iTaskRecurRangeType);

char* cloudcalendars_office365tasks_gettaskrecurstartdate(void* lpObj, int taskindex);
int cloudcalendars_office365tasks_settaskrecurstartdate(void* lpObj, int taskindex, const char* lpszTaskRecurStartDate);

char* cloudcalendars_office365tasks_gettaskrecurtimezone(void* lpObj, int taskindex);
int cloudcalendars_office365tasks_settaskrecurtimezone(void* lpObj, int taskindex, const char* lpszTaskRecurTimeZone);

int cloudcalendars_office365tasks_gettaskrecurtype(void* lpObj, int taskindex);
int cloudcalendars_office365tasks_settaskrecurtype(void* lpObj, int taskindex, int iTaskRecurType);

char* cloudcalendars_office365tasks_gettaskreminderdatetime(void* lpObj, int taskindex);
int cloudcalendars_office365tasks_settaskreminderdatetime(void* lpObj, int taskindex, const char* lpszTaskReminderDateTime);

char* cloudcalendars_office365tasks_gettaskremindertimezone(void* lpObj, int taskindex);
int cloudcalendars_office365tasks_settaskremindertimezone(void* lpObj, int taskindex, const char* lpszTaskReminderTimeZone);

char* cloudcalendars_office365tasks_gettaskstartdatetime(void* lpObj, int taskindex);
int cloudcalendars_office365tasks_settaskstartdatetime(void* lpObj, int taskindex, const char* lpszTaskStartDateTime);

char* cloudcalendars_office365tasks_gettaskstarttimezone(void* lpObj, int taskindex);
int cloudcalendars_office365tasks_settaskstarttimezone(void* lpObj, int taskindex, const char* lpszTaskStartTimeZone);

int cloudcalendars_office365tasks_gettaskstatus(void* lpObj, int taskindex);
int cloudcalendars_office365tasks_settaskstatus(void* lpObj, int taskindex, int iTaskStatus);

char* cloudcalendars_office365tasks_gettasktasklistid(void* lpObj, int taskindex);

char* cloudcalendars_office365tasks_gettasktitle(void* lpObj, int taskindex);
int cloudcalendars_office365tasks_settasktitle(void* lpObj, int taskindex, const char* lpszTaskTitle);

int GetTasksCount();
int SetTasksCount(int iTasksCount);

QString GetTaskBody(int iTaskIndex);
int SetTaskBody(int iTaskIndex, QString qsTaskBody);

QString GetTaskBodyLastModifiedDateTime(int iTaskIndex);

QString GetTaskCategories(int iTaskIndex);
int SetTaskCategories(int iTaskIndex, QString qsTaskCategories);

QString GetTaskCompletedDateTime(int iTaskIndex);
int SetTaskCompletedDateTime(int iTaskIndex, QString qsTaskCompletedDateTime);

QString GetTaskCompletedTimeZone(int iTaskIndex);
int SetTaskCompletedTimeZone(int iTaskIndex, QString qsTaskCompletedTimeZone);

QString GetTaskCreatedDateTime(int iTaskIndex);

QString GetTaskDueDateTime(int iTaskIndex);
int SetTaskDueDateTime(int iTaskIndex, QString qsTaskDueDateTime);

QString GetTaskDueTimeZone(int iTaskIndex);
int SetTaskDueTimeZone(int iTaskIndex, QString qsTaskDueTimeZone);

bool GetTaskHasAttachments(int iTaskIndex);

QString GetTaskId(int iTaskIndex);

int GetTaskImportance(int iTaskIndex);
int SetTaskImportance(int iTaskIndex, int iTaskImportance);

bool GetTaskIsReminderOn(int iTaskIndex);
int SetTaskIsReminderOn(int iTaskIndex, bool bTaskIsReminderOn);

QString GetTaskJSON(int iTaskIndex);
int SetTaskJSON(int iTaskIndex, QString qsTaskJSON);

QString GetTaskLastModifiedDateTime(int iTaskIndex);

int GetTaskRecurDayOfMonth(int iTaskIndex);
int SetTaskRecurDayOfMonth(int iTaskIndex, int iTaskRecurDayOfMonth);

QString GetTaskRecurDaysOfWeek(int iTaskIndex);
int SetTaskRecurDaysOfWeek(int iTaskIndex, QString qsTaskRecurDaysOfWeek);

QString GetTaskRecurEndDate(int iTaskIndex);
int SetTaskRecurEndDate(int iTaskIndex, QString qsTaskRecurEndDate);

QString GetTaskRecurFirstDayOfWeek(int iTaskIndex);
int SetTaskRecurFirstDayOfWeek(int iTaskIndex, QString qsTaskRecurFirstDayOfWeek);

QString GetTaskRecurIndex(int iTaskIndex);
int SetTaskRecurIndex(int iTaskIndex, QString qsTaskRecurIndex);

int GetTaskRecurInterval(int iTaskIndex);
int SetTaskRecurInterval(int iTaskIndex, int iTaskRecurInterval);

int GetTaskRecurMonth(int iTaskIndex);
int SetTaskRecurMonth(int iTaskIndex, int iTaskRecurMonth);

int GetTaskRecurNumberOfOccurrences(int iTaskIndex);
int SetTaskRecurNumberOfOccurrences(int iTaskIndex, int iTaskRecurNumberOfOccurrences);

int GetTaskRecurRangeType(int iTaskIndex);
int SetTaskRecurRangeType(int iTaskIndex, int iTaskRecurRangeType);

QString GetTaskRecurStartDate(int iTaskIndex);
int SetTaskRecurStartDate(int iTaskIndex, QString qsTaskRecurStartDate);

QString GetTaskRecurTimeZone(int iTaskIndex);
int SetTaskRecurTimeZone(int iTaskIndex, QString qsTaskRecurTimeZone);

int GetTaskRecurType(int iTaskIndex);
int SetTaskRecurType(int iTaskIndex, int iTaskRecurType);

QString GetTaskReminderDateTime(int iTaskIndex);
int SetTaskReminderDateTime(int iTaskIndex, QString qsTaskReminderDateTime);

QString GetTaskReminderTimeZone(int iTaskIndex);
int SetTaskReminderTimeZone(int iTaskIndex, QString qsTaskReminderTimeZone);

QString GetTaskStartDateTime(int iTaskIndex);
int SetTaskStartDateTime(int iTaskIndex, QString qsTaskStartDateTime);

QString GetTaskStartTimeZone(int iTaskIndex);
int SetTaskStartTimeZone(int iTaskIndex, QString qsTaskStartTimeZone);

int GetTaskStatus(int iTaskIndex);
int SetTaskStatus(int iTaskIndex, int iTaskStatus);

QString GetTaskTaskListId(int iTaskIndex);

QString GetTaskTitle(int iTaskIndex);
int SetTaskTitle(int iTaskIndex, QString qsTaskTitle);

Remarks

This collection contains a list of tasks returned by the server. It is populated when ListTasks or GetTask is called. A GetTask call adds the retrieved task to the beginning of the list. If the task already exists in the Tasks collection, it will be removed and then added to the beginning, preventing duplication.

This property is not available at design time.

Data Type

CloudCalendarsOTTaskItem

AddAttachment Method (Office365Tasks Class)

Adds a file attachment to an existing task.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int AddAttachment(const char* lpszTaskListId, const char* lpszTaskId, const char* lpszName, const char* lpszLocalFile);

Unicode (Windows)
INT AddAttachment(LPCWSTR lpszTaskListId, LPCWSTR lpszTaskId, LPCWSTR lpszName, LPCWSTR lpszLocalFile);

int cloudcalendars_office365tasks_addattachment(void* lpObj, const char* lpszTaskListId, const char* lpszTaskId, const char* lpszName, const char* lpszLocalFile);

int AddAttachment(const QString& qsTaskListId, const QString& qsTaskId, const QString& qsName, const QString& qsLocalFile);

Remarks

This method adds a file attachment to an existing task, specified by the TaskId parameter. To add a more complex attachment, set the Name and LocalFile parameters to empty strings and the class will use the first attachment in the Attachments properties. As a note, this will not clear the Attachments properties. If the file is larger than the value set in the AttachmentSimpleUploadLimit configuration, then the class will use an upload session to upload the attachment in fragments. The size of the fragments are specified in the AttachmentFragmentSize configuration. To add an attachment from stream use the SetAttachmentInStream method.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Authorize Method (Office365Tasks Class)

Get the authorization string required to access the protected resource.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Authorize();

Unicode (Windows)
INT Authorize();

int cloudcalendars_office365tasks_authorize(void* lpObj);

int Authorize();

Remarks

This method is used to get an access token that is required to access the protected resource. The method will act differently based on what is set in the ClientProfile field and the GrantType field. This method is not to be used in conjunction with the Authorization property. It should instead be used when setting the OAuth property.

For more information, see the introduction section.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Config Method (Office365Tasks Class)

Sets or retrieves a configuration setting.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* cloudcalendars_office365tasks_config(void* lpObj, const char* lpszConfigurationString);

QString Config(const QString& qsConfigurationString);

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

CreateCheckListItem Method (Office365Tasks Class)

Creates a subtask.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int CreateCheckListItem(const char* lpszSubject, const char* lpszTaskListId, const char* lpszTaskId);

Unicode (Windows)
INT CreateCheckListItem(LPCWSTR lpszSubject, LPCWSTR lpszTaskListId, LPCWSTR lpszTaskId);

int cloudcalendars_office365tasks_createchecklistitem(void* lpObj, const char* lpszSubject, const char* lpszTaskListId, const char* lpszTaskId);

int CreateCheckListItem(const QString& qsSubject, const QString& qsTaskListId, const QString& qsTaskId);

Remarks

Creates a subtask from the specified taskListId and taskId with the specified name. The subject parameter defines the name of the subtask.

The name of the subtask can be updated after creation by calling the UpdateCheckListItem method.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

CreateTask Method (Office365Tasks Class)

Creates a task.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int CreateTask(const char* lpszSubject, const char* lpszTaskListId);

Unicode (Windows)
INT CreateTask(LPCWSTR lpszSubject, LPCWSTR lpszTaskListId);

int cloudcalendars_office365tasks_createtask(void* lpObj, const char* lpszSubject, const char* lpszTaskListId);

int CreateTask(const QString& qsSubject, const QString& qsTaskListId);

Remarks

Creates a new task from the specified taskListId with the specified name. The subject parameter defines the name of the task.

The name of the task can be updated after creation by calling the UpdateTask method.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

CreateTaskList Method (Office365Tasks Class)

Creates a new task list.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int CreateTaskList(const char* lpszName);

Unicode (Windows)
INT CreateTaskList(LPCWSTR lpszName);

int cloudcalendars_office365tasks_createtasklist(void* lpObj, const char* lpszName);

int CreateTaskList(const QString& qsName);

Remarks

Creates a new task list with the specified name. The name parameter defines the name of the task list.

The name of the task list can be updated after creation by calling the UpdateTaskList method.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

DeleteAttachment Method (Office365Tasks Class)

Deletes an attachment.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DeleteAttachment(const char* lpszTaskListId, const char* lpszTaskId, const char* lpszId);

Unicode (Windows)
INT DeleteAttachment(LPCWSTR lpszTaskListId, LPCWSTR lpszTaskId, LPCWSTR lpszId);

int cloudcalendars_office365tasks_deleteattachment(void* lpObj, const char* lpszTaskListId, const char* lpszTaskId, const char* lpszId);

int DeleteAttachment(const QString& qsTaskListId, const QString& qsTaskId, const QString& qsId);

Remarks

This method deletes an attachment. id takes the ID of the task the attachment is attached to. attachmentId takes the attachment ID of an existing attachment. This will not remove the attachment from the Attachments properties.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

DeleteCheckListItem Method (Office365Tasks Class)

Deletes a subtask.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DeleteCheckListItem(const char* lpszTaskListId, const char* lpszTaskId, const char* lpszId);

Unicode (Windows)
INT DeleteCheckListItem(LPCWSTR lpszTaskListId, LPCWSTR lpszTaskId, LPCWSTR lpszId);

int cloudcalendars_office365tasks_deletechecklistitem(void* lpObj, const char* lpszTaskListId, const char* lpszTaskId, const char* lpszId);

int DeleteCheckListItem(const QString& qsTaskListId, const QString& qsTaskId, const QString& qsId);

Remarks

Deletes a subtask identified by taskListId, taskId and id parameters. taskListId and taskIdthe parameters identifies the Task list and Task that the subtask to be deleted belongs to and id parameter identifies the subtask to be deleted. The specified subtask will be permanently removed. This operation will not remove the subtask from the CheckListItems collection

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

DeleteTask Method (Office365Tasks Class)

Deletes a task.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DeleteTask(const char* lpszTaskListId, const char* lpszId);

Unicode (Windows)
INT DeleteTask(LPCWSTR lpszTaskListId, LPCWSTR lpszId);

int cloudcalendars_office365tasks_deletetask(void* lpObj, const char* lpszTaskListId, const char* lpszId);

int DeleteTask(const QString& qsTaskListId, const QString& qsId);

Remarks

Deletes a task identified by taskListId and id parameters. taskListId parameter identifies the Task list that the task to be deleted belongs to and id parameter identifies the task to be deleted. The specified task will be permanently removed. This operation will not remove the task from the Tasks collection

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

DeleteTaskList Method (Office365Tasks Class)

Deletes a task list.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DeleteTaskList(const char* lpszId);

Unicode (Windows)
INT DeleteTaskList(LPCWSTR lpszId);

int cloudcalendars_office365tasks_deletetasklist(void* lpObj, const char* lpszId);

int DeleteTaskList(const QString& qsId);

Remarks

Deletes a Task list identified by the id parameter. The Task list and all its associated tasks will be removed, this operation will not remove the Task list from the TaskLists collection.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

GetCheckListItem Method (Office365Tasks Class)

Retrieves the subtask by Id.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCheckListItem(const char* lpszTaskListId, const char* lpszTaskId, const char* lpszId);

Unicode (Windows)
INT GetCheckListItem(LPCWSTR lpszTaskListId, LPCWSTR lpszTaskId, LPCWSTR lpszId);

int cloudcalendars_office365tasks_getchecklistitem(void* lpObj, const char* lpszTaskListId, const char* lpszTaskId, const char* lpszId);

int GetCheckListItem(const QString& qsTaskListId, const QString& qsTaskId, const QString& qsId);

Remarks

This method retrieves a subtask specified by its ID and adds the subtask to the beginning of the CheckListItems list. If the subtask already exists in the CheckListItems collection, it will be removed and then added to the beginning, preventing duplication.

Example(Retrieving a subtask) office365task.GetCheckListItem("taskListId", "taskId", "id"); office365task.CheckListItems[0]; //the retrieved subtask

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

GetTask Method (Office365Tasks Class)

Retrieves the task by Id.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTask(const char* lpszTaskListId, const char* lpszId);

Unicode (Windows)
INT GetTask(LPCWSTR lpszTaskListId, LPCWSTR lpszId);

int cloudcalendars_office365tasks_gettask(void* lpObj, const char* lpszTaskListId, const char* lpszId);

int GetTask(const QString& qsTaskListId, const QString& qsId);

Remarks

This method retrieves a task specified by its ID and adds the task to the beginning of the Tasks list. If the task already exists in the Tasks collection, it will be removed and then added to the beginning, preventing duplication.

Example(Retrieving a task) office365task.GetTask("taskListId", "id"); office365task.Tasks[0]; //the retrieved task

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

GetTaskField Method (Office365Tasks Class)

Retrieves the task property value by JSONPath.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTaskField(int iindex, const char* lpszJsonPath);

Unicode (Windows)
LPWSTR GetTaskField(INT iindex, LPCWSTR lpszJsonPath);

char* cloudcalendars_office365tasks_gettaskfield(void* lpObj, int iindex, const char* lpszJsonPath);

QString GetTaskField(int iindex, const QString& qsJsonPath);

Remarks

This method retrieves a specific field within the task's JSON field. The first parameter, index, represents the index of the task in the Tasks collection from which to retrieve the field. The second parameter, JsonPath, is the JSON path to the field you want to retrieve. Please refer to XPath for more details on how to set the Json path. The method returns a string that represents the value of the specified JSON field.

Example (Access Fields of a Task)

office365task.GetTaskField(0, "/json/title"); // The title of the task

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

Interrupt Method (Office365Tasks Class)

Interrupt the current method.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Interrupt();

Unicode (Windows)
INT Interrupt();

int cloudcalendars_office365tasks_interrupt(void* lpObj);

int Interrupt();

Remarks

If there is no method in progress, Interrupt simply returns, doing nothing.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ListAttachments Method (Office365Tasks Class)

Lists all of a task's attachments.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ListAttachments(const char* lpszTaskListId, const char* lpszTaskId);

Unicode (Windows)
INT ListAttachments(LPCWSTR lpszTaskListId, LPCWSTR lpszTaskId);

int cloudcalendars_office365tasks_listattachments(void* lpObj, const char* lpszTaskListId, const char* lpszTaskId);

int ListAttachments(const QString& qsTaskListId, const QString& qsTaskId);

Remarks

This method lists all of a task's attachments. This method clears and populates the Attachments properties. For each attachment retrieved, the AttachmentList event is fired.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ListCheckListItems Method (Office365Tasks Class)

Lists the subtasks.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ListCheckListItems(const char* lpszTaskListId, const char* lpszTaskId);

Unicode (Windows)
INT ListCheckListItems(LPCWSTR lpszTaskListId, LPCWSTR lpszTaskId);

int cloudcalendars_office365tasks_listchecklistitems(void* lpObj, const char* lpszTaskListId, const char* lpszTaskId);

int ListCheckListItems(const QString& qsTaskListId, const QString& qsTaskId);

Remarks

Retrieves a list of subtasks from the specified Task, identified by the taskListId and the taskId parameters. The retrieved subtasks are added to the CheckListItems collection. For each subtask retrieved, the CheckListItemList event is fired.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ListTaskLists Method (Office365Tasks Class)

Lists the task lists.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ListTaskLists();

Unicode (Windows)
INT ListTaskLists();

int cloudcalendars_office365tasks_listtasklists(void* lpObj);

int ListTaskLists();

Remarks

List all Task lists associated with the current user. The retrieved Task lists are added to the TaskLists collection. For each Task list retrieved, the TaskListList event is fired.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ListTasks Method (Office365Tasks Class)

Lists the tasks.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ListTasks(const char* lpszTaskListId);

Unicode (Windows)
INT ListTasks(LPCWSTR lpszTaskListId);

int cloudcalendars_office365tasks_listtasks(void* lpObj, const char* lpszTaskListId);

int ListTasks(const QString& qsTaskListId);

Remarks

Retrieves a list of tasks from the specified Task list, identified by the taskListId parameter. The retrieved Task lists are added to the Tasks collection. For each Task list retrieved, the TaskList event is fired.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Reset Method (Office365Tasks Class)

This method will reset the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int cloudcalendars_office365tasks_reset(void* lpObj);

int Reset();

Remarks

This method will reset the class's properties to their default values.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

RetrieveAttachment Method (Office365Tasks Class)

Retrieves a task's attachment.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int RetrieveAttachment(const char* lpszTaskListId, const char* lpszTaskId, const char* lpszId);

Unicode (Windows)
INT RetrieveAttachment(LPCWSTR lpszTaskListId, LPCWSTR lpszTaskId, LPCWSTR lpszId);

int cloudcalendars_office365tasks_retrieveattachment(void* lpObj, const char* lpszTaskListId, const char* lpszTaskId, const char* lpszId);

int RetrieveAttachment(const QString& qsTaskListId, const QString& qsTaskId, const QString& qsId);

Remarks

This method retrieves an attachment. id specifies the task ID for the task the attachment is attached to. The content data returns in this case

The fetched attachment can be accessed through the Attachment* properties.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

SendCustomRequest Method (Office365Tasks Class)

Send a custom HTTP request.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SendCustomRequest(const char* lpszHTTPMethod, const char* lpszURL, const char* lpszPostData);

Unicode (Windows)
INT SendCustomRequest(LPCWSTR lpszHTTPMethod, LPCWSTR lpszURL, LPCWSTR lpszPostData);

int cloudcalendars_office365tasks_sendcustomrequest(void* lpObj, const char* lpszHTTPMethod, const char* lpszURL, const char* lpszPostData);

int SendCustomRequest(const QString& qsHTTPMethod, const QString& qsURL, const QString& qsPostData);

Remarks

This method can be used to send a custom HTTP request to the server.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

SetAttachmentInStream Method (Office365Tasks Class)

Sets an attachment using a stream.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SetAttachmentInStream(int iIndex, CloudCalendarsStream* sInputStream);

Unicode (Windows)
INT SetAttachmentInStream(INT iIndex, CloudCalendarsStream* sInputStream);

int cloudcalendars_office365tasks_setattachmentinstream(void* lpObj, int iIndex, CloudCalendarsStream* sInputStream);

int SetAttachmentInStream(int iIndex, CloudCalendarsStream* sInputStream);

Remarks

This method allows for setting an attachment in the Attachments collection through a stream using the InputStream parameter. The Index parameter specifies which attachment in the Attachments collection the stream will affect.

Note: When multiple attachment sources are provided, the component prioritizes the input stream first, followed by the file path and finally the raw data.

Example (Adding an attachment from stream): office365task.Attachments.Add(new OTAttachment("fileName.txt")); office365task.SetAttachmentInStream(0, new FileStream("C:\fileName.txt", FileMode.Open));

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

SetTaskField Method (Office365Tasks Class)

Sets the task field value by JSONPath.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SetTaskField(int iindex, const char* lpszJsonPath, const char* lpszValue, int iValueType);

Unicode (Windows)
INT SetTaskField(INT iindex, LPCWSTR lpszJsonPath, LPCWSTR lpszValue, INT iValueType);

int cloudcalendars_office365tasks_settaskfield(void* lpObj, int iindex, const char* lpszJsonPath, const char* lpszValue, int iValueType);

int SetTaskField(int iindex, const QString& qsJsonPath, const QString& qsValue, int iValueType);

Remarks

This method updates a specific field within the event's JSON representation. The parameters for this method are as follows: the first parameter, index, represents the index of the event in the Tasks collection to be edited. The second parameter, JsonPath, specifies the JSON path to the field you want to set. Please refer to XPath for more details on how to set the Json path. The third parameter, Value, is the value to be assigned to the JSON field. The fourth parameter, ValueType, is the type of the value, which must be one of the defined types:

• 0 (Object)
• 1 (Array)
• 2 (String)
• 3 (Number)
• 4 (Bool)
• 5 (Null)
• 6 (Raw)

Example (Set/Edit Fields of a Task before Updating): // Create a task office365task.CreateTask("task name", taskListId); office365task.SetTaskField(0, "/json/body", "Task body", 2); // Update notes field office365task.SetTaskField(0, "/json/title", "new task name", 2); // Update title field // Update task office365task.UpdateTask(0);

For a full list of the fields a task has/can have, please refer to the official documentation of the Microsoft Graph API documentation.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

UpdateCheckListItem Method (Office365Tasks Class)

Updates a subtask.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int UpdateCheckListItem(int iindex);

Unicode (Windows)
INT UpdateCheckListItem(INT iindex);

int cloudcalendars_office365tasks_updatechecklistitem(void* lpObj, int iindex);

int UpdateCheckListItem(int iindex);

Remarks

This method allows you to update an existing subtask. The index parameter specifies the position of the task in the CheckListItems collection. The method uses this index to take all the data from the specified subtask and update the corresponding subtask on the server.

To update a subtask, edit the desired task fields within the CheckListItems collection. Then, call the UpdateCheckListItem method with the index of the subtask. Note that changing the JSON data will overwrite the entire subtask, ignoring other field edits made before setting the JSON.

The OTCheckListItem type used in the CheckListItems collection includes the fields of a subtask. Refer to the OTCheckListItem type for a complete list of fields.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

UpdateTask Method (Office365Tasks Class)

Updates a task.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int UpdateTask(int iindex);

Unicode (Windows)
INT UpdateTask(INT iindex);

int cloudcalendars_office365tasks_updatetask(void* lpObj, int iindex);

int UpdateTask(int iindex);

Remarks

This method allows you to update an existing task. The index parameter specifies the position of the task in the Tasks collection. The method uses this index to take all the data from the specified task and update the corresponding task on the server.

To update a task, edit the desired task fields within the Tasks collection. Then, call the UpdateTask method with the index of the task. Note that changing the JSON data will overwrite the entire task, ignoring other field edits made before setting the JSON.

The OTTaskItem type used in the Tasks collection includes the fields of a task. Refer to the OTTaskItem type for a complete list of fields. If you need to add other fields, you can use the SetTaskField method. For a complete list of fields a task can have, please refer to the Microsoft Graph API overview

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

UpdateTaskList Method (Office365Tasks Class)

Updates a task list.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int UpdateTaskList(int iindex);

Unicode (Windows)
INT UpdateTaskList(INT iindex);

int cloudcalendars_office365tasks_updatetasklist(void* lpObj, int iindex);

int UpdateTaskList(int iindex);

Remarks

This method allows you to update an existing task list. The index parameter specifies the position of the task list in the TaskLists collection. The method uses this index to take all the data from the specified task list and update the corresponding task list on the server.

To update a task list, edit the desired task list fields within the TaskLists collection. Then, call the UpdateTaskList method with the index of the task list. Note that changing the JSON data will overwrite the entire task list, ignoring other field edits made before setting the JSON.

The OTTaskList type used in the TaskLists collection includes the fields of a task list. Refer to the OTTaskList type for a complete list of fields.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

AttachmentList Event (Office365Tasks Class)

Fired when an attachment is retrieved from the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireAttachmentList(Office365TasksAttachmentListEventParams *e);

typedef struct {
  const char *Id;
  const char *Name;
  const char *ContentType;
  const char *LastModifiedDateTime;
  int Size;
  int reserved;
} Office365TasksAttachmentListEventParams;


Unicode (Windows)
virtual INT FireAttachmentList(Office365TasksAttachmentListEventParams *e);

typedef struct {
  LPCWSTR Id;
  LPCWSTR Name;
  LPCWSTR ContentType;
  LPCWSTR LastModifiedDateTime;
  INT Size;
  INT reserved;
} Office365TasksAttachmentListEventParams;

#define EID_OFFICE365TASKS_ATTACHMENTLIST 1

virtual INT CLOUDCALENDARS_CALL FireAttachmentList(LPSTR &lpszId, LPSTR &lpszName, LPSTR &lpszContentType, LPSTR &lpszLastModifiedDateTime, INT &iSize);

class Office365TasksAttachmentListEventParams {
public:
  const QString &Id();

  const QString &Name();

  const QString &ContentType();

  const QString &LastModifiedDateTime();

  int Size();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void AttachmentList(Office365TasksAttachmentListEventParams *e);

// Or, subclass Office365Tasks and override this emitter function.
virtual int FireAttachmentList(Office365TasksAttachmentListEventParams *e) {...}

Remarks

The AttachmentList event is fired for each attachment retrieved from the server when ListAttachments is called. This event provides the attachment's Id, Name, ContentType, LastModifiedDateTime and Size.

CheckListItemList Event (Office365Tasks Class)

Fired when a subtask is retrieved from the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireCheckListItemList(Office365TasksCheckListItemListEventParams *e);

typedef struct {
  const char *Id;
  const char *TaskId;
  const char *TaskListId;
  const char *Subject;
  int reserved;
} Office365TasksCheckListItemListEventParams;


Unicode (Windows)
virtual INT FireCheckListItemList(Office365TasksCheckListItemListEventParams *e);

typedef struct {
  LPCWSTR Id;
  LPCWSTR TaskId;
  LPCWSTR TaskListId;
  LPCWSTR Subject;
  INT reserved;
} Office365TasksCheckListItemListEventParams;

#define EID_OFFICE365TASKS_CHECKLISTITEMLIST 2

virtual INT CLOUDCALENDARS_CALL FireCheckListItemList(LPSTR &lpszId, LPSTR &lpszTaskId, LPSTR &lpszTaskListId, LPSTR &lpszSubject);

class Office365TasksCheckListItemListEventParams {
public:
  const QString &Id();

  const QString &TaskId();

  const QString &TaskListId();

  const QString &Subject();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void CheckListItemList(Office365TasksCheckListItemListEventParams *e);

// Or, subclass Office365Tasks and override this emitter function.
virtual int FireCheckListItemList(Office365TasksCheckListItemListEventParams *e) {...}

Remarks

The CheckListItemList event is fired for each subtask retrieved from the server when ListCheckListItems is called. This event provides the subtask's Id, TaskId, TaskListId and Subject.

Error Event (Office365Tasks Class)

Fired when information is available about errors during data delivery.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireError(Office365TasksErrorEventParams *e);

typedef struct {
  int ErrorCode;
  const char *Description;
  int reserved;
} Office365TasksErrorEventParams;


Unicode (Windows)
virtual INT FireError(Office365TasksErrorEventParams *e);

typedef struct {
  INT ErrorCode;
  LPCWSTR Description;
  INT reserved;
} Office365TasksErrorEventParams;

#define EID_OFFICE365TASKS_ERROR 3

virtual INT CLOUDCALENDARS_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);

class Office365TasksErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Error(Office365TasksErrorEventParams *e);

// Or, subclass Office365Tasks and override this emitter function.
virtual int FireError(Office365TasksErrorEventParams *e) {...}

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

Log Event (Office365Tasks Class)

Fired once for each log message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireLog(Office365TasksLogEventParams *e);

typedef struct {
  int LogLevel;
  const char *Message;
  const char *LogType;
  int reserved;
} Office365TasksLogEventParams;


Unicode (Windows)
virtual INT FireLog(Office365TasksLogEventParams *e);

typedef struct {
  INT LogLevel;
  LPCWSTR Message;
  LPCWSTR LogType;
  INT reserved;
} Office365TasksLogEventParams;

#define EID_OFFICE365TASKS_LOG 4

virtual INT CLOUDCALENDARS_CALL FireLog(INT &iLogLevel, LPSTR &lpszMessage, LPSTR &lpszLogType);

class Office365TasksLogEventParams {
public:
  int LogLevel();

  const QString &Message();

  const QString &LogType();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Log(Office365TasksLogEventParams *e);

// Or, subclass Office365Tasks and override this emitter function.
virtual int FireLog(Office365TasksLogEventParams *e) {...}

Remarks

This event is fired once for each log message generated by the class. The verbosity is controlled by the LogLevel setting.

LogLevel indicates the level of message. Possible values are as follows:

The value 1 (Info) logs basic information, including the URL, HTTP version, and status details.

The value 2 (Verbose) logs additional information about the request and response.

The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any).

Message is the log entry.

LogType identifies the type of log entry. Possible values are as follows:

• "Info"
• "RequestHeaders"
• "ResponseHeaders"
• "RequestBody"
• "ResponseBody"
• "ProxyRequest"
• "ProxyResponse"
• "FirewallRequest"
• "FirewallResponse"

SSLServerAuthentication Event (Office365Tasks Class)

Fired after the server presents its certificate to the client.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSLServerAuthentication(Office365TasksSSLServerAuthenticationEventParams *e);

typedef struct {
  const char *CertEncoded;
  int lenCertEncoded;
  const char *CertSubject;
  const char *CertIssuer;
  const char *Status;
  int Accept;
  int reserved;
} Office365TasksSSLServerAuthenticationEventParams;


Unicode (Windows)
virtual INT FireSSLServerAuthentication(Office365TasksSSLServerAuthenticationEventParams *e);

typedef struct {
  LPCSTR CertEncoded;
  INT lenCertEncoded;
  LPCWSTR CertSubject;
  LPCWSTR CertIssuer;
  LPCWSTR Status;
  BOOL Accept;
  INT reserved;
} Office365TasksSSLServerAuthenticationEventParams;

#define EID_OFFICE365TASKS_SSLSERVERAUTHENTICATION 5

virtual INT CLOUDCALENDARS_CALL FireSSLServerAuthentication(LPSTR &lpCertEncoded, INT &lenCertEncoded, LPSTR &lpszCertSubject, LPSTR &lpszCertIssuer, LPSTR &lpszStatus, BOOL &bAccept);

class Office365TasksSSLServerAuthenticationEventParams {
public:
  const QByteArray &CertEncoded();

  const QString &CertSubject();

  const QString &CertIssuer();

  const QString &Status();

  bool Accept();
  void SetAccept(bool bAccept);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSLServerAuthentication(Office365TasksSSLServerAuthenticationEventParams *e);

// Or, subclass Office365Tasks and override this emitter function.
virtual int FireSSLServerAuthentication(Office365TasksSSLServerAuthenticationEventParams *e) {...}

Remarks

During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

SSLStatus Event (Office365Tasks Class)

Fired when secure connection progress messages are available.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSLStatus(Office365TasksSSLStatusEventParams *e);

typedef struct {
  const char *Message;
  int reserved;
} Office365TasksSSLStatusEventParams;


Unicode (Windows)
virtual INT FireSSLStatus(Office365TasksSSLStatusEventParams *e);

typedef struct {
  LPCWSTR Message;
  INT reserved;
} Office365TasksSSLStatusEventParams;

#define EID_OFFICE365TASKS_SSLSTATUS 6

virtual INT CLOUDCALENDARS_CALL FireSSLStatus(LPSTR &lpszMessage);

class Office365TasksSSLStatusEventParams {
public:
  const QString &Message();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSLStatus(Office365TasksSSLStatusEventParams *e);

// Or, subclass Office365Tasks and override this emitter function.
virtual int FireSSLStatus(Office365TasksSSLStatusEventParams *e) {...}

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

TaskList Event (Office365Tasks Class)

Fired when a task is retrieved from the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireTaskList(Office365TasksTaskListEventParams *e);

typedef struct {
  const char *Id;
  const char *TaskListId;
  const char *Subject;
  int reserved;
} Office365TasksTaskListEventParams;


Unicode (Windows)
virtual INT FireTaskList(Office365TasksTaskListEventParams *e);

typedef struct {
  LPCWSTR Id;
  LPCWSTR TaskListId;
  LPCWSTR Subject;
  INT reserved;
} Office365TasksTaskListEventParams;

#define EID_OFFICE365TASKS_TASKLIST 7

virtual INT CLOUDCALENDARS_CALL FireTaskList(LPSTR &lpszId, LPSTR &lpszTaskListId, LPSTR &lpszSubject);

class Office365TasksTaskListEventParams {
public:
  const QString &Id();

  const QString &TaskListId();

  const QString &Subject();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void TaskList(Office365TasksTaskListEventParams *e);

// Or, subclass Office365Tasks and override this emitter function.
virtual int FireTaskList(Office365TasksTaskListEventParams *e) {...}

Remarks

The TaskList event is fired for each task retrieved from the server when ListTasks is called. This event provides the task's Id, TaskListId and Subject.

TaskListList Event (Office365Tasks Class)

Fired when a task list is retrieved from the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireTaskListList(Office365TasksTaskListListEventParams *e);

typedef struct {
  const char *Id;
  const char *Name;
  int reserved;
} Office365TasksTaskListListEventParams;


Unicode (Windows)
virtual INT FireTaskListList(Office365TasksTaskListListEventParams *e);

typedef struct {
  LPCWSTR Id;
  LPCWSTR Name;
  INT reserved;
} Office365TasksTaskListListEventParams;

#define EID_OFFICE365TASKS_TASKLISTLIST 8

virtual INT CLOUDCALENDARS_CALL FireTaskListList(LPSTR &lpszId, LPSTR &lpszName);

class Office365TasksTaskListListEventParams {
public:
  const QString &Id();

  const QString &Name();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void TaskListList(Office365TasksTaskListListEventParams *e);

// Or, subclass Office365Tasks and override this emitter function.
virtual int FireTaskListList(Office365TasksTaskListListEventParams *e) {...}

Remarks

The TaskListList event is fired for each task list retrieved from the server when ListTaskLists is called. This event provides the task list's Id and Name.

Transfer Event (Office365Tasks Class)

Fired while a document transfers (delivers document).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireTransfer(Office365TasksTransferEventParams *e);

typedef struct {
  int Direction;
  int64 BytesTransferred;
  int PercentDone;
  const char *Text;
  int lenText;
  int reserved;
} Office365TasksTransferEventParams;


Unicode (Windows)
virtual INT FireTransfer(Office365TasksTransferEventParams *e);

typedef struct {
  INT Direction;
  LONG64 BytesTransferred;
  INT PercentDone;
  LPCSTR Text;
  INT lenText;
  INT reserved;
} Office365TasksTransferEventParams;

#define EID_OFFICE365TASKS_TRANSFER 9

virtual INT CLOUDCALENDARS_CALL FireTransfer(INT &iDirection, LONG64 &lBytesTransferred, INT &iPercentDone, LPSTR &lpText, INT &lenText);

class Office365TasksTransferEventParams {
public:
  int Direction();

  qint64 BytesTransferred();

  int PercentDone();

  const QByteArray &Text();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Transfer(Office365TasksTransferEventParams *e);

// Or, subclass Office365Tasks and override this emitter function.
virtual int FireTransfer(Office365TasksTransferEventParams *e) {...}

Remarks

The Text parameter contains the portion of the document text being received. It is empty if data are being posted to the server.

The BytesTransferred parameter contains the number of bytes transferred in this Direction since the beginning of the document text (excluding HTTP response headers).

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

The PercentDone parameter shows the progress of the transfer in the corresponding direction. If PercentDone can not be calculated the value will be -1.

Note: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance.

Certificate Type

This is the digital certificate being used.

Syntax

CloudCalendarsCertificate (declared in cloudcalendars.h)

Remarks

This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.

Fields

Constructors

Certificate()

Certificate(const char* lpEncoded, int lenEncoded)

Certificate(int iStoreType, const char* lpStore, int lenStore, const char* lpszStorePassword, const char* lpszSubject)

Firewall Type

The firewall the component will connect through.

Syntax

CloudCalendarsFirewall (declared in cloudcalendars.h)

Remarks

When connecting through a firewall, this type is used to specify different properties of the firewall, such as the firewall Host and the FirewallType.

Fields

Constructors

Firewall()

OAuthSettings Type

The settings to use to authenticate with the service provider.

Syntax

CloudCalendarsOAuthSettings (declared in cloudcalendars.h)

Remarks

Used to set give the class the necessary information needed to complete OAuth authentication.

Fields

Constructors

OAuthSettings()

OTAttachment Type

Holds information about an attachment.

Syntax

CloudCalendarsOTAttachment (declared in cloudcalendars.h)

Remarks

Holds information about an attachment.

Fields

Constructors

OTAttachment()

OTAttachment(const char* lpszFileName)

OTAttachment(const char* lpszName, const char* lpszFileName)

OTAttachment(const char* lpszName, CloudCalendarsStream* sInputStream)

OTCheckListItem Type

Holds information about a subtask.

Syntax

CloudCalendarsOTCheckListItem (declared in cloudcalendars.h)

Remarks

Holds information about a subtask.

Fields

Constructors

OTCheckListItem()

OTTaskItem Type

Holds information about a task.

Syntax

CloudCalendarsOTTaskItem (declared in cloudcalendars.h)

Remarks

Holds information about a task.

Fields

Constructors

OTTaskItem()

OTTaskList Type

Holds information about a task list.

Syntax

CloudCalendarsOTTaskList (declared in cloudcalendars.h)

Remarks

Holds information about a task list.

Fields

Constructors

OTTaskList()

Proxy Type

The proxy the component will connect to.

Syntax

CloudCalendarsProxy (declared in cloudcalendars.h)

Remarks

When connecting through a proxy, this type is used to specify different properties of the proxy, such as the Server and the AuthScheme.

Fields

Constructors

Proxy()

Proxy(const char* lpszServer, int iPort)

Proxy(const char* lpszServer, int iPort, const char* lpszUser, const char* lpszPassword)

CloudCalendarsList Type

Syntax

CloudCalendarsList<T> (declared in cloudcalendars.h)

Remarks

CloudCalendarsList is a generic class that is used to hold a collection of objects of type T, where T is one of the custom types supported by the Office365Tasks class.

int GetCount() {}

int SetCount(int count) {}

T* Get(int index) {}

T* Set(int index, T* value) {}

CloudCalendarsStream Type

Syntax

CloudCalendarsStream (declared in cloudcalendars.h)

Remarks

The Office365Tasks class includes one or more API members that take a stream object as a parameter. To use such API members, create a concrete class that implements the CloudCalendarsStream interface and pass the Office365Tasks class an instance of that concrete class.

When implementing the CloudCalendarsStream interface's properties and methods, they must behave as described below. If the concrete class's implementation does not behave as expected, undefined behavior may occur.

bool CanRead() { return true; }

bool CanSeek() { return true; }

bool CanWrite() { return true; }

int64 GetLength() = 0;

void Close() {}

int Flush() { return 0; }

int Read(void* buffer, int count) = 0;

int64 Seek(int64 offset, int seekOrigin) = 0;

int Write(const void* buffer, int count) = 0;

Config Settings (Office365Tasks Class)

Office365Tasks Config Settings

<firstlevel>
  <one>value</one>
  <two>
    <item>first</item>
    <item>second</item>
  </two>
  <three>value three</three>
</firstlevel>

{
  "firstlevel": {
    "one": "value",
    "two": ["first", "second"],
    "three": "value three"
  }
}

OAuth Config Settings