Office365Tasks Class

Properties   Methods   Events   Config Settings   Errors  

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

Class Name

CloudCalendars_Office365Tasks

Procedural Interface

 cloudcalendars_office365tasks_open();
 cloudcalendars_office365tasks_close($res);
 cloudcalendars_office365tasks_register_callback($res, $id, $function);
 cloudcalendars_office365tasks_get_last_error($res);
 cloudcalendars_office365tasks_get_last_error_code($res);
 cloudcalendars_office365tasks_set($res, $id, $index, $value);
 cloudcalendars_office365tasks_get($res, $id, $index);
 cloudcalendars_office365tasks_do_addattachment($res, $tasklistid, $taskid, $name, $localfile);
 cloudcalendars_office365tasks_do_authorize($res);
 cloudcalendars_office365tasks_do_config($res, $configurationstring);
 cloudcalendars_office365tasks_do_createchecklistitem($res, $subject, $tasklistid, $taskid);
 cloudcalendars_office365tasks_do_createtask($res, $subject, $tasklistid);
 cloudcalendars_office365tasks_do_createtasklist($res, $name);
 cloudcalendars_office365tasks_do_deleteattachment($res, $tasklistid, $taskid, $id);
 cloudcalendars_office365tasks_do_deletechecklistitem($res, $tasklistid, $taskid, $id);
 cloudcalendars_office365tasks_do_deletetask($res, $tasklistid, $id);
 cloudcalendars_office365tasks_do_deletetasklist($res, $id);
 cloudcalendars_office365tasks_do_getchecklistitem($res, $tasklistid, $taskid, $id);
 cloudcalendars_office365tasks_do_gettask($res, $tasklistid, $id);
 cloudcalendars_office365tasks_do_gettaskfield($res, $index, $jsonpath);
 cloudcalendars_office365tasks_do_interrupt($res);
 cloudcalendars_office365tasks_do_listattachments($res, $tasklistid, $taskid);
 cloudcalendars_office365tasks_do_listchecklistitems($res, $tasklistid, $taskid);
 cloudcalendars_office365tasks_do_listtasklists($res);
 cloudcalendars_office365tasks_do_listtasks($res, $tasklistid);
 cloudcalendars_office365tasks_do_reset($res);
 cloudcalendars_office365tasks_do_retrieveattachment($res, $tasklistid, $taskid, $id);
 cloudcalendars_office365tasks_do_sendcustomrequest($res, $httpmethod, $url, $postdata);
 cloudcalendars_office365tasks_do_settaskfield($res, $index, $jsonpath, $value, $valuetype);
 cloudcalendars_office365tasks_do_updatechecklistitem($res, $index);
 cloudcalendars_office365tasks_do_updatetask($res, $index);
 cloudcalendars_office365tasks_do_updatetasklist($res, $index);

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 OAuthClientProfile and OAuthGrantType.

The class has the following defaults:

Additionally, depending on how the application is registered (Ex. Multi-tenant) and what OAuthGrantType is selected (Ex. Client Credentials and Password), it may be required to use the tenant ID rather than "common" in the OAuthServerAuthURL and OAuthServerTokenURL properties. 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 OAuthClientProfile and OAuthGrantType 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 OAuthAccessToken property will be populated. Additionally, if a refresh token was provided the OAuthRefreshToken property 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 OAuthAccessToken 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 OAuthAccessToken. 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 OAuthGrantType property. 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 OAuthGrantType property 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 OAuthGrantType the class expects a OAuthClientId, OAuthClientSecret, OAuthServerAuthURL, and OAuthServerTokenURL 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 OAuthAuthorizationCode property, 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 OAuthRefreshToken property 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 OAuthGrantType the class expects a OAuthClientId, OAuthClientSecret, and OAuthServerTokenURL 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 OAuthGrantType the class expects a OAuthClientId, OAuthClientSecret, and OAuthServerAuthURL 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 OAuthGrantType the class requires OAuthPasswordGrantUsername, OAuthClientSecret, and OAuthServerTokenURL to be set. The OAuthClientSecret should be set to the password of the account instead of a typical secret. In some cases, the OAuthClientId 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.

AttachmentsCount Property (CloudCalendars_Office365Tasks Class)

The number of records in the Attachment arrays.

Object Oriented Interface

public function getAttachmentsCount();
public function setAttachmentsCount($value);

Procedural Interface

cloudcalendars_office365tasks_get($res, 1 );
cloudcalendars_office365tasks_set($res, 1, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• AttachmentContentType
• AttachmentData
• AttachmentFileName
• AttachmentId
• AttachmentJSON
• AttachmentLastModifiedDate
• AttachmentName
• AttachmentSize
• AttachmentTaskId
• AttachmentTaskListId

The array indices start at 0 and end at AttachmentsCount - 1.

This property is not available at design time.

Data Type

Integer

AttachmentContentType Property (CloudCalendars_Office365Tasks Class)

This property contains the content type of the attachment.

Object Oriented Interface

public function getAttachmentContentType($attachmentindex);

Procedural Interface

cloudcalendars_office365tasks_get($res, 2 , $attachmentindex);

Default Value

''

Remarks

This field contains the content type of the attachment.

The $attachmentindex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachmentsCount property.

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

Data Type

String

AttachmentData Property (CloudCalendars_Office365Tasks Class)

This property contains the raw data of the attachment.

Object Oriented Interface

public function getAttachmentData($attachmentindex);
public function setAttachmentData($attachmentindex, $value);

Procedural Interface

cloudcalendars_office365tasks_get($res, 3 , $attachmentindex);
cloudcalendars_office365tasks_set($res, 3, $value , $attachmentindex);

Default Value

''

Remarks

This field contains the raw data of the attachment. Only after calling the RetrieveAttachment method

The $attachmentindex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachmentsCount property.

This property is not available at design time.

Data Type

Binary String

AttachmentFileName Property (CloudCalendars_Office365Tasks Class)

This property contains the local file name associated with the attachment.

Object Oriented Interface

public function getAttachmentFileName($attachmentindex);
public function setAttachmentFileName($attachmentindex, $value);

Procedural Interface

cloudcalendars_office365tasks_get($res, 4 , $attachmentindex);
cloudcalendars_office365tasks_set($res, 4, $value , $attachmentindex);

Default Value

''

Remarks

This field contains the local file name associated with the attachment.

The $attachmentindex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachmentsCount property.

This property is not available at design time.

Data Type

String

AttachmentId Property (CloudCalendars_Office365Tasks Class)

This property contains the attachment identifier of the attachment.

Object Oriented Interface

public function getAttachmentId($attachmentindex);

Procedural Interface

cloudcalendars_office365tasks_get($res, 5 , $attachmentindex);

Default Value

''

Remarks

This field contains the attachment identifier of the attachment.

The $attachmentindex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachmentsCount property.

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

Data Type

String

AttachmentJSON Property (CloudCalendars_Office365Tasks Class)

A JSON representation of the attachment.

Object Oriented Interface

public function getAttachmentJSON($attachmentindex);
public function setAttachmentJSON($attachmentindex, $value);

Procedural Interface

cloudcalendars_office365tasks_get($res, 7 , $attachmentindex);
cloudcalendars_office365tasks_set($res, 7, $value , $attachmentindex);

Default Value

''

Remarks

A JSON representation of the attachment. Change this field to set raw JSON content to send on the next update. Other fields values will be ignored in this case.

The $attachmentindex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachmentsCount property.

This property is not available at design time.

Data Type

String

AttachmentLastModifiedDate Property (CloudCalendars_Office365Tasks Class)

This property contains the date and time when the attachment was last modified.

Object Oriented Interface

public function getAttachmentLastModifiedDate($attachmentindex);
public function setAttachmentLastModifiedDate($attachmentindex, $value);

Procedural Interface

cloudcalendars_office365tasks_get($res, 8 , $attachmentindex);
cloudcalendars_office365tasks_set($res, 8, $value , $attachmentindex);

Default Value

''

Remarks

This field contains the date and time when the attachment was last modified.

The $attachmentindex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachmentsCount property.

This property is not available at design time.

Data Type

String

AttachmentName Property (CloudCalendars_Office365Tasks Class)

This property contains the name of the attachment.

Object Oriented Interface

public function getAttachmentName($attachmentindex);
public function setAttachmentName($attachmentindex, $value);

Procedural Interface

cloudcalendars_office365tasks_get($res, 9 , $attachmentindex);
cloudcalendars_office365tasks_set($res, 9, $value , $attachmentindex);

Default Value

''

Remarks

This field contains the name of the attachment.

The $attachmentindex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachmentsCount property.

This property is not available at design time.

Data Type

String

AttachmentSize Property (CloudCalendars_Office365Tasks Class)

This property contains the size in bytes of the attachment.

Object Oriented Interface

public function getAttachmentSize($attachmentindex);
public function setAttachmentSize($attachmentindex, $value);

Procedural Interface

cloudcalendars_office365tasks_get($res, 10 , $attachmentindex);
cloudcalendars_office365tasks_set($res, 10, $value , $attachmentindex);

Default Value

0

Remarks

This field contains the size in bytes of the attachment.

The $attachmentindex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachmentsCount property.

This property is not available at design time.

Data Type

Integer

AttachmentTaskId Property (CloudCalendars_Office365Tasks Class)

This property contains the task identifier of the attachment.

Object Oriented Interface

public function getAttachmentTaskId($attachmentindex);

Procedural Interface

cloudcalendars_office365tasks_get($res, 11 , $attachmentindex);

Default Value

''

Remarks

This field contains the task identifier of the attachment.

The $attachmentindex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachmentsCount property.

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

Data Type

String

AttachmentTaskListId Property (CloudCalendars_Office365Tasks Class)

The ID of the task list that contains the task.

Object Oriented Interface

public function getAttachmentTaskListId($attachmentindex);

Procedural Interface

cloudcalendars_office365tasks_get($res, 12 , $attachmentindex);

Default Value

''

Remarks

The ID of the task list that contains the task.

The $attachmentindex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachmentsCount property.

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

Data Type

String

Authorization Property (CloudCalendars_Office365Tasks Class)

An OAuth Authorization String.

Object Oriented Interface

public function getAuthorization();
public function setAuthorization($value);

Procedural Interface

cloudcalendars_office365tasks_get($res, 13 );
cloudcalendars_office365tasks_set($res, 13, $value );

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

CheckListItemsCount Property (CloudCalendars_Office365Tasks Class)

The number of records in the CheckListItem arrays.

Object Oriented Interface

public function getCheckListItemsCount();
public function setCheckListItemsCount($value);

Procedural Interface

cloudcalendars_office365tasks_get($res, 14 );
cloudcalendars_office365tasks_set($res, 14, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• CheckListItemCheckedDateTime
• CheckListItemCreatedDateTime
• CheckListItemDisplayName
• CheckListItemId
• CheckListItemIsChecked
• CheckListItemTaskId
• CheckListItemTaskListId

The array indices start at 0 and end at CheckListItemsCount - 1.

This property is not available at design time.

Data Type

Integer

CheckListItemCheckedDateTime Property (CloudCalendars_Office365Tasks Class)

The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time.

Object Oriented Interface

public function getCheckListItemCheckedDateTime($checklistitemindex);

Procedural Interface

cloudcalendars_office365tasks_get($res, 15 , $checklistitemindex);

Default Value

''

Remarks

The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time.

The $checklistitemindex parameter specifies the index of the item in the array. The size of the array is controlled by the CheckListItemsCount property.

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

Data Type

String

CheckListItemCreatedDateTime Property (CloudCalendars_Office365Tasks Class)

The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time.

Object Oriented Interface

public function getCheckListItemCreatedDateTime($checklistitemindex);

Procedural Interface

cloudcalendars_office365tasks_get($res, 16 , $checklistitemindex);

Default Value

''

Remarks

The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time.

The $checklistitemindex parameter specifies the index of the item in the array. The size of the array is controlled by the CheckListItemsCount property.

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

Data Type

String

CheckListItemDisplayName Property (CloudCalendars_Office365Tasks Class)

Indicates the title of the checklistItem.

Object Oriented Interface

public function getCheckListItemDisplayName($checklistitemindex);
public function setCheckListItemDisplayName($checklistitemindex, $value);

Procedural Interface

cloudcalendars_office365tasks_get($res, 17 , $checklistitemindex);
cloudcalendars_office365tasks_set($res, 17, $value , $checklistitemindex);

Default Value

''

Remarks

Indicates the title of the checklistItem.

The $checklistitemindex parameter specifies the index of the item in the array. The size of the array is controlled by the CheckListItemsCount property.

This property is not available at design time.

Data Type

String

CheckListItemId Property (CloudCalendars_Office365Tasks Class)

The unique identifier of the task.

Object Oriented Interface

public function getCheckListItemId($checklistitemindex);

Procedural Interface

cloudcalendars_office365tasks_get($res, 18 , $checklistitemindex);

Default Value

''

Remarks

The unique identifier of the task.

The $checklistitemindex parameter specifies the index of the item in the array. The size of the array is controlled by the CheckListItemsCount property.

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

Data Type

String

CheckListItemIsChecked Property (CloudCalendars_Office365Tasks Class)

State that indicates whether the item is checked off or not.

Object Oriented Interface

public function getCheckListItemIsChecked($checklistitemindex);
public function setCheckListItemIsChecked($checklistitemindex, $value);

Procedural Interface

cloudcalendars_office365tasks_get($res, 19 , $checklistitemindex);
cloudcalendars_office365tasks_set($res, 19, $value , $checklistitemindex);

Default Value

false

Remarks

State that indicates whether the item is checked off or not.

The $checklistitemindex parameter specifies the index of the item in the array. The size of the array is controlled by the CheckListItemsCount property.

This property is not available at design time.

Data Type

Boolean

CheckListItemTaskId Property (CloudCalendars_Office365Tasks Class)

The ID of the task that contains the subtask.

Object Oriented Interface

public function getCheckListItemTaskId($checklistitemindex);

Procedural Interface

cloudcalendars_office365tasks_get($res, 20 , $checklistitemindex);

Default Value

''

Remarks

The ID of the task that contains the subtask.

The $checklistitemindex parameter specifies the index of the item in the array. The size of the array is controlled by the CheckListItemsCount property.

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

Data Type

String

CheckListItemTaskListId Property (CloudCalendars_Office365Tasks Class)

The ID of the task list that contains the task.

Object Oriented Interface

public function getCheckListItemTaskListId($checklistitemindex);

Procedural Interface

cloudcalendars_office365tasks_get($res, 21 , $checklistitemindex);

Default Value

''

Remarks

The ID of the task list that contains the task.

The $checklistitemindex parameter specifies the index of the item in the array. The size of the array is controlled by the CheckListItemsCount property.

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

Data Type

String

FirewallAutoDetect Property (CloudCalendars_Office365Tasks Class)

Whether to automatically detect and use firewall system settings, if available.

Object Oriented Interface

public function getFirewallAutoDetect();
public function setFirewallAutoDetect($value);

Procedural Interface

cloudcalendars_office365tasks_get($res, 22 );
cloudcalendars_office365tasks_set($res, 22, $value );

Default Value

false

Remarks

Whether to automatically detect and use firewall system settings, if available.

Data Type

Boolean

FirewallType Property (CloudCalendars_Office365Tasks Class)

The type of firewall to connect through.

Object Oriented Interface

public function getFirewallType();
public function setFirewallType($value);

Procedural Interface

cloudcalendars_office365tasks_get($res, 23 );
cloudcalendars_office365tasks_set($res, 23, $value );

Default Value

0

Remarks

The type of firewall to connect through. The applicable values are as follows:

Data Type

Integer

FirewallHost Property (CloudCalendars_Office365Tasks Class)

The name or IP address of the firewall (optional).

Object Oriented Interface

public function getFirewallHost();
public function setFirewallHost($value);

Procedural Interface

cloudcalendars_office365tasks_get($res, 24 );
cloudcalendars_office365tasks_set($res, 24, $value );

Default Value

''

Remarks

The name or IP address of the firewall (optional). If a FirewallHost is given, the requested connections will be authenticated through the specified firewall when connecting.

If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the class fails with an error.

Data Type

String

FirewallPassword Property (CloudCalendars_Office365Tasks Class)

A password if authentication is to be used when connecting through the firewall.

Object Oriented Interface

public function getFirewallPassword();
public function setFirewallPassword($value);

Procedural Interface

cloudcalendars_office365tasks_get($res, 25 );
cloudcalendars_office365tasks_set($res, 25, $value );

Default Value

''

Remarks

A password if authentication is to be used when connecting through the firewall. If FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

Data Type

String

FirewallPort Property (CloudCalendars_Office365Tasks Class)

The Transmission Control Protocol (TCP) port for the firewall Host .

Object Oriented Interface

public function getFirewallPort();
public function setFirewallPort($value);

Procedural Interface

cloudcalendars_office365tasks_get($res, 26 );
cloudcalendars_office365tasks_set($res, 26, $value );

Default Value

0

Remarks

The Transmission Control Protocol (TCP) port for the firewall FirewallHost. See the description of the FirewallHost property for details.

Note: This property is set automatically when FirewallType is set to a valid value. See the description of the FirewallType property for details.

Data Type

Integer

FirewallUser Property (CloudCalendars_Office365Tasks Class)

A username if authentication is to be used when connecting through a firewall.

Object Oriented Interface

public function getFirewallUser();
public function setFirewallUser($value);

Procedural Interface

cloudcalendars_office365tasks_get($res, 27 );
cloudcalendars_office365tasks_set($res, 27, $value );

Default Value

''

Remarks

A username if authentication is to be used when connecting through a firewall. If FirewallHost is specified, this property and the FirewallPassword property are used to connect and authenticate to the given Firewall. If the authentication fails, the class fails with an error.

Data Type

String

ListTasksMarker Property (CloudCalendars_Office365Tasks Class)

The page marker for listing tasks.

Object Oriented Interface

public function getListTasksMarker();
public function setListTasksMarker($value);

Procedural Interface

cloudcalendars_office365tasks_get($res, 28 );
cloudcalendars_office365tasks_set($res, 28, $value );

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

OAuthAccessToken Property (CloudCalendars_Office365Tasks Class)

The access token returned by the authorization server.

Object Oriented Interface

public function getOAuthAccessToken();
public function setOAuthAccessToken($value);

Procedural Interface

cloudcalendars_office365tasks_get($res, 29 );
cloudcalendars_office365tasks_set($res, 29, $value );

Default Value

''

Remarks

The access token returned by the authorization server. This is set when the class makes a request to the token server.

This property is not available at design time.

Data Type

String

OAuthAuthorizationCode Property (CloudCalendars_Office365Tasks Class)

The authorization code that is exchanged for an access token.

Object Oriented Interface

public function getOAuthAuthorizationCode();
public function setOAuthAuthorizationCode($value);

Procedural Interface

cloudcalendars_office365tasks_get($res, 30 );
cloudcalendars_office365tasks_set($res, 30, $value );

Default Value

''

Remarks

The authorization code that is exchanged for an access token. This is required to be set when the OAuthClientProfile property is set to the Web profile. Otherwise, this field is for information purposes only.

This property is not available at design time.

Data Type

String

OAuthAuthorizationScope Property (CloudCalendars_Office365Tasks Class)

The scope request or response parameter used during authorization.

Object Oriented Interface

public function getOAuthAuthorizationScope();
public function setOAuthAuthorizationScope($value);

Procedural Interface

cloudcalendars_office365tasks_get($res, 31 );
cloudcalendars_office365tasks_set($res, 31, $value );

Default Value

''

Remarks

The scope request or response parameter used during authorization.

This property is not available at design time.

Data Type

String

OAuthClientId Property (CloudCalendars_Office365Tasks Class)

The id of the client assigned when registering the application.

Object Oriented Interface

public function getOAuthClientId();
public function setOAuthClientId($value);

Procedural Interface

cloudcalendars_office365tasks_get($res, 32 );
cloudcalendars_office365tasks_set($res, 32, $value );

Default Value

''

Remarks

The id of the client assigned when registering the application.

This property is not available at design time.

Data Type

String

OAuthClientProfile Property (CloudCalendars_Office365Tasks Class)

The type of client that is requesting authorization.

Object Oriented Interface

public function getOAuthClientProfile();
public function setOAuthClientProfile($value);

Procedural Interface

cloudcalendars_office365tasks_get($res, 33 );
cloudcalendars_office365tasks_set($res, 33, $value );

Default Value

0

Remarks

The type of client that is requesting authorization. See the introduction section for more information. Possible values are:

This property is not available at design time.

Data Type

Integer

OAuthClientSecret Property (CloudCalendars_Office365Tasks Class)

The secret value for the client assigned when registering the application.

Object Oriented Interface

public function getOAuthClientSecret();
public function setOAuthClientSecret($value);

Procedural Interface

cloudcalendars_office365tasks_get($res, 34 );
cloudcalendars_office365tasks_set($res, 34, $value );

Default Value

''

Remarks

The secret value for the client assigned when registering the application.

This property is not available at design time.

Data Type

String

OAuthGrantType Property (CloudCalendars_Office365Tasks Class)

The OAuth grant type used to acquire an OAuth access token.

Object Oriented Interface

public function getOAuthGrantType();
public function setOAuthGrantType($value);

Procedural Interface

cloudcalendars_office365tasks_get($res, 35 );
cloudcalendars_office365tasks_set($res, 35, $value );

Default Value

0

Remarks

The OAuth grant type used to acquire an OAuth access token. See the introduction section for more information. Possible values are:

This property is not available at design time.

Data Type

Integer

OAuthRefreshToken Property (CloudCalendars_Office365Tasks Class)

Specifies the refresh token received from or sent to the authorization server.

Object Oriented Interface

public function getOAuthRefreshToken();
public function setOAuthRefreshToken($value);

Procedural Interface

cloudcalendars_office365tasks_get($res, 36 );
cloudcalendars_office365tasks_set($res, 36, $value );

Default Value

''

Remarks

Specifies the refresh token received from or sent to the authorization server. This property is set automatically if a refresh token is retrieved from the token server. If the OAuthAutomaticRefresh configuration setting is set to true, and the OAuthGrantType property is set to a grant that can use refresh tokens.

This property is not available at design time.

Data Type

String

OAuthRequestRefreshToken Property (CloudCalendars_Office365Tasks Class)

Specifies whether the class will request a refresh token during authorization.

Object Oriented Interface

public function getOAuthRequestRefreshToken();
public function setOAuthRequestRefreshToken($value);

Procedural Interface

cloudcalendars_office365tasks_get($res, 37 );
cloudcalendars_office365tasks_set($res, 37, $value );

Default Value

true

Remarks

Specifies whether the class will request a refresh token during authorization. By default, this value is True.

When True, the class will automatically add the necessary scopes or parameters to obtain a refresh token. When False, this property will have no effect. If the necessary scopes or parameters are specified manually, a refresh token can still be obtained.

Note: This property is only applicable when the OAuthGrantType property is set to cogtAuthorizationCode.

This property is not available at design time.

Data Type

Boolean

OAuthReturnURL Property (CloudCalendars_Office365Tasks Class)

The URL where the user (browser) returns after authenticating.

Object Oriented Interface

public function getOAuthReturnURL();
public function setOAuthReturnURL($value);

Procedural Interface

cloudcalendars_office365tasks_get($res, 38 );
cloudcalendars_office365tasks_set($res, 38, $value );

Default Value

''

Remarks

The URL where the user (browser) returns after authenticating. This property is mapped to the redirect_uri parameter when making a request to the authorization server. Typically, this is automatically set by the class when using the embedded web server. If the OAuthWebServerPort or OAuthWebServerHost configuration settings is set, then this property should be set to match. If using the Web client profile, this should be set to the place where the authorization code will be parsed out of the response after the user finishes authorizing.

This property is not available at design time.

Data Type

String

OAuthServerAuthURL Property (CloudCalendars_Office365Tasks Class)

The URL of the authorization server.

Object Oriented Interface

public function getOAuthServerAuthURL();
public function setOAuthServerAuthURL($value);

Procedural Interface

cloudcalendars_office365tasks_get($res, 39 );
cloudcalendars_office365tasks_set($res, 39, $value );

Default Value

''

Remarks

The URL of the authorization server.

This property is not available at design time.

Data Type

String

OAuthServerTokenURL Property (CloudCalendars_Office365Tasks Class)

The URL of the token server used to obtain the access token.

Object Oriented Interface

public function getOAuthServerTokenURL();
public function setOAuthServerTokenURL($value);

Procedural Interface

cloudcalendars_office365tasks_get($res, 40 );
cloudcalendars_office365tasks_set($res, 40, $value );

Default Value

''

Remarks

The URL of the token server used to obtain the access token.

This property is not available at design time.

Data Type

String

OAuthWebAuthURL Property (CloudCalendars_Office365Tasks Class)

The URL to which the user should be re-directed for authorization.

Object Oriented Interface

public function getOAuthWebAuthURL();

Procedural Interface

cloudcalendars_office365tasks_get($res, 41 );

Default Value

''

Remarks

The URL to which the user should be re-directed for authorization. This field is used to get the URL that the user should be redirected to when using the Web client profile. See introduction section for more information.

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

Data Type

String

ProxyAuthScheme Property (CloudCalendars_Office365Tasks Class)

The type of authorization to perform when connecting to the proxy.

Object Oriented Interface

public function getProxyAuthScheme();
public function setProxyAuthScheme($value);

Procedural Interface

cloudcalendars_office365tasks_get($res, 42 );
cloudcalendars_office365tasks_set($res, 42, $value );

Default Value

0

Remarks

The type of authorization to perform when connecting to the proxy. This is used only when the ProxyUser and ProxyPassword properties are set.

ProxyAuthScheme should be set to authNone (3) when no authentication is expected.

By default, ProxyAuthScheme is authBasic (0), and if the ProxyUser and ProxyPassword properties are set, the class will attempt basic authentication.

If ProxyAuthScheme is set to authDigest (1), digest authentication will be attempted instead.

If ProxyAuthScheme is set to authProprietary (2), then the authorization token will not be generated by the class. Look at the configuration file for the class being used to find more information about manually setting this token.

If ProxyAuthScheme is set to authNtlm (4), NTLM authentication will be used.

For security reasons, setting this property will clear the values of ProxyUser and ProxyPassword.

Data Type

Integer

ProxyAutoDetect Property (CloudCalendars_Office365Tasks Class)

Whether to automatically detect and use proxy system settings, if available.

Object Oriented Interface

public function getProxyAutoDetect();
public function setProxyAutoDetect($value);

Procedural Interface

cloudcalendars_office365tasks_get($res, 43 );
cloudcalendars_office365tasks_set($res, 43, $value );

Default Value

false

Remarks

Whether to automatically detect and use proxy system settings, if available. The default value is false.

Data Type

Boolean

ProxyPassword Property (CloudCalendars_Office365Tasks Class)

A password if authentication is to be used for the proxy.

Object Oriented Interface

public function getProxyPassword();
public function setProxyPassword($value);

Procedural Interface

cloudcalendars_office365tasks_get($res, 44 );
cloudcalendars_office365tasks_set($res, 44, $value );

Default Value

''

Remarks

A password if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

ProxyPort Property (CloudCalendars_Office365Tasks Class)

The Transmission Control Protocol (TCP) port for the proxy Server (default 80).

Object Oriented Interface

public function getProxyPort();
public function setProxyPort($value);

Procedural Interface

cloudcalendars_office365tasks_get($res, 45 );
cloudcalendars_office365tasks_set($res, 45, $value );

Default Value

80

Remarks

The Transmission Control Protocol (TCP) port for the proxy ProxyServer (default 80). See the description of the ProxyServer property for details.

Data Type

Integer

ProxyServer Property (CloudCalendars_Office365Tasks Class)

If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

Object Oriented Interface

public function getProxyServer();
public function setProxyServer($value);

Procedural Interface

cloudcalendars_office365tasks_get($res, 46 );
cloudcalendars_office365tasks_set($res, 46, $value );

Default Value

''

Remarks

If a proxy ProxyServer is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

If the ProxyServer property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the ProxyServer property is set to the corresponding address. If the search is not successful, an error is returned.

Data Type

String

ProxySSL Property (CloudCalendars_Office365Tasks Class)

When to use a Secure Sockets Layer (SSL) for the connection to the proxy.

Object Oriented Interface

public function getProxySSL();
public function setProxySSL($value);

Procedural Interface

cloudcalendars_office365tasks_get($res, 47 );
cloudcalendars_office365tasks_set($res, 47, $value );

Default Value

0

Remarks

When to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:

Data Type

Integer

ProxyUser Property (CloudCalendars_Office365Tasks Class)

A username if authentication is to be used for the proxy.

Object Oriented Interface

public function getProxyUser();
public function setProxyUser($value);

Procedural Interface

cloudcalendars_office365tasks_get($res, 48 );
cloudcalendars_office365tasks_set($res, 48, $value );

Default Value

''

Remarks

A username if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

SSLAcceptServerCertEffectiveDate Property (CloudCalendars_Office365Tasks Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLAcceptServerCertEffectiveDate();

Procedural Interface

cloudcalendars_office365tasks_get($res, 49 );

Default Value

''

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLAcceptServerCertExpirationDate Property (CloudCalendars_Office365Tasks Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLAcceptServerCertExpirationDate();

Procedural Interface

cloudcalendars_office365tasks_get($res, 50 );

Default Value

''

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLAcceptServerCertExtendedKeyUsage Property (CloudCalendars_Office365Tasks Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLAcceptServerCertExtendedKeyUsage();

Procedural Interface

cloudcalendars_office365tasks_get($res, 51 );

Default Value

''

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprint Property (CloudCalendars_Office365Tasks Class)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertFingerprint();

Procedural Interface

cloudcalendars_office365tasks_get($res, 52 );

Default Value

''

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprintSHA1 Property (CloudCalendars_Office365Tasks Class)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertFingerprintSHA1();

Procedural Interface

cloudcalendars_office365tasks_get($res, 53 );

Default Value

''

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprintSHA256 Property (CloudCalendars_Office365Tasks Class)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertFingerprintSHA256();

Procedural Interface

cloudcalendars_office365tasks_get($res, 54 );

Default Value

''

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSLAcceptServerCertIssuer Property (CloudCalendars_Office365Tasks Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertIssuer();

Procedural Interface

cloudcalendars_office365tasks_get($res, 55 );

Default Value

''

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLAcceptServerCertPrivateKey Property (CloudCalendars_Office365Tasks Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKey();

Procedural Interface

cloudcalendars_office365tasks_get($res, 56 );

Default Value

''

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSLAcceptServerCertPrivateKey may be available but not exportable. In this case, SSLAcceptServerCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLAcceptServerCertPrivateKeyAvailable Property (CloudCalendars_Office365Tasks Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKeyAvailable();

Procedural Interface

cloudcalendars_office365tasks_get($res, 57 );

Default Value

false

Remarks

Whether a SSLAcceptServerCertPrivateKey is available for the selected certificate. If SSLAcceptServerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLAcceptServerCertPrivateKeyContainer Property (CloudCalendars_Office365Tasks Class)

The name of the PrivateKey container for the certificate (if available).

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKeyContainer();

Procedural Interface

cloudcalendars_office365tasks_get($res, 58 );

Default Value

''

Remarks

The name of the SSLAcceptServerCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKey Property (CloudCalendars_Office365Tasks Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertPublicKey();

Procedural Interface

cloudcalendars_office365tasks_get($res, 59 );

Default Value

''

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKeyAlgorithm Property (CloudCalendars_Office365Tasks Class)

The textual description of the certificate's public key algorithm.

Object Oriented Interface

public function getSSLAcceptServerCertPublicKeyAlgorithm();

Procedural Interface

cloudcalendars_office365tasks_get($res, 60 );

Default Value

''

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKeyLength Property (CloudCalendars_Office365Tasks Class)

The length of the certificate's public key (in bits).

Object Oriented Interface

public function getSSLAcceptServerCertPublicKeyLength();

Procedural Interface

cloudcalendars_office365tasks_get($res, 61 );

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSLAcceptServerCertSerialNumber Property (CloudCalendars_Office365Tasks Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLAcceptServerCertSerialNumber();

Procedural Interface

cloudcalendars_office365tasks_get($res, 62 );

Default Value

''

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSLAcceptServerCertSignatureAlgorithm Property (CloudCalendars_Office365Tasks Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLAcceptServerCertSignatureAlgorithm();

Procedural Interface

cloudcalendars_office365tasks_get($res, 63 );

Default Value

''

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLAcceptServerCertStore Property (CloudCalendars_Office365Tasks Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLAcceptServerCertStore();
public function setSSLAcceptServerCertStore($value);

Procedural Interface

cloudcalendars_office365tasks_get($res, 64 );
cloudcalendars_office365tasks_set($res, 64, $value );

Default Value

'MY'

Remarks

The name of the certificate store for the client certificate.

The SSLAcceptServerCertStoreType property denotes the type of the certificate store specified by SSLAcceptServerCertStore. If the store is password-protected, specify the password in SSLAcceptServerCertStorePassword.

SSLAcceptServerCertStore is used in conjunction with the SSLAcceptServerCertSubject property to specify client certificates. If SSLAcceptServerCertStore has a value, and SSLAcceptServerCertSubject or SSLAcceptServerCertEncoded is set, a search for a certificate is initiated. Please see the SSLAcceptServerCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Binary String

SSLAcceptServerCertStorePassword Property (CloudCalendars_Office365Tasks Class)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Object Oriented Interface

public function getSSLAcceptServerCertStorePassword();
public function setSSLAcceptServerCertStorePassword($value);

Procedural Interface

cloudcalendars_office365tasks_get($res, 65 );
cloudcalendars_office365tasks_set($res, 65, $value );

Default Value

''

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

SSLAcceptServerCertStoreType Property (CloudCalendars_Office365Tasks Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLAcceptServerCertStoreType();
public function setSSLAcceptServerCertStoreType($value);

Procedural Interface

cloudcalendars_office365tasks_get($res, 66 );
cloudcalendars_office365tasks_set($res, 66, $value );

Default Value

0

Remarks

The type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

Data Type

Integer

SSLAcceptServerCertSubjectAltNames Property (CloudCalendars_Office365Tasks Class)

Comma-separated lists of alternative subject names for the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertSubjectAltNames();

Procedural Interface

cloudcalendars_office365tasks_get($res, 67 );

Default Value

''

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintMD5 Property (CloudCalendars_Office365Tasks Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintMD5();

Procedural Interface

cloudcalendars_office365tasks_get($res, 68 );

Default Value

''

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintSHA1 Property (CloudCalendars_Office365Tasks Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintSHA1();

Procedural Interface

cloudcalendars_office365tasks_get($res, 69 );

Default Value

''

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintSHA256 Property (CloudCalendars_Office365Tasks Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintSHA256();

Procedural Interface

cloudcalendars_office365tasks_get($res, 70 );

Default Value

''

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLAcceptServerCertUsage Property (CloudCalendars_Office365Tasks Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLAcceptServerCertUsage();

Procedural Interface

cloudcalendars_office365tasks_get($res, 71 );

Default Value

''

Remarks

The text description of SSLAcceptServerCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SSLAcceptServerCertUsageFlags Property (CloudCalendars_Office365Tasks Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertUsageFlags();

Procedural Interface

cloudcalendars_office365tasks_get($res, 72 );

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLAcceptServerCertUsageFlags is a combination of the following flags:

Please see the SSLAcceptServerCertUsage property for a text representation of SSLAcceptServerCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

SSLAcceptServerCertVersion Property (CloudCalendars_Office365Tasks Class)

The certificate's version number.

Object Oriented Interface

public function getSSLAcceptServerCertVersion();

Procedural Interface

cloudcalendars_office365tasks_get($res, 73 );

Default Value

''

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSLAcceptServerCertSubject Property (CloudCalendars_Office365Tasks Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLAcceptServerCertSubject();
public function setSSLAcceptServerCertSubject($value);

Procedural Interface

cloudcalendars_office365tasks_get($res, 74 );
cloudcalendars_office365tasks_set($res, 74, $value );

Default Value

''

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

SSLAcceptServerCertEncoded Property (CloudCalendars_Office365Tasks Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLAcceptServerCertEncoded();
public function setSSLAcceptServerCertEncoded($value);

Procedural Interface

cloudcalendars_office365tasks_get($res, 75 );
cloudcalendars_office365tasks_set($res, 75, $value );

Default Value

''

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLAcceptServerCertStore and SSLAcceptServerCertSubject properties also may be used to specify a certificate.

When SSLAcceptServerCertEncoded is set, a search is initiated in the current SSLAcceptServerCertStore for the private key of the certificate. If the key is found, SSLAcceptServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLAcceptServerCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

SSLCertEffectiveDate Property (CloudCalendars_Office365Tasks Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLCertEffectiveDate();

Procedural Interface

cloudcalendars_office365tasks_get($res, 76 );

Default Value

''

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLCertExpirationDate Property (CloudCalendars_Office365Tasks Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLCertExpirationDate();

Procedural Interface

cloudcalendars_office365tasks_get($res, 77 );

Default Value

''

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLCertExtendedKeyUsage Property (CloudCalendars_Office365Tasks Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLCertExtendedKeyUsage();

Procedural Interface

cloudcalendars_office365tasks_get($res, 78 );

Default Value

''

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSLCertFingerprint Property (CloudCalendars_Office365Tasks Class)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Object Oriented Interface

public function getSSLCertFingerprint();

Procedural Interface

cloudcalendars_office365tasks_get($res, 79 );

Default Value

''

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSLCertFingerprintSHA1 Property (CloudCalendars_Office365Tasks Class)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Object Oriented Interface

public function getSSLCertFingerprintSHA1();

Procedural Interface

cloudcalendars_office365tasks_get($res, 80 );

Default Value

''

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSLCertFingerprintSHA256 Property (CloudCalendars_Office365Tasks Class)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Object Oriented Interface

public function getSSLCertFingerprintSHA256();

Procedural Interface

cloudcalendars_office365tasks_get($res, 81 );

Default Value

''

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSLCertIssuer Property (CloudCalendars_Office365Tasks Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLCertIssuer();

Procedural Interface

cloudcalendars_office365tasks_get($res, 82 );

Default Value

''

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLCertPrivateKey Property (CloudCalendars_Office365Tasks Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLCertPrivateKey();

Procedural Interface

cloudcalendars_office365tasks_get($res, 83 );

Default Value

''

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSLCertPrivateKey may be available but not exportable. In this case, SSLCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLCertPrivateKeyAvailable Property (CloudCalendars_Office365Tasks Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLCertPrivateKeyAvailable();

Procedural Interface

cloudcalendars_office365tasks_get($res, 84 );

Default Value

false

Remarks

Whether a SSLCertPrivateKey is available for the selected certificate. If SSLCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLCertPrivateKeyContainer Property (CloudCalendars_Office365Tasks Class)

The name of the PrivateKey container for the certificate (if available).

Object Oriented Interface

public function getSSLCertPrivateKeyContainer();

Procedural Interface

cloudcalendars_office365tasks_get($res, 85 );

Default Value

''

Remarks

The name of the SSLCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLCertPublicKey Property (CloudCalendars_Office365Tasks Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLCertPublicKey();

Procedural Interface

cloudcalendars_office365tasks_get($res, 86 );

Default Value

''

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSLCertPublicKeyAlgorithm Property (CloudCalendars_Office365Tasks Class)

The textual description of the certificate's public key algorithm.

Object Oriented Interface

public function getSSLCertPublicKeyAlgorithm();

Procedural Interface

cloudcalendars_office365tasks_get($res, 87 );

Default Value

''

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLCertPublicKeyLength Property (CloudCalendars_Office365Tasks Class)

The length of the certificate's public key (in bits).

Object Oriented Interface

public function getSSLCertPublicKeyLength();

Procedural Interface

cloudcalendars_office365tasks_get($res, 88 );

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSLCertSerialNumber Property (CloudCalendars_Office365Tasks Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLCertSerialNumber();

Procedural Interface

cloudcalendars_office365tasks_get($res, 89 );

Default Value

''

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSLCertSignatureAlgorithm Property (CloudCalendars_Office365Tasks Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLCertSignatureAlgorithm();

Procedural Interface

cloudcalendars_office365tasks_get($res, 90 );

Default Value

''

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLCertStore Property (CloudCalendars_Office365Tasks Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLCertStore();
public function setSSLCertStore($value);

Procedural Interface

cloudcalendars_office365tasks_get($res, 91 );
cloudcalendars_office365tasks_set($res, 91, $value );

Default Value

'MY'

Remarks

The name of the certificate store for the client certificate.

The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password-protected, specify the password in SSLCertStorePassword.

SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Binary String

SSLCertStorePassword Property (CloudCalendars_Office365Tasks Class)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Object Oriented Interface

public function getSSLCertStorePassword();
public function setSSLCertStorePassword($value);

Procedural Interface

cloudcalendars_office365tasks_get($res, 92 );
cloudcalendars_office365tasks_set($res, 92, $value );

Default Value

''

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

SSLCertStoreType Property (CloudCalendars_Office365Tasks Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLCertStoreType();
public function setSSLCertStoreType($value);

Procedural Interface

cloudcalendars_office365tasks_get($res, 93 );
cloudcalendars_office365tasks_set($res, 93, $value );

Default Value

0

Remarks

The type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

Data Type

Integer

SSLCertSubjectAltNames Property (CloudCalendars_Office365Tasks Class)

Comma-separated lists of alternative subject names for the certificate.

Object Oriented Interface

public function getSSLCertSubjectAltNames();

Procedural Interface

cloudcalendars_office365tasks_get($res, 94 );

Default Value

''

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLCertThumbprintMD5 Property (CloudCalendars_Office365Tasks Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintMD5();

Procedural Interface

cloudcalendars_office365tasks_get($res, 95 );

Default Value

''

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertThumbprintSHA1 Property (CloudCalendars_Office365Tasks Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintSHA1();

Procedural Interface

cloudcalendars_office365tasks_get($res, 96 );

Default Value

''

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertThumbprintSHA256 Property (CloudCalendars_Office365Tasks Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintSHA256();

Procedural Interface

cloudcalendars_office365tasks_get($res, 97 );

Default Value

''

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertUsage Property (CloudCalendars_Office365Tasks Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLCertUsage();

Procedural Interface

cloudcalendars_office365tasks_get($res, 98 );

Default Value

''

Remarks

The text description of SSLCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SSLCertUsageFlags Property (CloudCalendars_Office365Tasks Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLCertUsageFlags();

Procedural Interface

cloudcalendars_office365tasks_get($res, 99 );

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLCertUsageFlags is a combination of the following flags:

Please see the SSLCertUsage property for a text representation of SSLCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

SSLCertVersion Property (CloudCalendars_Office365Tasks Class)

The certificate's version number.

Object Oriented Interface

public function getSSLCertVersion();

Procedural Interface

cloudcalendars_office365tasks_get($res, 100 );

Default Value

''

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSLCertSubject Property (CloudCalendars_Office365Tasks Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLCertSubject();
public function setSSLCertSubject($value);

Procedural Interface

cloudcalendars_office365tasks_get($res, 101 );
cloudcalendars_office365tasks_set($res, 101, $value );

Default Value

''

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

SSLCertEncoded Property (CloudCalendars_Office365Tasks Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLCertEncoded();
public function setSSLCertEncoded($value);

Procedural Interface

cloudcalendars_office365tasks_get($res, 102 );
cloudcalendars_office365tasks_set($res, 102, $value );

Default Value

''

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.

When SSLCertEncoded is set, a search is initiated in the current SSLCertStore for the private key of the certificate. If the key is found, SSLCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

SSLProvider Property (CloudCalendars_Office365Tasks Class)

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

Object Oriented Interface

public function getSSLProvider();
public function setSSLProvider($value);

Procedural Interface

cloudcalendars_office365tasks_get($res, 103 );
cloudcalendars_office365tasks_set($res, 103, $value );

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

SSLServerCertEffectiveDate Property (CloudCalendars_Office365Tasks Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLServerCertEffectiveDate();

Procedural Interface

cloudcalendars_office365tasks_get($res, 104 );

Default Value

''

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLServerCertExpirationDate Property (CloudCalendars_Office365Tasks Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLServerCertExpirationDate();

Procedural Interface

cloudcalendars_office365tasks_get($res, 105 );

Default Value

''

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLServerCertExtendedKeyUsage Property (CloudCalendars_Office365Tasks Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLServerCertExtendedKeyUsage();

Procedural Interface

cloudcalendars_office365tasks_get($res, 106 );

Default Value

''

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSLServerCertFingerprint Property (CloudCalendars_Office365Tasks Class)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Object Oriented Interface

public function getSSLServerCertFingerprint();

Procedural Interface

cloudcalendars_office365tasks_get($res, 107 );

Default Value

''

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSLServerCertFingerprintSHA1 Property (CloudCalendars_Office365Tasks Class)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Object Oriented Interface

public function getSSLServerCertFingerprintSHA1();

Procedural Interface

cloudcalendars_office365tasks_get($res, 108 );

Default Value

''

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSLServerCertFingerprintSHA256 Property (CloudCalendars_Office365Tasks Class)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Object Oriented Interface

public function getSSLServerCertFingerprintSHA256();

Procedural Interface

cloudcalendars_office365tasks_get($res, 109 );

Default Value

''

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSLServerCertIssuer Property (CloudCalendars_Office365Tasks Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLServerCertIssuer();

Procedural Interface

cloudcalendars_office365tasks_get($res, 110 );

Default Value

''

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLServerCertPrivateKey Property (CloudCalendars_Office365Tasks Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLServerCertPrivateKey();

Procedural Interface

cloudcalendars_office365tasks_get($res, 111 );

Default Value

''

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSLServerCertPrivateKey may be available but not exportable. In this case, SSLServerCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLServerCertPrivateKeyAvailable Property (CloudCalendars_Office365Tasks Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLServerCertPrivateKeyAvailable();

Procedural Interface

cloudcalendars_office365tasks_get($res, 112 );

Default Value

false

Remarks

Whether a SSLServerCertPrivateKey is available for the selected certificate. If SSLServerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLServerCertPrivateKeyContainer Property (CloudCalendars_Office365Tasks Class)

The name of the PrivateKey container for the certificate (if available).

Object Oriented Interface

public function getSSLServerCertPrivateKeyContainer();

Procedural Interface

cloudcalendars_office365tasks_get($res, 113 );

Default Value

''

Remarks

The name of the SSLServerCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLServerCertPublicKey Property (CloudCalendars_Office365Tasks Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLServerCertPublicKey();

Procedural Interface

cloudcalendars_office365tasks_get($res, 114 );

Default Value

''

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSLServerCertPublicKeyAlgorithm Property (CloudCalendars_Office365Tasks Class)

The textual description of the certificate's public key algorithm.

Object Oriented Interface

public function getSSLServerCertPublicKeyAlgorithm();

Procedural Interface

cloudcalendars_office365tasks_get($res, 115 );

Default Value

''

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLServerCertPublicKeyLength Property (CloudCalendars_Office365Tasks Class)

The length of the certificate's public key (in bits).

Object Oriented Interface

public function getSSLServerCertPublicKeyLength();

Procedural Interface

cloudcalendars_office365tasks_get($res, 116 );

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSLServerCertSerialNumber Property (CloudCalendars_Office365Tasks Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLServerCertSerialNumber();

Procedural Interface

cloudcalendars_office365tasks_get($res, 117 );

Default Value

''

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSLServerCertSignatureAlgorithm Property (CloudCalendars_Office365Tasks Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLServerCertSignatureAlgorithm();

Procedural Interface

cloudcalendars_office365tasks_get($res, 118 );

Default Value

''

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLServerCertStore Property (CloudCalendars_Office365Tasks Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLServerCertStore();

Procedural Interface

cloudcalendars_office365tasks_get($res, 119 );

Default Value

'MY'

Remarks

The name of the certificate store for the client certificate.

The SSLServerCertStoreType property denotes the type of the certificate store specified by SSLServerCertStore. If the store is password-protected, specify the password in SSLServerCertStorePassword.

SSLServerCertStore is used in conjunction with the SSLServerCertSubject property to specify client certificates. If SSLServerCertStore has a value, and SSLServerCertSubject or SSLServerCertEncoded is set, a search for a certificate is initiated. Please see the SSLServerCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

This property is read-only.

Data Type

Binary String

SSLServerCertStorePassword Property (CloudCalendars_Office365Tasks Class)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Object Oriented Interface

public function getSSLServerCertStorePassword();

Procedural Interface

cloudcalendars_office365tasks_get($res, 120 );

Default Value

''

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

This property is read-only.

Data Type

String

SSLServerCertStoreType Property (CloudCalendars_Office365Tasks Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLServerCertStoreType();

Procedural Interface

cloudcalendars_office365tasks_get($res, 121 );

Default Value

0

Remarks

The type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

This property is read-only.

Data Type

Integer

SSLServerCertSubjectAltNames Property (CloudCalendars_Office365Tasks Class)

Comma-separated lists of alternative subject names for the certificate.

Object Oriented Interface

public function getSSLServerCertSubjectAltNames();

Procedural Interface

cloudcalendars_office365tasks_get($res, 122 );

Default Value

''

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLServerCertThumbprintMD5 Property (CloudCalendars_Office365Tasks Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintMD5();

Procedural Interface

cloudcalendars_office365tasks_get($res, 123 );

Default Value

''

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLServerCertThumbprintSHA1 Property (CloudCalendars_Office365Tasks Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintSHA1();

Procedural Interface

cloudcalendars_office365tasks_get($res, 124 );

Default Value

''

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLServerCertThumbprintSHA256 Property (CloudCalendars_Office365Tasks Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintSHA256();

Procedural Interface

cloudcalendars_office365tasks_get($res, 125 );

Default Value

''

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLServerCertUsage Property (CloudCalendars_Office365Tasks Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLServerCertUsage();

Procedural Interface

cloudcalendars_office365tasks_get($res, 126 );

Default Value

''

Remarks

The text description of SSLServerCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SSLServerCertUsageFlags Property (CloudCalendars_Office365Tasks Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLServerCertUsageFlags();

Procedural Interface

cloudcalendars_office365tasks_get($res, 127 );

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLServerCertUsageFlags is a combination of the following flags:

Please see the SSLServerCertUsage property for a text representation of SSLServerCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

SSLServerCertVersion Property (CloudCalendars_Office365Tasks Class)

The certificate's version number.

Object Oriented Interface

public function getSSLServerCertVersion();

Procedural Interface

cloudcalendars_office365tasks_get($res, 128 );

Default Value

''

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSLServerCertSubject Property (CloudCalendars_Office365Tasks Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLServerCertSubject();

Procedural Interface

cloudcalendars_office365tasks_get($res, 129 );

Default Value

''

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

This property is read-only.

Data Type

String

SSLServerCertEncoded Property (CloudCalendars_Office365Tasks Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLServerCertEncoded();

Procedural Interface

cloudcalendars_office365tasks_get($res, 130 );

Default Value

''

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLServerCertStore and SSLServerCertSubject properties also may be used to specify a certificate.

When SSLServerCertEncoded is set, a search is initiated in the current SSLServerCertStore for the private key of the certificate. If the key is found, SSLServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLServerCertSubject is set to an empty string.

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

Data Type

Binary String

TaskListsCount Property (CloudCalendars_Office365Tasks Class)

The number of records in the TaskList arrays.

Object Oriented Interface

public function getTaskListsCount();
public function setTaskListsCount($value);

Procedural Interface

cloudcalendars_office365tasks_get($res, 131 );
cloudcalendars_office365tasks_set($res, 131, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• TaskListDisplayName
• TaskListId
• TaskListIsDefault
• TaskListIsOwner
• TaskListIsShared

The array indices start at 0 and end at TaskListsCount - 1.

This property is not available at design time.

Data Type

Integer

TaskListDisplayName Property (CloudCalendars_Office365Tasks Class)

the name of the task list.

Object Oriented Interface

public function getTaskListDisplayName($tasklistindex);
public function setTaskListDisplayName($tasklistindex, $value);

Procedural Interface

cloudcalendars_office365tasks_get($res, 132 , $tasklistindex);
cloudcalendars_office365tasks_set($res, 132, $value , $tasklistindex);

Default Value

''

Remarks

the name of the task list

The $tasklistindex parameter specifies the index of the item in the array. The size of the array is controlled by the TaskListsCount property.

This property is not available at design time.

Data Type

String

TaskListId Property (CloudCalendars_Office365Tasks Class)

The unique identifier of the task list.

Object Oriented Interface

public function getTaskListId($tasklistindex);

Procedural Interface

cloudcalendars_office365tasks_get($res, 133 , $tasklistindex);

Default Value

''

Remarks

The unique identifier of the task list.

The $tasklistindex parameter specifies the index of the item in the array. The size of the array is controlled by the TaskListsCount property.

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

Data Type

String

TaskListIsDefault Property (CloudCalendars_Office365Tasks Class)

True if this is the default task list where new tasks are created by default, false otherwise.

Object Oriented Interface

public function getTaskListIsDefault($tasklistindex);

Procedural Interface

cloudcalendars_office365tasks_get($res, 134 , $tasklistindex);

Default Value

false

Remarks

True if this is the default task list where new tasks are created by default, false otherwise

The $tasklistindex parameter specifies the index of the item in the array. The size of the array is controlled by the TaskListsCount property.

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

Data Type

Boolean

TaskListIsOwner Property (CloudCalendars_Office365Tasks Class)

True if the user is the owner of the given task list.

Object Oriented Interface

public function getTaskListIsOwner($tasklistindex);

Procedural Interface

cloudcalendars_office365tasks_get($res, 135 , $tasklistindex);

Default Value

false

Remarks

True if the user is the owner of the given task list.

The $tasklistindex parameter specifies the index of the item in the array. The size of the array is controlled by the TaskListsCount property.

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

Data Type

Boolean

TaskListIsShared Property (CloudCalendars_Office365Tasks Class)

True if the task list is shared with other users.

Object Oriented Interface

public function getTaskListIsShared($tasklistindex);

Procedural Interface

cloudcalendars_office365tasks_get($res, 136 , $tasklistindex);

Default Value

false

Remarks

True if the task list is shared with other users.

The $tasklistindex parameter specifies the index of the item in the array. The size of the array is controlled by the TaskListsCount property.

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

Data Type

Boolean

TasksCount Property (CloudCalendars_Office365Tasks Class)

The number of records in the Task arrays.

Object Oriented Interface

public function getTasksCount();
public function setTasksCount($value);

Procedural Interface

cloudcalendars_office365tasks_get($res, 137 );
cloudcalendars_office365tasks_set($res, 137, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• TaskBody
• TaskBodyLastModifiedDateTime
• TaskCategories
• TaskCompletedDateTime
• TaskCompletedTimeZone
• TaskCreatedDateTime
• TaskDueDateTime
• TaskDueTimeZone
• TaskHasAttachments
• TaskId
• TaskImportance
• TaskIsReminderOn
• TaskJSON
• TaskLastModifiedDateTime
• TaskListDisplayName
• TaskListId
• TaskListIsDefault
• TaskListIsOwner
• TaskListIsShared
• TaskRecurDayOfMonth
• TaskRecurDaysOfWeek
• TaskRecurEndDate
• TaskRecurFirstDayOfWeek
• TaskRecurIndex
• TaskRecurInterval
• TaskRecurMonth
• TaskRecurNumberOfOccurrences
• TaskRecurRangeType
• TaskRecurStartDate
• TaskRecurTimeZone
• TaskRecurType
• TaskReminderDateTime
• TaskReminderTimeZone
• TaskStartDateTime
• TaskStartTimeZone
• TaskStatus
• TaskTaskListId
• TaskTitle

The array indices start at 0 and end at TasksCount - 1.

This property is not available at design time.

Data Type

Integer

TaskBody Property (CloudCalendars_Office365Tasks Class)

The task body that typically contains information about the task.

Object Oriented Interface

public function getTaskBody($taskindex);
public function setTaskBody($taskindex, $value);

Procedural Interface

cloudcalendars_office365tasks_get($res, 138 , $taskindex);
cloudcalendars_office365tasks_set($res, 138, $value , $taskindex);

Default Value

''

Remarks

The task body that typically contains information about the task. Note that only HTML type is supported.

The $taskindex parameter specifies the index of the item in the array. The size of the array is controlled by the TasksCount property.

This property is not available at design time.

Data Type

String

TaskBodyLastModifiedDateTime Property (CloudCalendars_Office365Tasks Class)

The date and time when the task body was last modified.

Object Oriented Interface

public function getTaskBodyLastModifiedDateTime($taskindex);

Procedural Interface

cloudcalendars_office365tasks_get($res, 139 , $taskindex);

Default Value

''

Remarks

The date and time when the task body was last modified. By default, it is in UTC. You can provide a custom time zone in the request header. The property value uses ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2020 would look like this: '2020-01-01T00:00:00Z'.

The $taskindex parameter specifies the index of the item in the array. The size of the array is controlled by the TasksCount property.

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

Data Type

String

TaskCategories Property (CloudCalendars_Office365Tasks Class)

The categories associated with the task.

Object Oriented Interface

public function getTaskCategories($taskindex);
public function setTaskCategories($taskindex, $value);

Procedural Interface

cloudcalendars_office365tasks_get($res, 140 , $taskindex);
cloudcalendars_office365tasks_set($res, 140, $value , $taskindex);

Default Value

''

Remarks

The categories associated with the task. Each category corresponds to the displayName property of an outlookCategory defined for the user.

The $taskindex parameter specifies the index of the item in the array. The size of the array is controlled by the TasksCount property.

This property is not available at design time.

Data Type

String

TaskCompletedDateTime Property (CloudCalendars_Office365Tasks Class)

The date and time the task was finished.

Object Oriented Interface

public function getTaskCompletedDateTime($taskindex);
public function setTaskCompletedDateTime($taskindex, $value);

Procedural Interface

cloudcalendars_office365tasks_get($res, 141 , $taskindex);
cloudcalendars_office365tasks_set($res, 141, $value , $taskindex);

Default Value

''

Remarks

The date and time the task was finished.

The $taskindex parameter specifies the index of the item in the array. The size of the array is controlled by the TasksCount property.

This property is not available at design time.

Data Type

String

TaskCompletedTimeZone Property (CloudCalendars_Office365Tasks Class)

The time zone of the time the task was finished.

Object Oriented Interface

public function getTaskCompletedTimeZone($taskindex);
public function setTaskCompletedTimeZone($taskindex, $value);

Procedural Interface

cloudcalendars_office365tasks_get($res, 142 , $taskindex);
cloudcalendars_office365tasks_set($res, 142, $value , $taskindex);

Default Value

''

Remarks

The time zone of the time the task was finished.

The $taskindex parameter specifies the index of the item in the array. The size of the array is controlled by the TasksCount property.

This property is not available at design time.

Data Type

String

TaskCreatedDateTime Property (CloudCalendars_Office365Tasks Class)

The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time.

Object Oriented Interface

public function getTaskCreatedDateTime($taskindex);

Procedural Interface

cloudcalendars_office365tasks_get($res, 143 , $taskindex);

Default Value

''

Remarks

The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time.

The $taskindex parameter specifies the index of the item in the array. The size of the array is controlled by the TasksCount property.

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

Data Type

String

TaskDueDateTime Property (CloudCalendars_Office365Tasks Class)

The date and time the task is to be finished.

Object Oriented Interface

public function getTaskDueDateTime($taskindex);
public function setTaskDueDateTime($taskindex, $value);

Procedural Interface

cloudcalendars_office365tasks_get($res, 144 , $taskindex);
cloudcalendars_office365tasks_set($res, 144, $value , $taskindex);

Default Value

''

Remarks

The date and time the task is to be finished.

The $taskindex parameter specifies the index of the item in the array. The size of the array is controlled by the TasksCount property.

This property is not available at design time.

Data Type

String

TaskDueTimeZone Property (CloudCalendars_Office365Tasks Class)

The time zone of the time the task is to be finished.

Object Oriented Interface

public function getTaskDueTimeZone($taskindex);
public function setTaskDueTimeZone($taskindex, $value);

Procedural Interface

cloudcalendars_office365tasks_get($res, 145 , $taskindex);
cloudcalendars_office365tasks_set($res, 145, $value , $taskindex);

Default Value

''

Remarks

The time zone of the time the task is to be finished.

The $taskindex parameter specifies the index of the item in the array. The size of the array is controlled by the TasksCount property.

This property is not available at design time.

Data Type

String

TaskHasAttachments Property (CloudCalendars_Office365Tasks Class)

Set to true if the task has attachments.

Object Oriented Interface

public function getTaskHasAttachments($taskindex);

Procedural Interface

cloudcalendars_office365tasks_get($res, 146 , $taskindex);

Default Value

false

Remarks

Set to true if the task has attachments.

The $taskindex parameter specifies the index of the item in the array. The size of the array is controlled by the TasksCount property.

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

Data Type

Boolean

TaskId Property (CloudCalendars_Office365Tasks Class)

The unique identifier of the task.

Object Oriented Interface

public function getTaskId($taskindex);

Procedural Interface

cloudcalendars_office365tasks_get($res, 147 , $taskindex);

Default Value

''

Remarks

The unique identifier of the task.

The $taskindex parameter specifies the index of the item in the array. The size of the array is controlled by the TasksCount property.

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

Data Type

String

TaskImportance Property (CloudCalendars_Office365Tasks Class)

The importance of the task.

Object Oriented Interface

public function getTaskImportance($taskindex);
public function setTaskImportance($taskindex, $value);

Procedural Interface

cloudcalendars_office365tasks_get($res, 148 , $taskindex);
cloudcalendars_office365tasks_set($res, 148, $value , $taskindex);

Default Value

0

Remarks

The importance of the task.

Possible values are:

• 0 (otiLow)
• 1 (otiNormal)
• 2 (otiHigh)

The $taskindex parameter specifies the index of the item in the array. The size of the array is controlled by the TasksCount property.

This property is not available at design time.

Data Type

Integer

TaskIsReminderOn Property (CloudCalendars_Office365Tasks Class)

Set to true if an alert is set to remind the user of the task.

Object Oriented Interface

public function getTaskIsReminderOn($taskindex);
public function setTaskIsReminderOn($taskindex, $value);

Procedural Interface

cloudcalendars_office365tasks_get($res, 149 , $taskindex);
cloudcalendars_office365tasks_set($res, 149, $value , $taskindex);

Default Value

false

Remarks

Set to true if an alert is set to remind the user of the task.

The $taskindex parameter specifies the index of the item in the array. The size of the array is controlled by the TasksCount property.

This property is not available at design time.

Data Type

Boolean

TaskJSON Property (CloudCalendars_Office365Tasks Class)

A JSON representation of the task.

Object Oriented Interface

public function getTaskJSON($taskindex);
public function setTaskJSON($taskindex, $value);

Procedural Interface

cloudcalendars_office365tasks_get($res, 150 , $taskindex);
cloudcalendars_office365tasks_set($res, 150, $value , $taskindex);

Default Value

''

Remarks

A JSON representation of the task. Change this field to set raw JSON content to send on the next update. Other fields values will be ignored in this case.

The $taskindex parameter specifies the index of the item in the array. The size of the array is controlled by the TasksCount property.

This property is not available at design time.

Data Type

String

TaskLastModifiedDateTime Property (CloudCalendars_Office365Tasks Class)

The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time.

Object Oriented Interface

public function getTaskLastModifiedDateTime($taskindex);

Procedural Interface

cloudcalendars_office365tasks_get($res, 151 , $taskindex);

Default Value

''

Remarks

The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time.

The $taskindex parameter specifies the index of the item in the array. The size of the array is controlled by the TasksCount property.

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

Data Type

String

TaskRecurDayOfMonth Property (CloudCalendars_Office365Tasks Class)

The day of the month on which the task occurs.

Object Oriented Interface

public function getTaskRecurDayOfMonth($taskindex);
public function setTaskRecurDayOfMonth($taskindex, $value);

Procedural Interface

cloudcalendars_office365tasks_get($res, 152 , $taskindex);
cloudcalendars_office365tasks_set($res, 152, $value , $taskindex);

Default Value

0

Remarks

The day of the month on which the task occurs. Required if type is absoluteMonthly or absoluteYearly.

The $taskindex parameter specifies the index of the item in the array. The size of the array is controlled by the TasksCount property.

This property is not available at design time.

Data Type

Integer

TaskRecurDaysOfWeek Property (CloudCalendars_Office365Tasks Class)

A space separated collection of the days of the week on which the task occurs.

Object Oriented Interface

public function getTaskRecurDaysOfWeek($taskindex);
public function setTaskRecurDaysOfWeek($taskindex, $value);

Procedural Interface

cloudcalendars_office365tasks_get($res, 153 , $taskindex);
cloudcalendars_office365tasks_set($res, 153, $value , $taskindex);

Default Value

''

Remarks

A space separated collection of the days of the week on which the task occurs. The possible values are: sunday, monday, tuesday, wednesday, thursday, friday, saturday. If type is relativeMonthly or relativeYearly, and daysOfWeek specifies more than one day, the task falls on the first day that satisfies the pattern. Required if type is weekly, relativeMonthly, or relativeYearly.

The $taskindex parameter specifies the index of the item in the array. The size of the array is controlled by the TasksCount property.

This property is not available at design time.

Data Type

String

TaskRecurEndDate Property (CloudCalendars_Office365Tasks Class)

The date to stop applying the recurrence pattern.

Object Oriented Interface

public function getTaskRecurEndDate($taskindex);
public function setTaskRecurEndDate($taskindex, $value);

Procedural Interface

cloudcalendars_office365tasks_get($res, 154 , $taskindex);
cloudcalendars_office365tasks_set($res, 154, $value , $taskindex);

Default Value

''

Remarks

The date to stop applying the recurrence pattern. Depending on the recurrence pattern of the task, the last occurrence of the meeting may not be this date. Required if type is endDate.

The $taskindex parameter specifies the index of the item in the array. The size of the array is controlled by the TasksCount property.

This property is not available at design time.

Data Type

String

TaskRecurFirstDayOfWeek Property (CloudCalendars_Office365Tasks Class)

The first day of the week.

Object Oriented Interface

public function getTaskRecurFirstDayOfWeek($taskindex);
public function setTaskRecurFirstDayOfWeek($taskindex, $value);

Procedural Interface

cloudcalendars_office365tasks_get($res, 155 , $taskindex);
cloudcalendars_office365tasks_set($res, 155, $value , $taskindex);

Default Value

''

Remarks

The first day of the week. The possible values are: sunday, monday, tuesday, wednesday, thursday, friday, saturday. Default is sunday. Required if type is weekly.

The $taskindex parameter specifies the index of the item in the array. The size of the array is controlled by the TasksCount property.

This property is not available at design time.

Data Type

String

TaskRecurIndex Property (CloudCalendars_Office365Tasks Class)

Specifies on which instance of the allowed days specified in daysOfWeek the task occurs, counted from the first instance in the month.

Object Oriented Interface

public function getTaskRecurIndex($taskindex);
public function setTaskRecurIndex($taskindex, $value);

Procedural Interface

cloudcalendars_office365tasks_get($res, 156 , $taskindex);
cloudcalendars_office365tasks_set($res, 156, $value , $taskindex);

Default Value

''

Remarks

Specifies on which instance of the allowed days specified in daysOfWeek the task occurs, counted from the first instance in the month. The possible values are: first, second, third, fourth, last. Default is first. Optional and used if type is relativeMonthly or relativeYearly.

The $taskindex parameter specifies the index of the item in the array. The size of the array is controlled by the TasksCount property.

This property is not available at design time.

Data Type

String

TaskRecurInterval Property (CloudCalendars_Office365Tasks Class)

The number of units between occurrences, where units can be in days, weeks, months, or years, depending on the type.

Object Oriented Interface

public function getTaskRecurInterval($taskindex);
public function setTaskRecurInterval($taskindex, $value);

Procedural Interface

cloudcalendars_office365tasks_get($res, 157 , $taskindex);
cloudcalendars_office365tasks_set($res, 157, $value , $taskindex);

Default Value

0

Remarks

The number of units between occurrences, where units can be in days, weeks, months, or years, depending on the type. Required. Set to 0 to disable recurrence.

The $taskindex parameter specifies the index of the item in the array. The size of the array is controlled by the TasksCount property.

This property is not available at design time.

Data Type

Integer

TaskRecurMonth Property (CloudCalendars_Office365Tasks Class)

The month in which the task occurs.

Object Oriented Interface

public function getTaskRecurMonth($taskindex);
public function setTaskRecurMonth($taskindex, $value);

Procedural Interface

cloudcalendars_office365tasks_get($res, 158 , $taskindex);
cloudcalendars_office365tasks_set($res, 158, $value , $taskindex);

Default Value

0

Remarks

The month in which the task occurs. This is a number from 1 to 12.

The $taskindex parameter specifies the index of the item in the array. The size of the array is controlled by the TasksCount property.

This property is not available at design time.

Data Type

Integer

TaskRecurNumberOfOccurrences Property (CloudCalendars_Office365Tasks Class)

The number of times to repeat the task.

Object Oriented Interface

public function getTaskRecurNumberOfOccurrences($taskindex);
public function setTaskRecurNumberOfOccurrences($taskindex, $value);

Procedural Interface

cloudcalendars_office365tasks_get($res, 159 , $taskindex);
cloudcalendars_office365tasks_set($res, 159, $value , $taskindex);

Default Value

0

Remarks

The number of times to repeat the task. Required and must be positive if type is numbered.

The $taskindex parameter specifies the index of the item in the array. The size of the array is controlled by the TasksCount property.

This property is not available at design time.

Data Type

Integer

TaskRecurRangeType Property (CloudCalendars_Office365Tasks Class)

The recurrence range.

Object Oriented Interface

public function getTaskRecurRangeType($taskindex);
public function setTaskRecurRangeType($taskindex, $value);

Procedural Interface

cloudcalendars_office365tasks_get($res, 160 , $taskindex);
cloudcalendars_office365tasks_set($res, 160, $value , $taskindex);

Default Value

0

Remarks

The recurrence range.

Possible values are:

• 0 (otrrtEndDate)
• 1 (otrrtNoEnd)
• 2 (otrrtNumbered)

The $taskindex parameter specifies the index of the item in the array. The size of the array is controlled by the TasksCount property.

This property is not available at design time.

Data Type

Integer

TaskRecurStartDate Property (CloudCalendars_Office365Tasks Class)

The date to start applying the recurrence pattern.

Object Oriented Interface

public function getTaskRecurStartDate($taskindex);
public function setTaskRecurStartDate($taskindex, $value);

Procedural Interface

cloudcalendars_office365tasks_get($res, 161 , $taskindex);
cloudcalendars_office365tasks_set($res, 161, $value , $taskindex);

Default Value

''

Remarks

The date to start applying the recurrence pattern. The first occurrence of the meeting may be this date or later, depending on the recurrence pattern of the task. Must be the same value as the start property of the recurring task. Required.

The $taskindex parameter specifies the index of the item in the array. The size of the array is controlled by the TasksCount property.

This property is not available at design time.

Data Type

String

TaskRecurTimeZone Property (CloudCalendars_Office365Tasks Class)

Time zone for the startDate and endDate properties.

Object Oriented Interface

public function getTaskRecurTimeZone($taskindex);
public function setTaskRecurTimeZone($taskindex, $value);

Procedural Interface

cloudcalendars_office365tasks_get($res, 162 , $taskindex);
cloudcalendars_office365tasks_set($res, 162, $value , $taskindex);

Default Value

''

Remarks

Time zone for the startDate and endDate properties. Optional. If not specified, the time zone of the event is used.

The $taskindex parameter specifies the index of the item in the array. The size of the array is controlled by the TasksCount property.

This property is not available at design time.

Data Type

String

TaskRecurType Property (CloudCalendars_Office365Tasks Class)

The recurrence pattern type Possible values are: 0 (otrtDaily) 1 (otrtWeekly) 2 (otrtAbsoluteMonthly) 3 (otrtRelativeMonthly) 4 (otrtAbsoluteYearly) 5 (otrtRelativeYearly) .

Object Oriented Interface

public function getTaskRecurType($taskindex);
public function setTaskRecurType($taskindex, $value);

Procedural Interface

cloudcalendars_office365tasks_get($res, 163 , $taskindex);
cloudcalendars_office365tasks_set($res, 163, $value , $taskindex);

Default Value

0

Remarks

The recurrence pattern type

Possible values are:

• 0 (otrtDaily)
• 1 (otrtWeekly)
• 2 (otrtAbsoluteMonthly)
• 3 (otrtRelativeMonthly)
• 4 (otrtAbsoluteYearly)
• 5 (otrtRelativeYearly)

The $taskindex parameter specifies the index of the item in the array. The size of the array is controlled by the TasksCount property.

This property is not available at design time.

Data Type

Integer

TaskReminderDateTime Property (CloudCalendars_Office365Tasks Class)

The date and time for a reminder alert of the task to occur.

Object Oriented Interface

public function getTaskReminderDateTime($taskindex);
public function setTaskReminderDateTime($taskindex, $value);

Procedural Interface

cloudcalendars_office365tasks_get($res, 164 , $taskindex);
cloudcalendars_office365tasks_set($res, 164, $value , $taskindex);

Default Value

''

Remarks

The date and time for a reminder alert of the task to occur.

The $taskindex parameter specifies the index of the item in the array. The size of the array is controlled by the TasksCount property.

This property is not available at design time.

Data Type

String

TaskReminderTimeZone Property (CloudCalendars_Office365Tasks Class)

The time zone of the time for a reminder alert of the task to occur.

Object Oriented Interface

public function getTaskReminderTimeZone($taskindex);
public function setTaskReminderTimeZone($taskindex, $value);

Procedural Interface

cloudcalendars_office365tasks_get($res, 165 , $taskindex);
cloudcalendars_office365tasks_set($res, 165, $value , $taskindex);

Default Value

''

Remarks

The time zone of the time for a reminder alert of the task to occur.

The $taskindex parameter specifies the index of the item in the array. The size of the array is controlled by the TasksCount property.

This property is not available at design time.

Data Type

String

TaskStartDateTime Property (CloudCalendars_Office365Tasks Class)

The date and time at which the task is scheduled to start.

Object Oriented Interface

public function getTaskStartDateTime($taskindex);
public function setTaskStartDateTime($taskindex, $value);

Procedural Interface

cloudcalendars_office365tasks_get($res, 166 , $taskindex);
cloudcalendars_office365tasks_set($res, 166, $value , $taskindex);

Default Value

''

Remarks

The date and time at which the task is scheduled to start.

The $taskindex parameter specifies the index of the item in the array. The size of the array is controlled by the TasksCount property.

This property is not available at design time.

Data Type

String

TaskStartTimeZone Property (CloudCalendars_Office365Tasks Class)

The time zone of the time at which the task is scheduled to start.

Object Oriented Interface

public function getTaskStartTimeZone($taskindex);
public function setTaskStartTimeZone($taskindex, $value);

Procedural Interface

cloudcalendars_office365tasks_get($res, 167 , $taskindex);
cloudcalendars_office365tasks_set($res, 167, $value , $taskindex);

Default Value

''

Remarks

The time zone of the time at which the task is scheduled to start.

The $taskindex parameter specifies the index of the item in the array. The size of the array is controlled by the TasksCount property.

This property is not available at design time.

Data Type

String

TaskStatus Property (CloudCalendars_Office365Tasks Class)

The status of the task.

Object Oriented Interface

public function getTaskStatus($taskindex);
public function setTaskStatus($taskindex, $value);

Procedural Interface

cloudcalendars_office365tasks_get($res, 168 , $taskindex);
cloudcalendars_office365tasks_set($res, 168, $value , $taskindex);

Default Value

0

Remarks

The status of the task.

Possible values are:

• 0 (otsNotStarted)
• 1 (otsInProgress)
• 2 (otsCompleted)
• 3 (otsWaitingOnOthers)
• 4 (otsDeferred)

The $taskindex parameter specifies the index of the item in the array. The size of the array is controlled by the TasksCount property.

This property is not available at design time.

Data Type

Integer

TaskTaskListId Property (CloudCalendars_Office365Tasks Class)

The ID of the task list that contains the task.

Object Oriented Interface

public function getTaskTaskListId($taskindex);

Procedural Interface

cloudcalendars_office365tasks_get($res, 169 , $taskindex);

Default Value

''

Remarks

The ID of the task list that contains the task.

The $taskindex parameter specifies the index of the item in the array. The size of the array is controlled by the TasksCount property.

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

Data Type

String

TaskTitle Property (CloudCalendars_Office365Tasks Class)

A brief description of the task.

Object Oriented Interface

public function getTaskTitle($taskindex);
public function setTaskTitle($taskindex, $value);

Procedural Interface

cloudcalendars_office365tasks_get($res, 170 , $taskindex);
cloudcalendars_office365tasks_set($res, 170, $value , $taskindex);

Default Value

''

Remarks

A brief description of the task.

The $taskindex parameter specifies the index of the item in the array. The size of the array is controlled by the TasksCount property.

This property is not available at design time.

Data Type

String

AddAttachment Method (CloudCalendars_Office365Tasks Class)

Adds a file attachment to an existing task.

Object Oriented Interface

public function doAddAttachment($tasklistid, $taskid, $name, $localfile);

Procedural Interface

cloudcalendars_office365tasks_do_addattachment($res, $tasklistid, $taskid, $name, $localfile);

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.

Authorize Method (CloudCalendars_Office365Tasks Class)

Get the authorization string required to access the protected resource.

Object Oriented Interface

public function doAuthorize();

Procedural Interface

cloudcalendars_office365tasks_do_authorize($res);

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 OAuthClientProfile property and the OAuthGrantType property. 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.

Config Method (CloudCalendars_Office365Tasks Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

cloudcalendars_office365tasks_do_config($res, $configurationstring);

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.

CreateCheckListItem Method (CloudCalendars_Office365Tasks Class)

Creates a subtask.

Object Oriented Interface

public function doCreateCheckListItem($subject, $tasklistid, $taskid);

Procedural Interface

cloudcalendars_office365tasks_do_createchecklistitem($res, $subject, $tasklistid, $taskid);

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.

CreateTask Method (CloudCalendars_Office365Tasks Class)

Creates a task.

Object Oriented Interface

public function doCreateTask($subject, $tasklistid);

Procedural Interface

cloudcalendars_office365tasks_do_createtask($res, $subject, $tasklistid);

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.

CreateTaskList Method (CloudCalendars_Office365Tasks Class)

Creates a new task list.

Object Oriented Interface

public function doCreateTaskList($name);

Procedural Interface

cloudcalendars_office365tasks_do_createtasklist($res, $name);

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.

DeleteAttachment Method (CloudCalendars_Office365Tasks Class)

Deletes an attachment.

Object Oriented Interface

public function doDeleteAttachment($tasklistid, $taskid, $id);

Procedural Interface

cloudcalendars_office365tasks_do_deleteattachment($res, $tasklistid, $taskid, $id);

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.

DeleteCheckListItem Method (CloudCalendars_Office365Tasks Class)

Deletes a subtask.

Object Oriented Interface

public function doDeleteCheckListItem($tasklistid, $taskid, $id);

Procedural Interface

cloudcalendars_office365tasks_do_deletechecklistitem($res, $tasklistid, $taskid, $id);

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

DeleteTask Method (CloudCalendars_Office365Tasks Class)

Deletes a task.

Object Oriented Interface

public function doDeleteTask($tasklistid, $id);

Procedural Interface

cloudcalendars_office365tasks_do_deletetask($res, $tasklistid, $id);

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

DeleteTaskList Method (CloudCalendars_Office365Tasks Class)

Deletes a task list.

Object Oriented Interface

public function doDeleteTaskList($id);

Procedural Interface

cloudcalendars_office365tasks_do_deletetasklist($res, $id);

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.

GetCheckListItem Method (CloudCalendars_Office365Tasks Class)

Retrieves the subtask by Id.

Object Oriented Interface

public function doGetCheckListItem($tasklistid, $taskid, $id);

Procedural Interface

cloudcalendars_office365tasks_do_getchecklistitem($res, $tasklistid, $taskid, $id);

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

GetTask Method (CloudCalendars_Office365Tasks Class)

Retrieves the task by Id.

Object Oriented Interface

public function doGetTask($tasklistid, $id);

Procedural Interface

cloudcalendars_office365tasks_do_gettask($res, $tasklistid, $id);

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

GetTaskField Method (CloudCalendars_Office365Tasks Class)

Retrieves the task property value by JSONPath.

Object Oriented Interface

public function doGetTaskField($index, $jsonpath);

Procedural Interface

cloudcalendars_office365tasks_do_gettaskfield($res, $index, $jsonpath);

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

Interrupt Method (CloudCalendars_Office365Tasks Class)

Interrupt the current method.

Object Oriented Interface

public function doInterrupt();

Procedural Interface

cloudcalendars_office365tasks_do_interrupt($res);

Remarks

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

ListAttachments Method (CloudCalendars_Office365Tasks Class)

Lists all of a task's attachments.

Object Oriented Interface

public function doListAttachments($tasklistid, $taskid);

Procedural Interface

cloudcalendars_office365tasks_do_listattachments($res, $tasklistid, $taskid);

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.

ListCheckListItems Method (CloudCalendars_Office365Tasks Class)

Lists the subtasks.

Object Oriented Interface

public function doListCheckListItems($tasklistid, $taskid);

Procedural Interface

cloudcalendars_office365tasks_do_listchecklistitems($res, $tasklistid, $taskid);

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.

ListTaskLists Method (CloudCalendars_Office365Tasks Class)

Lists the task lists.

Object Oriented Interface

public function doListTaskLists();

Procedural Interface

cloudcalendars_office365tasks_do_listtasklists($res);

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.

ListTasks Method (CloudCalendars_Office365Tasks Class)

Lists the tasks.

Object Oriented Interface

public function doListTasks($tasklistid);

Procedural Interface

cloudcalendars_office365tasks_do_listtasks($res, $tasklistid);

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.

Reset Method (CloudCalendars_Office365Tasks Class)

This method will reset the class.

Object Oriented Interface

public function doReset();

Procedural Interface

cloudcalendars_office365tasks_do_reset($res);

Remarks

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

RetrieveAttachment Method (CloudCalendars_Office365Tasks Class)

Retrieves a task's attachment.

Object Oriented Interface

public function doRetrieveAttachment($tasklistid, $taskid, $id);

Procedural Interface

cloudcalendars_office365tasks_do_retrieveattachment($res, $tasklistid, $taskid, $id);

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.

SendCustomRequest Method (CloudCalendars_Office365Tasks Class)

Send a custom HTTP request.

Object Oriented Interface

public function doSendCustomRequest($httpmethod, $url, $postdata);

Procedural Interface

cloudcalendars_office365tasks_do_sendcustomrequest($res, $httpmethod, $url, $postdata);

Remarks

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

SetTaskField Method (CloudCalendars_Office365Tasks Class)

Sets the task field value by JSONPath.

Object Oriented Interface

public function doSetTaskField($index, $jsonpath, $value, $valuetype);

Procedural Interface

cloudcalendars_office365tasks_do_settaskfield($res, $index, $jsonpath, $value, $valuetype);

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.

UpdateCheckListItem Method (CloudCalendars_Office365Tasks Class)

Updates a subtask.

Object Oriented Interface

public function doUpdateCheckListItem($index);

Procedural Interface

cloudcalendars_office365tasks_do_updatechecklistitem($res, $index);

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.

UpdateTask Method (CloudCalendars_Office365Tasks Class)

Updates a task.

Object Oriented Interface

public function doUpdateTask($index);

Procedural Interface

cloudcalendars_office365tasks_do_updatetask($res, $index);

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

UpdateTaskList Method (CloudCalendars_Office365Tasks Class)

Updates a task list.

Object Oriented Interface

public function doUpdateTaskList($index);

Procedural Interface

cloudcalendars_office365tasks_do_updatetasklist($res, $index);

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.

AttachmentList Event (CloudCalendars_Office365Tasks Class)

Fired when an attachment is retrieved from the server.

Object Oriented Interface

public function fireAttachmentList($param);

Procedural Interface

cloudcalendars_office365tasks_register_callback($res, 1, array($this, 'fireAttachmentList'));

Parameter List

 'id'
 'name'
 'contenttype'
 'lastmodifieddatetime'
 'size'

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 (CloudCalendars_Office365Tasks Class)

Fired when a subtask is retrieved from the server.

Object Oriented Interface

public function fireCheckListItemList($param);

Procedural Interface

cloudcalendars_office365tasks_register_callback($res, 2, array($this, 'fireCheckListItemList'));

Parameter List

 'id'
 'taskid'
 'tasklistid'
 'subject'

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 (CloudCalendars_Office365Tasks Class)

Fired when information is available about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

cloudcalendars_office365tasks_register_callback($res, 3, array($this, 'fireError'));

Parameter List

 'errorcode'
 'description'

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 (CloudCalendars_Office365Tasks Class)

Fired once for each log message.

Object Oriented Interface

public function fireLog($param);

Procedural Interface

cloudcalendars_office365tasks_register_callback($res, 4, array($this, 'fireLog'));

Parameter List

 'loglevel'
 'message'
 'logtype'

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 (CloudCalendars_Office365Tasks Class)

Fired after the server presents its certificate to the client.

Object Oriented Interface

public function fireSSLServerAuthentication($param);

Procedural Interface

cloudcalendars_office365tasks_register_callback($res, 5, array($this, 'fireSSLServerAuthentication'));

Parameter List

 'certencoded'
 'certsubject'
 'certissuer'
 'status'
 'accept'

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 (CloudCalendars_Office365Tasks Class)

Fired when secure connection progress messages are available.

Object Oriented Interface

public function fireSSLStatus($param);

Procedural Interface

cloudcalendars_office365tasks_register_callback($res, 6, array($this, 'fireSSLStatus'));

Parameter List

 'message'

Remarks

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

TaskList Event (CloudCalendars_Office365Tasks Class)

Fired when a task is retrieved from the server.

Object Oriented Interface

public function fireTaskList($param);

Procedural Interface

cloudcalendars_office365tasks_register_callback($res, 7, array($this, 'fireTaskList'));

Parameter List

 'id'
 'tasklistid'
 'subject'

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 (CloudCalendars_Office365Tasks Class)

Fired when a task list is retrieved from the server.

Object Oriented Interface

public function fireTaskListList($param);

Procedural Interface

cloudcalendars_office365tasks_register_callback($res, 8, array($this, 'fireTaskListList'));

Parameter List

 'id'
 'name'

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 (CloudCalendars_Office365Tasks Class)

Fired while a document transfers (delivers document).

Object Oriented Interface

public function fireTransfer($param);

Procedural Interface

cloudcalendars_office365tasks_register_callback($res, 9, array($this, 'fireTransfer'));

Parameter List

 'direction'
 'bytestransferred'
 'percentdone'
 'text'

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.

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

HTTP Config Settings