Office365Tasks Component
Properties Methods Events Config Settings Errors
The Office365Tasks component provides an easy way to manage todo tasks in Microsoft 365.
Syntax
TccOffice365Tasks
Remarks
This component provides an easy to use interface for Office365 using the Microsoft Graph API v1.0. To use the component, first set the Authorization property to a valid OAuth token. The Office365Tasks component 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 component 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 component has the following defaults:
Authorization Server URL | "https://login.microsoftonline.com/common/oauth2/v2.0/authorize" |
Token Server URL | "https://login.microsoftonline.com/common/oauth2/v2.0/token" |
Scopes | "offline_access mail.readwrite mail.send user.read" |
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:
Authorization Server URL | "https://login.microsoftonline.com/{TENANT_ID}/oauth2/v2.0/authorize" |
Token Server URL | "https://login.microsoftonline.com/{TENANT_ID}/oauth2/v2.0/token" |
Scopes | "https://graph.microsoft.com/.default" |
Below is a brief description of the different OAuthClientProfile and OAuthGrantType values that are supported by this component. 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 component. 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 component 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 component 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 component 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 component will use an authorization code to get an access token. For this OAuthGrantType the component 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 component will parse the authorization code, setting the OAuthAuthorizationCode property, from the redirect. Immediately, the component 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 component 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 component will act as a service instead of authorizing and authenticating as a user. This allows for the component 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 component 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 component will request the authorization server to get an access token. For this OAuthGrantType the component 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 component 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 component 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 component will authenticate as the resource owner. This allows for the component 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 component 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
This profile is similar to setting the component to the Application profile and Authorization Code grant type except the component will not launch the browser. It is typically used in situations where there is a back-end that is supporting some front end. This profile expects that OAuthClientId, OAuthClientSecret, OAuthServerAuthURL, OAuthServerTokenURL, and the OAuthReturnURL properties to be set. Before calling the Authorize method, the OAuthWebAuthURL property should be queried to get a URL. This URL should be used to redirect the user to the authorization page for the service provider. The redirect_uri parameter of this URL is mapped to the OAuthReturnURL property. The OAuthReturnURL property should be set to some web server that will parse the authorization code out of the query parameter from the redirect. Once the authorization code is parsed, it should be passed back to the server where it is then set to the OAuthAuthorizationCode property. Once that is set, the Authorize method can be called to exchange the authorization code for an access token and refresh token if provided. The component will then cache these values like normal and use them to make requests. If the OAuthRefreshToken field is set, or a refresh token is cached, then the Authorize method can immediately be called to make a request to the token server to get a new access token.
External OAuth Support
For complex profiles or grant types, or for more control of the flow, it is possible to perform OAuth authentication using the OAuth component or a separate process. Once complete you should have an authorization string which looks like:Bearer ACCESS_TOKEN_VALUE
Assign this value to the Authorization property before attempting any operations. Setting the Authorization property will cause the component 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 component with short descriptions. Click on the links for further details.
AttachmentsCount | The number of records in the Attachment arrays. |
AttachmentContentType | This property contains the content type of the attachment. |
AttachmentData | This property contains the raw data of the attachment. |
AttachmentFileName | This property contains the local file name associated with the attachment. |
AttachmentId | This property contains the attachment identifier of the attachment. |
AttachmentJSON | A JSON representation of the attachment. |
AttachmentLastModifiedDate | This property contains the date and time when the attachment was last modified. |
AttachmentName | This property contains the name of the attachment. |
AttachmentSize | This property contains the size in bytes of the attachment. |
AttachmentTaskId | This property contains the task identifier of the attachment. |
AttachmentTaskListId | The ID of the task list that contains the task. |
Authorization | An OAuth Authorization String. |
CheckListItemsCount | The number of records in the CheckListItem arrays. |
CheckListItemCheckedDateTime | The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. |
CheckListItemCreatedDateTime | The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. |
CheckListItemDisplayName | Indicates the title of the checklistItem. |
CheckListItemId | The unique identifier of the task. |
CheckListItemIsChecked | State that indicates whether the item is checked off or not. |
CheckListItemTaskId | The ID of the task that contains the subtask. |
CheckListItemTaskListId | The ID of the task list that contains the task. |
FirewallAutoDetect | Whether to automatically detect and use firewall system settings, if available. |
FirewallType | The type of firewall to connect through. |
FirewallHost | The name or IP address of the firewall (optional). |
FirewallPassword | A password if authentication is to be used when connecting through the firewall. |
FirewallPort | The Transmission Control Protocol (TCP) port for the firewall Host . |
FirewallUser | A username if authentication is to be used when connecting through a firewall. |
ListTasksMarker | The page marker for listing tasks. |
OAuthAccessToken | The access token returned by the authorization server. |
OAuthAuthorizationCode | The authorization code that is exchanged for an access token. |
OAuthAuthorizationScope | The scope request or response parameter used during authorization. |
OAuthClientId | The id of the client assigned when registering the application. |
OAuthClientProfile | The type of client that is requesting authorization. |
OAuthClientSecret | The secret value for the client assigned when registering the application. |
OAuthGrantType | The OAuth grant type used to acquire an OAuth access token. |
OAuthRefreshToken | Specifies the refresh token received from or sent to the authorization server. |
OAuthRequestRefreshToken | Specifies whether the component will request a refresh token during authorization. |
OAuthReturnURL | The URL where the user (browser) returns after authenticating. |
OAuthServerAuthURL | The URL of the authorization server. |
OAuthServerTokenURL | The URL of the token server used to obtain the access token. |
OAuthWebAuthURL | The URL to which the user should be re-directed for authorization. |
ProxyAuthScheme | The type of authorization to perform when connecting to the proxy. |
ProxyAutoDetect | Whether to automatically detect and use proxy system settings, if available. |
ProxyPassword | A password if authentication is to be used for the proxy. |
ProxyPort | The Transmission Control Protocol (TCP) port for the proxy Server (default 80). |
ProxyServer | If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified. |
ProxySSL | When to use a Secure Sockets Layer (SSL) for the connection to the proxy. |
ProxyUser | A username if authentication is to be used for the proxy. |
SSLAcceptServerCertEffectiveDate | The date on which this certificate becomes valid. |
SSLAcceptServerCertExpirationDate | The date on which the certificate expires. |
SSLAcceptServerCertExtendedKeyUsage | A comma-delimited list of extended key usage identifiers. |
SSLAcceptServerCertFingerprint | The hex-encoded, 16-byte MD5 fingerprint of the certificate. |
SSLAcceptServerCertFingerprintSHA1 | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
SSLAcceptServerCertFingerprintSHA256 | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
SSLAcceptServerCertIssuer | The issuer of the certificate. |
SSLAcceptServerCertPrivateKey | The private key of the certificate (if available). |
SSLAcceptServerCertPrivateKeyAvailable | Whether a PrivateKey is available for the selected certificate. |
SSLAcceptServerCertPrivateKeyContainer | The name of the PrivateKey container for the certificate (if available). |
SSLAcceptServerCertPublicKey | The public key of the certificate. |
SSLAcceptServerCertPublicKeyAlgorithm | The textual description of the certificate's public key algorithm. |
SSLAcceptServerCertPublicKeyLength | The length of the certificate's public key (in bits). |
SSLAcceptServerCertSerialNumber | The serial number of the certificate encoded as a string. |
SSLAcceptServerCertSignatureAlgorithm | The text description of the certificate's signature algorithm. |
SSLAcceptServerCertStore | The name of the certificate store for the client certificate. |
SSLAcceptServerCertStorePassword | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
SSLAcceptServerCertStoreType | The type of certificate store for this certificate. |
SSLAcceptServerCertSubjectAltNames | Comma-separated lists of alternative subject names for the certificate. |
SSLAcceptServerCertThumbprintMD5 | The MD5 hash of the certificate. |
SSLAcceptServerCertThumbprintSHA1 | The SHA-1 hash of the certificate. |
SSLAcceptServerCertThumbprintSHA256 | The SHA-256 hash of the certificate. |
SSLAcceptServerCertUsage | The text description of UsageFlags . |
SSLAcceptServerCertUsageFlags | The flags that show intended use for the certificate. |
SSLAcceptServerCertVersion | The certificate's version number. |
SSLAcceptServerCertSubject | The subject of the certificate used for client authentication. |
SSLAcceptServerCertEncoded | The certificate (PEM/Base64 encoded). |
SSLCertEffectiveDate | The date on which this certificate becomes valid. |
SSLCertExpirationDate | The date on which the certificate expires. |
SSLCertExtendedKeyUsage | A comma-delimited list of extended key usage identifiers. |
SSLCertFingerprint | The hex-encoded, 16-byte MD5 fingerprint of the certificate. |
SSLCertFingerprintSHA1 | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
SSLCertFingerprintSHA256 | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
SSLCertIssuer | The issuer of the certificate. |
SSLCertPrivateKey | The private key of the certificate (if available). |
SSLCertPrivateKeyAvailable | Whether a PrivateKey is available for the selected certificate. |
SSLCertPrivateKeyContainer | The name of the PrivateKey container for the certificate (if available). |
SSLCertPublicKey | The public key of the certificate. |
SSLCertPublicKeyAlgorithm | The textual description of the certificate's public key algorithm. |
SSLCertPublicKeyLength | The length of the certificate's public key (in bits). |
SSLCertSerialNumber | The serial number of the certificate encoded as a string. |
SSLCertSignatureAlgorithm | The text description of the certificate's signature algorithm. |
SSLCertStore | The name of the certificate store for the client certificate. |
SSLCertStorePassword | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
SSLCertStoreType | The type of certificate store for this certificate. |
SSLCertSubjectAltNames | Comma-separated lists of alternative subject names for the certificate. |
SSLCertThumbprintMD5 | The MD5 hash of the certificate. |
SSLCertThumbprintSHA1 | The SHA-1 hash of the certificate. |
SSLCertThumbprintSHA256 | The SHA-256 hash of the certificate. |
SSLCertUsage | The text description of UsageFlags . |
SSLCertUsageFlags | The flags that show intended use for the certificate. |
SSLCertVersion | The certificate's version number. |
SSLCertSubject | The subject of the certificate used for client authentication. |
SSLCertEncoded | The certificate (PEM/Base64 encoded). |
SSLProvider | The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use. |
SSLServerCertEffectiveDate | The date on which this certificate becomes valid. |
SSLServerCertExpirationDate | The date on which the certificate expires. |
SSLServerCertExtendedKeyUsage | A comma-delimited list of extended key usage identifiers. |
SSLServerCertFingerprint | The hex-encoded, 16-byte MD5 fingerprint of the certificate. |
SSLServerCertFingerprintSHA1 | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
SSLServerCertFingerprintSHA256 | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
SSLServerCertIssuer | The issuer of the certificate. |
SSLServerCertPrivateKey | The private key of the certificate (if available). |
SSLServerCertPrivateKeyAvailable | Whether a PrivateKey is available for the selected certificate. |
SSLServerCertPrivateKeyContainer | The name of the PrivateKey container for the certificate (if available). |
SSLServerCertPublicKey | The public key of the certificate. |
SSLServerCertPublicKeyAlgorithm | The textual description of the certificate's public key algorithm. |
SSLServerCertPublicKeyLength | The length of the certificate's public key (in bits). |
SSLServerCertSerialNumber | The serial number of the certificate encoded as a string. |
SSLServerCertSignatureAlgorithm | The text description of the certificate's signature algorithm. |
SSLServerCertStore | The name of the certificate store for the client certificate. |
SSLServerCertStorePassword | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
SSLServerCertStoreType | The type of certificate store for this certificate. |
SSLServerCertSubjectAltNames | Comma-separated lists of alternative subject names for the certificate. |
SSLServerCertThumbprintMD5 | The MD5 hash of the certificate. |
SSLServerCertThumbprintSHA1 | The SHA-1 hash of the certificate. |
SSLServerCertThumbprintSHA256 | The SHA-256 hash of the certificate. |
SSLServerCertUsage | The text description of UsageFlags . |
SSLServerCertUsageFlags | The flags that show intended use for the certificate. |
SSLServerCertVersion | The certificate's version number. |
SSLServerCertSubject | The subject of the certificate used for client authentication. |
SSLServerCertEncoded | The certificate (PEM/Base64 encoded). |
TaskListsCount | The number of records in the TaskList arrays. |
TaskListDisplayName | the name of the task list. |
TaskListId | The unique identifier of the task list. |
TaskListIsDefault | True if this is the default task list where new tasks are created by default, false otherwise. |
TaskListIsOwner | True if the user is the owner of the given task list. |
TaskListIsShared | True if the task list is shared with other users. |
TasksCount | The number of records in the Task arrays. |
TaskBody | The task body that typically contains information about the task. |
TaskBodyLastModifiedDateTime | The date and time when the task body was last modified. |
TaskCategories | The categories associated with the task. |
TaskCompletedDateTime | The date and time the task was finished. |
TaskCompletedTimeZone | The time zone of the time the task was finished. |
TaskCreatedDateTime | The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. |
TaskDueDateTime | The date and time the task is to be finished. |
TaskDueTimeZone | The time zone of the time the task is to be finished. |
TaskHasAttachments | Set to true if the task has attachments. |
TaskId | The unique identifier of the task. |
TaskImportance | The importance of the task. |
TaskIsReminderOn | Set to true if an alert is set to remind the user of the task. |
TaskJSON | A JSON representation of the task. |
TaskLastModifiedDateTime | The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. |
TaskRecurDayOfMonth | The day of the month on which the task occurs. |
TaskRecurDaysOfWeek | A space separated collection of the days of the week on which the task occurs. |
TaskRecurEndDate | The date to stop applying the recurrence pattern. |
TaskRecurFirstDayOfWeek | The first day of the week. |
TaskRecurIndex | Specifies on which instance of the allowed days specified in daysOfWeek the task occurs, counted from the first instance in the month. |
TaskRecurInterval | The number of units between occurrences, where units can be in days, weeks, months, or years, depending on the type. |
TaskRecurMonth | The month in which the task occurs. |
TaskRecurNumberOfOccurrences | The number of times to repeat the task. |
TaskRecurRangeType | The recurrence range. |
TaskRecurStartDate | The date to start applying the recurrence pattern. |
TaskRecurTimeZone | Time zone for the startDate and endDate properties. |
TaskRecurType | The recurrence pattern type Possible values are: 0 (otrtDaily) 1 (otrtWeekly) 2 (otrtAbsoluteMonthly) 3 (otrtRelativeMonthly) 4 (otrtAbsoluteYearly) 5 (otrtRelativeYearly) . |
TaskReminderDateTime | The date and time for a reminder alert of the task to occur. |
TaskReminderTimeZone | The time zone of the time for a reminder alert of the task to occur. |
TaskStartDateTime | The date and time at which the task is scheduled to start. |
TaskStartTimeZone | The time zone of the time at which the task is scheduled to start. |
TaskStatus | The status of the task. |
TaskTaskListId | The ID of the task list that contains the task. |
TaskTitle | A brief description of the task. |
Method List
The following is the full list of the methods of the component with short descriptions. Click on the links for further details.
AddAttachment | Adds a file attachment to an existing task. |
Authorize | Get the authorization string required to access the protected resource. |
Config | Sets or retrieves a configuration setting. |
CreateCheckListItem | Creates a subtask. |
CreateTask | Creates a task. |
CreateTaskList | Creates a new task list. |
DeleteAttachment | Deletes an attachment. |
DeleteCheckListItem | Deletes a subtask. |
DeleteTask | Deletes a task. |
DeleteTaskList | Deletes a task list. |
GetCheckListItem | Retrieves the subtask by Id. |
GetTask | Retrieves the task by Id. |
GetTaskField | Retrieves the task property value by JSONPath. |
Interrupt | Interrupt the current method. |
ListAttachments | Lists all of a task's attachments. |
ListCheckListItems | Lists the subtasks. |
ListTaskLists | Lists the task lists. |
ListTasks | Lists the tasks. |
Reset | This method will reset the component. |
RetrieveAttachment | Retrieves a task's attachment. |
SendCustomRequest | Send a custom HTTP request. |
SetTaskField | Sets the task field value by JSONPath. |
UpdateCheckListItem | Updates a subtask. |
UpdateTask | Updates a task. |
UpdateTaskList | Updates a task list. |
Event List
The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.
AttachmentList | Fired when an attachment is retrieved from the server. |
CheckListItemList | Fired when a subtask is retrieved from the server. |
Error | Fired when information is available about errors during data delivery. |
Log | Fired once for each log message. |
SSLServerAuthentication | Fired after the server presents its certificate to the client. |
SSLStatus | Fired when secure connection progress messages are available. |
TaskList | Fired when a task is retrieved from the server. |
TaskListList | Fired when a task list is retrieved from the server. |
Transfer | Fired while a document transfers (delivers document). |
Config Settings
The following is a list of config settings for the component with short descriptions. Click on the links for further details.
AttachmentFragmentSize | Size of fragments when uploading large attachments. |
AttachmentSimpleUploadLimit | The threshold to use simple uploads. |
ListTaskListsMarker | The page marker for listing task lists. |
TaskListsPageSize | Page size limit for fetching tasks lists. |
TasksPageSize | Page size for fetching tasks. |
XChildCount | The number of child elements of the current element. |
XChildName[i] | The name of the child element. |
XChildXText[i] | The inner text of the child element. |
XElement | The name of the current element. |
XParent | The parent of the current element. |
XPath | Provides a way to point to a specific element in the returned XML or JSON response. |
XSubTree | A snapshot of the current element in the document. |
XText | The text of the current element. |
OAuthAccessTokenExpiration | The lifetime of the access token. |
OAuthAuthorizationTokenType | The type of access token returned. |
OAuthAutomaticRefresh | Whether or not to refresh an expired access token automatically. |
OAuthBrowserResponseTimeout | Specifies the amount of time to wait for a response from the browser. |
OAuthIncludeEmptyRedirectURI | Whether an empty redirect_uri parameter is included in requests. |
OAuthJWTPayload | The payload of the JWT access token if present. |
OAuthJWTXChildCount | The number of child elements of the current element. |
OauthJWTXChildName[i] | The name of the child element. |
OAuthJWTXChildXText[i] | The inner text of the child element. |
OAuthJWTXElement | The name of the current element. |
OauthJWTXParent | The parent of the current element. |
OAuthJWTXPath | Provides a way to point to a specific element in the returned payload of a JWT based access token. |
OAuthJWTXSubTree | A snapshot of the current element in the document. |
OAuthJWTXText | The text of the current element. |
OAuthParamCount | Specifies the number of additional parameters variables to include in the request. |
OAuthParamName[i] | Specifies the parameter name at the specified index. |
OAuthParamValue[i] | Specifies the parameter value at the specified index. |
OAuthPasswordGrantUsername | Used in the Resource Owner Password grant type. |
OAuthPKCEChallengeEncoding | The PKCE code challenge method to use. |
OAuthPKCEVerifier | The PKCE verifier used to generate the challenge. |
OAuthResetData | Determines if the Reset method applies to the OAuth settings. |
OAuthReUseWebServer | Determines if the same server instance is used between requests. |
OAuthTransferredRequest | The full OAuth request last sent by the client. |
OAuthUsePKCE | Specifies if PKCE should be used. |
OAuthWebServerActive | Specifies and controls whether the embedded web server is active. |
OAuthWebServerCertStore | The certificate with private key to use when SSL is enabled. |
OAuthWebServerCertStorePassword | The certificate with private key to use when SSL is enabled. |
OAuthWebServerCertStoreType | The certificate with private key to use when SSL is enabled. |
OAuthWebServerCertSubject | The certificate with private key to use when SSL is enabled. |
OAuthWebServerFailedResponse | The custom response that will be displayed to the user if authentication failed. |
OAuthWebServerHost | The hostname used by the embedded web server displayed in the ReturnURL. |
OAuthWebServerPort | The local port on which the embedded web server listens. |
OAuthWebServerResponse | The custom response that will be displayed to the user. |
OAuthWebServerSSLEnabled | Whether the web server requires SSL connections. |
AcceptEncoding | Used to tell the server which types of content encodings the client supports. |
AllowHTTPCompression | This property enables HTTP compression for receiving data. |
AllowHTTPFallback | Whether HTTP/2 connections are permitted to fallback to HTTP/1.1. |
Append | Whether to append data to LocalFile. |
Authorization | The Authorization string to be sent to the server. |
BytesTransferred | Contains the number of bytes transferred in the response data. |
ChunkSize | Specifies the chunk size in bytes when using chunked encoding. |
CompressHTTPRequest | Set to true to compress the body of a PUT or POST request. |
EncodeURL | If set to True the URL will be encoded by the component. |
FollowRedirects | Determines what happens when the server issues a redirect. |
GetOn302Redirect | If set to True the component will perform a GET on the new location. |
HTTP2HeadersWithoutIndexing | HTTP2 headers that should not update the dynamic header table with incremental indexing. |
HTTPVersion | The version of HTTP used by the component. |
IfModifiedSince | A date determining the maximum age of the desired document. |
KeepAlive | Determines whether the HTTP connection is closed after completion of the request. |
KerberosSPN | The Service Principal Name for the Kerberos Domain Controller. |
LogLevel | The level of detail that is logged. |
MaxRedirectAttempts | Limits the number of redirects that are followed in a request. |
NegotiatedHTTPVersion | The negotiated HTTP version. |
OtherHeaders | Other headers as determined by the user (optional). |
ProxyAuthorization | The authorization string to be sent to the proxy server. |
ProxyAuthScheme | The authorization scheme to be used for the proxy. |
ProxyPassword | A password if authentication is to be used for the proxy. |
ProxyPort | Port for the proxy server (default 80). |
ProxyServer | Name or IP address of a proxy server (optional). |
ProxyUser | A user name if authentication is to be used for the proxy. |
SentHeaders | The full set of headers as sent by the client. |
StatusCode | The status code of the last response from the server. |
StatusLine | The first line of the last response from the server. |
TransferredData | The contents of the last response from the server. |
TransferredDataLimit | The maximum number of incoming bytes to be stored by the component. |
TransferredHeaders | The full set of headers as received from the server. |
TransferredRequest | The full request as sent by the client. |
UseChunkedEncoding | Enables or Disables HTTP chunked encoding for transfers. |
UseIDNs | Whether to encode hostnames to internationalized domain names. |
UseProxyAutoConfigURL | Whether to use a Proxy auto-config file when attempting a connection. |
UserAgent | Information about the user agent (browser). |
ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
FirewallAutoDetect | Tells the component whether or not to automatically detect and use firewall system settings, if available. |
FirewallHost | Name or IP address of firewall (optional). |
FirewallPassword | Password to be used if authentication is to be used when connecting through the firewall. |
FirewallPort | The TCP port for the FirewallHost;. |
FirewallType | Determines the type of firewall to connect through. |
FirewallUser | A user name if authentication is to be used connecting through a firewall. |
KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
Linger | When set to True, connections are terminated gracefully. |
LingerTime | Time in seconds to have the connection linger. |
LocalHost | The name of the local host through which connections are initiated or accepted. |
LocalPort | The port in the local host where the component binds. |
MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
MaxTransferRate | The transfer rate limit in bytes per second. |
ProxyExceptionsList | A semicolon separated list of hosts and IPs to bypass when using a proxy. |
TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
TcpNoDelay | Whether or not to delay when sending packets. |
UseIPv6 | Whether to use IPv6. |
LogSSLPackets | Controls whether SSL packets are logged when using the internal security API. |
OpenSSLCADir | The path to a directory containing CA certificates. |
OpenSSLCAFile | Name of the file containing the list of CA's trusted by your application. |
OpenSSLCipherList | A string that controls the ciphers to be used by SSL. |
OpenSSLPrngSeedData | The data to seed the pseudo random number generator (PRNG). |
ReuseSSLSession | Determines if the SSL session is reused. |
SSLCACerts | A newline separated list of CA certificates to be included when performing an SSL handshake. |
SSLCheckCRL | Whether to check the Certificate Revocation List for the server certificate. |
SSLCheckOCSP | Whether to use OCSP to check the status of the server certificate. |
SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
SSLClientCACerts | A newline separated list of CA certificates to use during SSL client certificate validation. |
SSLEnabledCipherSuites | The cipher suite to be used in an SSL negotiation. |
SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
SSLEnableRenegotiation | Whether the renegotiation_info SSL extension is supported. |
SSLIncludeCertChain | Whether the entire certificate chain is included in the SSLServerAuthentication event. |
SSLKeyLogFile | The location of a file where per-session secrets are written for debugging purposes. |
SSLNegotiatedCipher | Returns the negotiated cipher suite. |
SSLNegotiatedCipherStrength | Returns the negotiated cipher suite strength. |
SSLNegotiatedCipherSuite | Returns the negotiated cipher suite. |
SSLNegotiatedKeyExchange | Returns the negotiated key exchange algorithm. |
SSLNegotiatedKeyExchangeStrength | Returns the negotiated key exchange algorithm strength. |
SSLNegotiatedVersion | Returns the negotiated protocol version. |
SSLSecurityFlags | Flags that control certificate verification. |
SSLServerCACerts | A newline separated list of CA certificates to use during SSL server certificate validation. |
TLS12SignatureAlgorithms | Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal. |
TLS12SupportedGroups | The supported groups for ECC. |
TLS13KeyShareGroups | The groups for which to pregenerate key shares. |
TLS13SignatureAlgorithms | The allowed certificate signature algorithms. |
TLS13SupportedGroups | The supported groups for (EC)DHE key exchange. |
AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
FirewallData | Used to send extra data to the firewall. |
InBufferSize | The size in bytes of the incoming queue of the socket. |
OutBufferSize | The size in bytes of the outgoing queue of the socket. |
BuildInfo | Information about the product's build. |
CodePage | The system code page used for Unicode to Multibyte translations. |
LicenseInfo | Information about the current license. |
MaskSensitiveData | Whether sensitive data is masked in log messages. |
UseFIPSCompliantAPI | Tells the component whether or not to use FIPS certified APIs. |
UseInternalSecurityAPI | Whether or not to use the system security libraries or an internal implementation. |
AttachmentsCount Property (Office365Tasks Component)
The number of records in the Attachment arrays.
Syntax
__property int AttachmentsCount = { read=FAttachmentsCount, write=FSetAttachmentsCount };
Default Value
0
Remarks
This property controls the size of the following arrays:
- AttachmentContentType
- AttachmentData
- AttachmentFileName
- AttachmentId
- AttachmentJSON
- AttachmentLastModifiedDate
- AttachmentName
- AttachmentSize
- AttachmentTaskId
- AttachmentTaskListId
This property is not available at design time.
Data Type
Integer
AttachmentContentType Property (Office365Tasks Component)
This property contains the content type of the attachment.
Syntax
__property String AttachmentContentType[int AttachmentIndex] = { read=FAttachmentContentType };
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 (Office365Tasks Component)
This property contains the raw data of the attachment.
Syntax
__property String AttachmentData[int AttachmentIndex] = { read=FAttachmentData, write=FSetAttachmentData }; __property DynamicArray<Byte> AttachmentDataB[int AttachmentIndex] = { read=FAttachmentDataB, write=FSetAttachmentDataB };
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
Byte Array
AttachmentFileName Property (Office365Tasks Component)
This property contains the local file name associated with the attachment.
Syntax
__property String AttachmentFileName[int AttachmentIndex] = { read=FAttachmentFileName, write=FSetAttachmentFileName };
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 (Office365Tasks Component)
This property contains the attachment identifier of the attachment.
Syntax
__property String AttachmentId[int AttachmentIndex] = { read=FAttachmentId };
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 (Office365Tasks Component)
A JSON representation of the attachment.
Syntax
__property String AttachmentJSON[int AttachmentIndex] = { read=FAttachmentJSON, write=FSetAttachmentJSON };
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 (Office365Tasks Component)
This property contains the date and time when the attachment was last modified.
Syntax
__property String AttachmentLastModifiedDate[int AttachmentIndex] = { read=FAttachmentLastModifiedDate, write=FSetAttachmentLastModifiedDate };
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 (Office365Tasks Component)
This property contains the name of the attachment.
Syntax
__property String AttachmentName[int AttachmentIndex] = { read=FAttachmentName, write=FSetAttachmentName };
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 (Office365Tasks Component)
This property contains the size in bytes of the attachment.
Syntax
__property int AttachmentSize[int AttachmentIndex] = { read=FAttachmentSize, write=FSetAttachmentSize };
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 (Office365Tasks Component)
This property contains the task identifier of the attachment.
Syntax
__property String AttachmentTaskId[int AttachmentIndex] = { read=FAttachmentTaskId };
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 (Office365Tasks Component)
The ID of the task list that contains the task.
Syntax
__property String AttachmentTaskListId[int AttachmentIndex] = { read=FAttachmentTaskListId };
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 (Office365Tasks Component)
An OAuth Authorization String.
Syntax
__property String Authorization = { read=FAuthorization, write=FSetAuthorization };
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 (Office365Tasks Component)
The number of records in the CheckListItem arrays.
Syntax
__property int CheckListItemsCount = { read=FCheckListItemsCount, write=FSetCheckListItemsCount };
Default Value
0
Remarks
This property controls the size of the following arrays:
- CheckListItemCheckedDateTime
- CheckListItemCreatedDateTime
- CheckListItemDisplayName
- CheckListItemId
- CheckListItemIsChecked
- CheckListItemTaskId
- CheckListItemTaskListId
This property is not available at design time.
Data Type
Integer
CheckListItemCheckedDateTime Property (Office365Tasks Component)
The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time.
Syntax
__property String CheckListItemCheckedDateTime[int CheckListItemIndex] = { read=FCheckListItemCheckedDateTime };
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 (Office365Tasks Component)
The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time.
Syntax
__property String CheckListItemCreatedDateTime[int CheckListItemIndex] = { read=FCheckListItemCreatedDateTime };
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 (Office365Tasks Component)
Indicates the title of the checklistItem.
Syntax
__property String CheckListItemDisplayName[int CheckListItemIndex] = { read=FCheckListItemDisplayName, write=FSetCheckListItemDisplayName };
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 (Office365Tasks Component)
The unique identifier of the task.
Syntax
__property String CheckListItemId[int CheckListItemIndex] = { read=FCheckListItemId };
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 (Office365Tasks Component)
State that indicates whether the item is checked off or not.
Syntax
__property bool CheckListItemIsChecked[int CheckListItemIndex] = { read=FCheckListItemIsChecked, write=FSetCheckListItemIsChecked };
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 (Office365Tasks Component)
The ID of the task that contains the subtask.
Syntax
__property String CheckListItemTaskId[int CheckListItemIndex] = { read=FCheckListItemTaskId };
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 (Office365Tasks Component)
The ID of the task list that contains the task.
Syntax
__property String CheckListItemTaskListId[int CheckListItemIndex] = { read=FCheckListItemTaskListId };
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 (Office365Tasks Component)
Whether to automatically detect and use firewall system settings, if available.
Syntax
__property bool FirewallAutoDetect = { read=FFirewallAutoDetect, write=FSetFirewallAutoDetect };
Default Value
False
Remarks
Whether to automatically detect and use firewall system settings, if available.
Data Type
Boolean
FirewallType Property (Office365Tasks Component)
The type of firewall to connect through.
Syntax
__property TccOffice365TasksFirewallTypes FirewallType = { read=FFirewallType, write=FSetFirewallType };
enum TccOffice365TasksFirewallTypes { fwNone=0, fwTunnel=1, fwSOCKS4=2, fwSOCKS5=3, fwSOCKS4A=10 };
Default Value
fwNone
Remarks
The type of firewall to connect through. The applicable values are as follows:
fwNone (0) | No firewall (default setting). |
fwTunnel (1) | Connect through a tunneling proxy. FirewallPort is set to 80. |
fwSOCKS4 (2) | Connect through a SOCKS4 Proxy. FirewallPort is set to 1080. |
fwSOCKS5 (3) | Connect through a SOCKS5 Proxy. FirewallPort is set to 1080. |
fwSOCKS4A (10) | Connect through a SOCKS4A Proxy. FirewallPort is set to 1080. |
Data Type
Integer
FirewallHost Property (Office365Tasks Component)
The name or IP address of the firewall (optional).
Syntax
__property String FirewallHost = { read=FFirewallHost, write=FSetFirewallHost };
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 component raises an exception.
Data Type
String
FirewallPassword Property (Office365Tasks Component)
A password if authentication is to be used when connecting through the firewall.
Syntax
__property String FirewallPassword = { read=FFirewallPassword, write=FSetFirewallPassword };
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 component raises an exception.
Data Type
String
FirewallPort Property (Office365Tasks Component)
The Transmission Control Protocol (TCP) port for the firewall Host .
Syntax
__property int FirewallPort = { read=FFirewallPort, write=FSetFirewallPort };
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 (Office365Tasks Component)
A username if authentication is to be used when connecting through a firewall.
Syntax
__property String FirewallUser = { read=FFirewallUser, write=FSetFirewallUser };
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 component raises an exception.
Data Type
String
ListTasksMarker Property (Office365Tasks Component)
The page marker for listing tasks.
Syntax
__property String ListTasksMarker = { read=FListTasksMarker, write=FSetListTasksMarker };
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 (Office365Tasks Component)
The access token returned by the authorization server.
Syntax
__property String OAuthAccessToken = { read=FOAuthAccessToken, write=FSetOAuthAccessToken };
Default Value
""
Remarks
The access token returned by the authorization server. This is set when the component makes a request to the token server.
This property is not available at design time.
Data Type
String
OAuthAuthorizationCode Property (Office365Tasks Component)
The authorization code that is exchanged for an access token.
Syntax
__property String OAuthAuthorizationCode = { read=FOAuthAuthorizationCode, write=FSetOAuthAuthorizationCode };
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 (Office365Tasks Component)
The scope request or response parameter used during authorization.
Syntax
__property String OAuthAuthorizationScope = { read=FOAuthAuthorizationScope, write=FSetOAuthAuthorizationScope };
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 (Office365Tasks Component)
The id of the client assigned when registering the application.
Syntax
__property String OAuthClientId = { read=FOAuthClientId, write=FSetOAuthClientId };
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 (Office365Tasks Component)
The type of client that is requesting authorization.
Syntax
__property TccOffice365TasksOAuthClientProfiles OAuthClientProfile = { read=FOAuthClientProfile, write=FSetOAuthClientProfile };
enum TccOffice365TasksOAuthClientProfiles { cocpApplication=0, cocpWeb=1 };
Default Value
cocpApplication
Remarks
The type of client that is requesting authorization. See the introduction section for more information. Possible values are:
0 (cocpApplication - Default) | The application profile is applicable to applications that are run by the user directly. For instance a windows form application would use the application profile. To authorize your application (client) using the application profile see the introduction section. |
1 (cocpWeb) | The Web profile is applicable to applications that are run on the server side where the user uses the application from a web browser. To authorize your application (client) using this profile follow see the introduction section. |
This property is not available at design time.
Data Type
Integer
OAuthClientSecret Property (Office365Tasks Component)
The secret value for the client assigned when registering the application.
Syntax
__property String OAuthClientSecret = { read=FOAuthClientSecret, write=FSetOAuthClientSecret };
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 (Office365Tasks Component)
The OAuth grant type used to acquire an OAuth access token.
Syntax
__property TccOffice365TasksOAuthGrantTypes OAuthGrantType = { read=FOAuthGrantType, write=FSetOAuthGrantType };
enum TccOffice365TasksOAuthGrantTypes { cogtAuthorizationCode=0, cogtImplicit=1, cogtPassword=2, cogtClientCredentials=3 };
Default Value
cogtAuthorizationCode
Remarks
The OAuth grant type used to acquire an OAuth access token. See the introduction section for more information. Possible values are:
0 (cogtAuthorizationCode - Default) | Authorization Code grant type |
1 (cogtImplicit) | Implicit grant type |
2 (cogtPassword) | Resource Owner Password Credentials grant type |
3 (cogtClientCredentials) | Client Credentials grant type |
This property is not available at design time.
Data Type
Integer
OAuthRefreshToken Property (Office365Tasks Component)
Specifies the refresh token received from or sent to the authorization server.
Syntax
__property String OAuthRefreshToken = { read=FOAuthRefreshToken, write=FSetOAuthRefreshToken };
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 (Office365Tasks Component)
Specifies whether the component will request a refresh token during authorization.
Syntax
__property bool OAuthRequestRefreshToken = { read=FOAuthRequestRefreshToken, write=FSetOAuthRequestRefreshToken };
Default Value
true
Remarks
Specifies whether the component will request a refresh token during authorization. By default, this value is True.
When True, the component 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 (Office365Tasks Component)
The URL where the user (browser) returns after authenticating.
Syntax
__property String OAuthReturnURL = { read=FOAuthReturnURL, write=FSetOAuthReturnURL };
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 component 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 (Office365Tasks Component)
The URL of the authorization server.
Syntax
__property String OAuthServerAuthURL = { read=FOAuthServerAuthURL, write=FSetOAuthServerAuthURL };
Default Value
""
Remarks
The URL of the authorization server.
This property is not available at design time.
Data Type
String
OAuthServerTokenURL Property (Office365Tasks Component)
The URL of the token server used to obtain the access token.
Syntax
__property String OAuthServerTokenURL = { read=FOAuthServerTokenURL, write=FSetOAuthServerTokenURL };
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 (Office365Tasks Component)
The URL to which the user should be re-directed for authorization.
Syntax
__property String OAuthWebAuthURL = { read=FOAuthWebAuthURL };
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 (Office365Tasks Component)
The type of authorization to perform when connecting to the proxy.
Syntax
__property TccOffice365TasksProxyAuthSchemes ProxyAuthScheme = { read=FProxyAuthScheme, write=FSetProxyAuthScheme };
enum TccOffice365TasksProxyAuthSchemes { authBasic=0, authDigest=1, authProprietary=2, authNone=3, authNtlm=4, authNegotiate=5 };
Default Value
authBasic
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 component 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 component. Look at the configuration file for the component 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 (Office365Tasks Component)
Whether to automatically detect and use proxy system settings, if available.
Syntax
__property bool ProxyAutoDetect = { read=FProxyAutoDetect, write=FSetProxyAutoDetect };
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 (Office365Tasks Component)
A password if authentication is to be used for the proxy.
Syntax
__property String ProxyPassword = { read=FProxyPassword, write=FSetProxyPassword };
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 (Office365Tasks Component)
The Transmission Control Protocol (TCP) port for the proxy Server (default 80).
Syntax
__property int ProxyPort = { read=FProxyPort, write=FSetProxyPort };
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 (Office365Tasks Component)
If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
Syntax
__property String ProxyServer = { read=FProxyServer, write=FSetProxyServer };
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 (Office365Tasks Component)
When to use a Secure Sockets Layer (SSL) for the connection to the proxy.
Syntax
__property TccOffice365TasksProxySSLs ProxySSL = { read=FProxySSL, write=FSetProxySSL };
enum TccOffice365TasksProxySSLs { psAutomatic=0, psAlways=1, psNever=2, psTunnel=3 };
Default Value
psAutomatic
Remarks
When to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:
psAutomatic (0) | Default setting. If the URL is an https URL, the component will use the psTunnel option. If the URL is an http URL, the component will use the psNever option. |
psAlways (1) | The connection is always SSL-enabled. |
psNever (2) | The connection is not SSL-enabled. |
psTunnel (3) | The connection is made through a tunneling (HTTP) proxy. |
Data Type
Integer
ProxyUser Property (Office365Tasks Component)
A username if authentication is to be used for the proxy.
Syntax
__property String ProxyUser = { read=FProxyUser, write=FSetProxyUser };
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 (Office365Tasks Component)
The date on which this certificate becomes valid.
Syntax
__property String SSLAcceptServerCertEffectiveDate = { read=FSSLAcceptServerCertEffectiveDate };
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 (Office365Tasks Component)
The date on which the certificate expires.
Syntax
__property String SSLAcceptServerCertExpirationDate = { read=FSSLAcceptServerCertExpirationDate };
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 (Office365Tasks Component)
A comma-delimited list of extended key usage identifiers.
Syntax
__property String SSLAcceptServerCertExtendedKeyUsage = { read=FSSLAcceptServerCertExtendedKeyUsage };
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 (Office365Tasks Component)
The hex-encoded, 16-byte MD5 fingerprint of the certificate.
Syntax
__property String SSLAcceptServerCertFingerprint = { read=FSSLAcceptServerCertFingerprint };
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 (Office365Tasks Component)
The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.
Syntax
__property String SSLAcceptServerCertFingerprintSHA1 = { read=FSSLAcceptServerCertFingerprintSHA1 };
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 (Office365Tasks Component)
The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.
Syntax
__property String SSLAcceptServerCertFingerprintSHA256 = { read=FSSLAcceptServerCertFingerprintSHA256 };
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 (Office365Tasks Component)
The issuer of the certificate.
Syntax
__property String SSLAcceptServerCertIssuer = { read=FSSLAcceptServerCertIssuer };
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 (Office365Tasks Component)
The private key of the certificate (if available).
Syntax
__property String SSLAcceptServerCertPrivateKey = { read=FSSLAcceptServerCertPrivateKey };
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 (Office365Tasks Component)
Whether a PrivateKey is available for the selected certificate.
Syntax
__property bool SSLAcceptServerCertPrivateKeyAvailable = { read=FSSLAcceptServerCertPrivateKeyAvailable };
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 (Office365Tasks Component)
The name of the PrivateKey container for the certificate (if available).
Syntax
__property String SSLAcceptServerCertPrivateKeyContainer = { read=FSSLAcceptServerCertPrivateKeyContainer };
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 (Office365Tasks Component)
The public key of the certificate.
Syntax
__property String SSLAcceptServerCertPublicKey = { read=FSSLAcceptServerCertPublicKey };
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 (Office365Tasks Component)
The textual description of the certificate's public key algorithm.
Syntax
__property String SSLAcceptServerCertPublicKeyAlgorithm = { read=FSSLAcceptServerCertPublicKeyAlgorithm };
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 (Office365Tasks Component)
The length of the certificate's public key (in bits).
Syntax
__property int SSLAcceptServerCertPublicKeyLength = { read=FSSLAcceptServerCertPublicKeyLength };
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 (Office365Tasks Component)
The serial number of the certificate encoded as a string.
Syntax
__property String SSLAcceptServerCertSerialNumber = { read=FSSLAcceptServerCertSerialNumber };
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 (Office365Tasks Component)
The text description of the certificate's signature algorithm.
Syntax
__property String SSLAcceptServerCertSignatureAlgorithm = { read=FSSLAcceptServerCertSignatureAlgorithm };
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 (Office365Tasks Component)
The name of the certificate store for the client certificate.
Syntax
__property String SSLAcceptServerCertStore = { read=FSSLAcceptServerCertStore, write=FSetSSLAcceptServerCertStore }; __property DynamicArray<Byte> SSLAcceptServerCertStoreB = { read=FSSLAcceptServerCertStoreB, write=FSetSSLAcceptServerCertStoreB };
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:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
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
Byte Array
SSLAcceptServerCertStorePassword Property (Office365Tasks Component)
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Syntax
__property String SSLAcceptServerCertStorePassword = { read=FSSLAcceptServerCertStorePassword, write=FSetSSLAcceptServerCertStorePassword };
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 (Office365Tasks Component)
The type of certificate store for this certificate.
Syntax
__property TccOffice365TasksSSLAcceptServerCertStoreTypes SSLAcceptServerCertStoreType = { read=FSSLAcceptServerCertStoreType, write=FSetSSLAcceptServerCertStoreType };
enum TccOffice365TasksSSLAcceptServerCertStoreTypes { cstUser=0, cstMachine=1, cstPFXFile=2, cstPFXBlob=3, cstJKSFile=4, cstJKSBlob=5, cstPEMKeyFile=6, cstPEMKeyBlob=7, cstPublicKeyFile=8, cstPublicKeyBlob=9, cstSSHPublicKeyBlob=10, cstP7BFile=11, cstP7BBlob=12, cstSSHPublicKeyFile=13, cstPPKFile=14, cstPPKBlob=15, cstXMLFile=16, cstXMLBlob=17, cstJWKFile=18, cstJWKBlob=19, cstSecurityKey=20, cstBCFKSFile=21, cstBCFKSBlob=22, cstPKCS11=23, cstAuto=99 };
Default Value
cstUser
Remarks
The type of certificate store for this certificate.
The component supports both public and private keys in a variety of formats. When the cstAuto value is used, the component will automatically determine the type. This property can take one of the following values:
0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user.
Note: This store type is not available in Java. |
1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store.
Note: This store type is not available in Java. |
2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates.
Note: This store type is only available in Java. |
5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.
Note: This store type is only available in Java. |
6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).
Note: This store type is only available in Java and .NET. |
22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.
Note: This store type is only available in Java and .NET. |
23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface.
To use a security key, the necessary data must first be collected using the CERTMGR component. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the SSLAcceptServerCertStore and set SSLAcceptServerCertStorePassword to the PIN. Code Example. SSH Authentication with Security Key:
|
99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |
Data Type
Integer
SSLAcceptServerCertSubjectAltNames Property (Office365Tasks Component)
Comma-separated lists of alternative subject names for the certificate.
Syntax
__property String SSLAcceptServerCertSubjectAltNames = { read=FSSLAcceptServerCertSubjectAltNames };
Default Value
""
Remarks
Comma-separated lists of alternative subject names for the certificate.
This property is read-only.
Data Type
String
SSLAcceptServerCertThumbprintMD5 Property (Office365Tasks Component)
The MD5 hash of the certificate.
Syntax
__property String SSLAcceptServerCertThumbprintMD5 = { read=FSSLAcceptServerCertThumbprintMD5 };
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 (Office365Tasks Component)
The SHA-1 hash of the certificate.
Syntax
__property String SSLAcceptServerCertThumbprintSHA1 = { read=FSSLAcceptServerCertThumbprintSHA1 };
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 (Office365Tasks Component)
The SHA-256 hash of the certificate.
Syntax
__property String SSLAcceptServerCertThumbprintSHA256 = { read=FSSLAcceptServerCertThumbprintSHA256 };
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 (Office365Tasks Component)
The text description of UsageFlags .
Syntax
__property String SSLAcceptServerCertUsage = { read=FSSLAcceptServerCertUsage };
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 (Office365Tasks Component)
The flags that show intended use for the certificate.
Syntax
__property int SSLAcceptServerCertUsageFlags = { read=FSSLAcceptServerCertUsageFlags };
Default Value
0
Remarks
The flags that show intended use for the certificate. The value of SSLAcceptServerCertUsageFlags is a combination of the following flags:
0x80 | Digital Signature |
0x40 | Non-Repudiation |
0x20 | Key Encipherment |
0x10 | Data Encipherment |
0x08 | Key Agreement |
0x04 | Certificate Signing |
0x02 | CRL Signing |
0x01 | Encipher Only |
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 (Office365Tasks Component)
The certificate's version number.
Syntax
__property String SSLAcceptServerCertVersion = { read=FSSLAcceptServerCertVersion };
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 (Office365Tasks Component)
The subject of the certificate used for client authentication.
Syntax
__property String SSLAcceptServerCertSubject = { read=FSSLAcceptServerCertSubject, write=FSetSSLAcceptServerCertSubject };
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:
Field | Meaning |
CN | Common Name. This is commonly a hostname like www.server.com. |
O | Organization |
OU | Organizational Unit |
L | Locality |
S | State |
C | Country |
E | Email Address |
If a field value contains a comma, it must be quoted.
Data Type
String
SSLAcceptServerCertEncoded Property (Office365Tasks Component)
The certificate (PEM/Base64 encoded).
Syntax
__property String SSLAcceptServerCertEncoded = { read=FSSLAcceptServerCertEncoded, write=FSetSSLAcceptServerCertEncoded }; __property DynamicArray<Byte> SSLAcceptServerCertEncodedB = { read=FSSLAcceptServerCertEncodedB, write=FSetSSLAcceptServerCertEncodedB };
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
Byte Array
SSLCertEffectiveDate Property (Office365Tasks Component)
The date on which this certificate becomes valid.
Syntax
__property String SSLCertEffectiveDate = { read=FSSLCertEffectiveDate };
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 (Office365Tasks Component)
The date on which the certificate expires.
Syntax
__property String SSLCertExpirationDate = { read=FSSLCertExpirationDate };
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 (Office365Tasks Component)
A comma-delimited list of extended key usage identifiers.
Syntax
__property String SSLCertExtendedKeyUsage = { read=FSSLCertExtendedKeyUsage };
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 (Office365Tasks Component)
The hex-encoded, 16-byte MD5 fingerprint of the certificate.
Syntax
__property String SSLCertFingerprint = { read=FSSLCertFingerprint };
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 (Office365Tasks Component)
The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.
Syntax
__property String SSLCertFingerprintSHA1 = { read=FSSLCertFingerprintSHA1 };
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 (Office365Tasks Component)
The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.
Syntax
__property String SSLCertFingerprintSHA256 = { read=FSSLCertFingerprintSHA256 };
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 (Office365Tasks Component)
The issuer of the certificate.
Syntax
__property String SSLCertIssuer = { read=FSSLCertIssuer };
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 (Office365Tasks Component)
The private key of the certificate (if available).
Syntax
__property String SSLCertPrivateKey = { read=FSSLCertPrivateKey };
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 (Office365Tasks Component)
Whether a PrivateKey is available for the selected certificate.
Syntax
__property bool SSLCertPrivateKeyAvailable = { read=FSSLCertPrivateKeyAvailable };
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 (Office365Tasks Component)
The name of the PrivateKey container for the certificate (if available).
Syntax
__property String SSLCertPrivateKeyContainer = { read=FSSLCertPrivateKeyContainer };
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 (Office365Tasks Component)
The public key of the certificate.
Syntax
__property String SSLCertPublicKey = { read=FSSLCertPublicKey };
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 (Office365Tasks Component)
The textual description of the certificate's public key algorithm.
Syntax
__property String SSLCertPublicKeyAlgorithm = { read=FSSLCertPublicKeyAlgorithm };
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 (Office365Tasks Component)
The length of the certificate's public key (in bits).
Syntax
__property int SSLCertPublicKeyLength = { read=FSSLCertPublicKeyLength };
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 (Office365Tasks Component)
The serial number of the certificate encoded as a string.
Syntax
__property String SSLCertSerialNumber = { read=FSSLCertSerialNumber };
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 (Office365Tasks Component)
The text description of the certificate's signature algorithm.
Syntax
__property String SSLCertSignatureAlgorithm = { read=FSSLCertSignatureAlgorithm };
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 (Office365Tasks Component)
The name of the certificate store for the client certificate.
Syntax
__property String SSLCertStore = { read=FSSLCertStore, write=FSetSSLCertStore }; __property DynamicArray<Byte> SSLCertStoreB = { read=FSSLCertStoreB, write=FSetSSLCertStoreB };
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:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
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
Byte Array
SSLCertStorePassword Property (Office365Tasks Component)
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Syntax
__property String SSLCertStorePassword = { read=FSSLCertStorePassword, write=FSetSSLCertStorePassword };
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 (Office365Tasks Component)
The type of certificate store for this certificate.
Syntax
__property TccOffice365TasksSSLCertStoreTypes SSLCertStoreType = { read=FSSLCertStoreType, write=FSetSSLCertStoreType };
enum TccOffice365TasksSSLCertStoreTypes { cstUser=0, cstMachine=1, cstPFXFile=2, cstPFXBlob=3, cstJKSFile=4, cstJKSBlob=5, cstPEMKeyFile=6, cstPEMKeyBlob=7, cstPublicKeyFile=8, cstPublicKeyBlob=9, cstSSHPublicKeyBlob=10, cstP7BFile=11, cstP7BBlob=12, cstSSHPublicKeyFile=13, cstPPKFile=14, cstPPKBlob=15, cstXMLFile=16, cstXMLBlob=17, cstJWKFile=18, cstJWKBlob=19, cstSecurityKey=20, cstBCFKSFile=21, cstBCFKSBlob=22, cstPKCS11=23, cstAuto=99 };
Default Value
cstUser
Remarks
The type of certificate store for this certificate.
The component supports both public and private keys in a variety of formats. When the cstAuto value is used, the component will automatically determine the type. This property can take one of the following values:
0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user.
Note: This store type is not available in Java. |
1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store.
Note: This store type is not available in Java. |
2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates.
Note: This store type is only available in Java. |
5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.
Note: This store type is only available in Java. |
6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).
Note: This store type is only available in Java and .NET. |
22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.
Note: This store type is only available in Java and .NET. |
23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface.
To use a security key, the necessary data must first be collected using the CERTMGR component. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the SSLCertStore and set SSLCertStorePassword to the PIN. Code Example. SSH Authentication with Security Key:
|
99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |
Data Type
Integer
SSLCertSubjectAltNames Property (Office365Tasks Component)
Comma-separated lists of alternative subject names for the certificate.
Syntax
__property String SSLCertSubjectAltNames = { read=FSSLCertSubjectAltNames };
Default Value
""
Remarks
Comma-separated lists of alternative subject names for the certificate.
This property is read-only.
Data Type
String
SSLCertThumbprintMD5 Property (Office365Tasks Component)
The MD5 hash of the certificate.
Syntax
__property String SSLCertThumbprintMD5 = { read=FSSLCertThumbprintMD5 };
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 (Office365Tasks Component)
The SHA-1 hash of the certificate.
Syntax
__property String SSLCertThumbprintSHA1 = { read=FSSLCertThumbprintSHA1 };
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 (Office365Tasks Component)
The SHA-256 hash of the certificate.
Syntax
__property String SSLCertThumbprintSHA256 = { read=FSSLCertThumbprintSHA256 };
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 (Office365Tasks Component)
The text description of UsageFlags .
Syntax
__property String SSLCertUsage = { read=FSSLCertUsage };
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 (Office365Tasks Component)
The flags that show intended use for the certificate.
Syntax
__property int SSLCertUsageFlags = { read=FSSLCertUsageFlags };
Default Value
0
Remarks
The flags that show intended use for the certificate. The value of SSLCertUsageFlags is a combination of the following flags:
0x80 | Digital Signature |
0x40 | Non-Repudiation |
0x20 | Key Encipherment |
0x10 | Data Encipherment |
0x08 | Key Agreement |
0x04 | Certificate Signing |
0x02 | CRL Signing |
0x01 | Encipher Only |
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 (Office365Tasks Component)
The certificate's version number.
Syntax
__property String SSLCertVersion = { read=FSSLCertVersion };
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 (Office365Tasks Component)
The subject of the certificate used for client authentication.
Syntax
__property String SSLCertSubject = { read=FSSLCertSubject, write=FSetSSLCertSubject };
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:
Field | Meaning |
CN | Common Name. This is commonly a hostname like www.server.com. |
O | Organization |
OU | Organizational Unit |
L | Locality |
S | State |
C | Country |
E | Email Address |
If a field value contains a comma, it must be quoted.
Data Type
String
SSLCertEncoded Property (Office365Tasks Component)
The certificate (PEM/Base64 encoded).
Syntax
__property String SSLCertEncoded = { read=FSSLCertEncoded, write=FSetSSLCertEncoded }; __property DynamicArray<Byte> SSLCertEncodedB = { read=FSSLCertEncodedB, write=FSetSSLCertEncodedB };
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
Byte Array
SSLProvider Property (Office365Tasks Component)
The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.
Syntax
__property TccOffice365TasksSSLProviders SSLProvider = { read=FSSLProvider, write=FSetSSLProvider };
enum TccOffice365TasksSSLProviders { sslpAutomatic=0, sslpPlatform=1, sslpInternal=2 };
Default Value
sslpAutomatic
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 component 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:
0 (sslpAutomatic - default) | Automatically selects the appropriate implementation. |
1 (sslpPlatform) | Uses the platform/system implementation. |
2 (sslpInternal) | Uses the internal implementation. |
In most cases using the default value (Automatic) is recommended. The component will select a provider depending on the current platform.
When Automatic is selected, the platform implementation is used by default. When TLS 1.3 is enabled via SSLEnabledProtocols, the internal implementation is used.
Data Type
Integer
SSLServerCertEffectiveDate Property (Office365Tasks Component)
The date on which this certificate becomes valid.
Syntax
__property String SSLServerCertEffectiveDate = { read=FSSLServerCertEffectiveDate };
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 (Office365Tasks Component)
The date on which the certificate expires.
Syntax
__property String SSLServerCertExpirationDate = { read=FSSLServerCertExpirationDate };
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 (Office365Tasks Component)
A comma-delimited list of extended key usage identifiers.
Syntax
__property String SSLServerCertExtendedKeyUsage = { read=FSSLServerCertExtendedKeyUsage };
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 (Office365Tasks Component)
The hex-encoded, 16-byte MD5 fingerprint of the certificate.
Syntax
__property String SSLServerCertFingerprint = { read=FSSLServerCertFingerprint };
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 (Office365Tasks Component)
The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.
Syntax
__property String SSLServerCertFingerprintSHA1 = { read=FSSLServerCertFingerprintSHA1 };
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 (Office365Tasks Component)
The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.
Syntax
__property String SSLServerCertFingerprintSHA256 = { read=FSSLServerCertFingerprintSHA256 };
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 (Office365Tasks Component)
The issuer of the certificate.
Syntax
__property String SSLServerCertIssuer = { read=FSSLServerCertIssuer };
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 (Office365Tasks Component)
The private key of the certificate (if available).
Syntax
__property String SSLServerCertPrivateKey = { read=FSSLServerCertPrivateKey };
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 (Office365Tasks Component)
Whether a PrivateKey is available for the selected certificate.
Syntax
__property bool SSLServerCertPrivateKeyAvailable = { read=FSSLServerCertPrivateKeyAvailable };
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 (Office365Tasks Component)
The name of the PrivateKey container for the certificate (if available).
Syntax
__property String SSLServerCertPrivateKeyContainer = { read=FSSLServerCertPrivateKeyContainer };
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 (Office365Tasks Component)
The public key of the certificate.
Syntax
__property String SSLServerCertPublicKey = { read=FSSLServerCertPublicKey };
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 (Office365Tasks Component)
The textual description of the certificate's public key algorithm.
Syntax
__property String SSLServerCertPublicKeyAlgorithm = { read=FSSLServerCertPublicKeyAlgorithm };
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 (Office365Tasks Component)
The length of the certificate's public key (in bits).
Syntax
__property int SSLServerCertPublicKeyLength = { read=FSSLServerCertPublicKeyLength };
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 (Office365Tasks Component)
The serial number of the certificate encoded as a string.
Syntax
__property String SSLServerCertSerialNumber = { read=FSSLServerCertSerialNumber };
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 (Office365Tasks Component)
The text description of the certificate's signature algorithm.
Syntax
__property String SSLServerCertSignatureAlgorithm = { read=FSSLServerCertSignatureAlgorithm };
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 (Office365Tasks Component)
The name of the certificate store for the client certificate.
Syntax
__property String SSLServerCertStore = { read=FSSLServerCertStore }; __property DynamicArray<Byte> SSLServerCertStoreB = { read=FSSLServerCertStoreB };
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:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
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
Byte Array
SSLServerCertStorePassword Property (Office365Tasks Component)
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Syntax
__property String SSLServerCertStorePassword = { read=FSSLServerCertStorePassword };
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 (Office365Tasks Component)
The type of certificate store for this certificate.
Syntax
__property TccOffice365TasksSSLServerCertStoreTypes SSLServerCertStoreType = { read=FSSLServerCertStoreType };
enum TccOffice365TasksSSLServerCertStoreTypes { cstUser=0, cstMachine=1, cstPFXFile=2, cstPFXBlob=3, cstJKSFile=4, cstJKSBlob=5, cstPEMKeyFile=6, cstPEMKeyBlob=7, cstPublicKeyFile=8, cstPublicKeyBlob=9, cstSSHPublicKeyBlob=10, cstP7BFile=11, cstP7BBlob=12, cstSSHPublicKeyFile=13, cstPPKFile=14, cstPPKBlob=15, cstXMLFile=16, cstXMLBlob=17, cstJWKFile=18, cstJWKBlob=19, cstSecurityKey=20, cstBCFKSFile=21, cstBCFKSBlob=22, cstPKCS11=23, cstAuto=99 };
Default Value
cstUser
Remarks
The type of certificate store for this certificate.
The component supports both public and private keys in a variety of formats. When the cstAuto value is used, the component will automatically determine the type. This property can take one of the following values:
0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user.
Note: This store type is not available in Java. |
1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store.
Note: This store type is not available in Java. |
2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates.
Note: This store type is only available in Java. |
5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.
Note: This store type is only available in Java. |
6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).
Note: This store type is only available in Java and .NET. |
22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.
Note: This store type is only available in Java and .NET. |
23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface.
To use a security key, the necessary data must first be collected using the CERTMGR component. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the SSLServerCertStore and set SSLServerCertStorePassword to the PIN. Code Example. SSH Authentication with Security Key:
|
99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |
This property is read-only.
Data Type
Integer
SSLServerCertSubjectAltNames Property (Office365Tasks Component)
Comma-separated lists of alternative subject names for the certificate.
Syntax
__property String SSLServerCertSubjectAltNames = { read=FSSLServerCertSubjectAltNames };
Default Value
""
Remarks
Comma-separated lists of alternative subject names for the certificate.
This property is read-only.
Data Type
String
SSLServerCertThumbprintMD5 Property (Office365Tasks Component)
The MD5 hash of the certificate.
Syntax
__property String SSLServerCertThumbprintMD5 = { read=FSSLServerCertThumbprintMD5 };
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 (Office365Tasks Component)
The SHA-1 hash of the certificate.
Syntax
__property String SSLServerCertThumbprintSHA1 = { read=FSSLServerCertThumbprintSHA1 };
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 (Office365Tasks Component)
The SHA-256 hash of the certificate.
Syntax
__property String SSLServerCertThumbprintSHA256 = { read=FSSLServerCertThumbprintSHA256 };
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 (Office365Tasks Component)
The text description of UsageFlags .
Syntax
__property String SSLServerCertUsage = { read=FSSLServerCertUsage };
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 (Office365Tasks Component)
The flags that show intended use for the certificate.
Syntax
__property int SSLServerCertUsageFlags = { read=FSSLServerCertUsageFlags };
Default Value
0
Remarks
The flags that show intended use for the certificate. The value of SSLServerCertUsageFlags is a combination of the following flags:
0x80 | Digital Signature |
0x40 | Non-Repudiation |
0x20 | Key Encipherment |
0x10 | Data Encipherment |
0x08 | Key Agreement |
0x04 | Certificate Signing |
0x02 | CRL Signing |
0x01 | Encipher Only |
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 (Office365Tasks Component)
The certificate's version number.
Syntax
__property String SSLServerCertVersion = { read=FSSLServerCertVersion };
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 (Office365Tasks Component)
The subject of the certificate used for client authentication.
Syntax
__property String SSLServerCertSubject = { read=FSSLServerCertSubject };
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:
Field | Meaning |
CN | Common Name. This is commonly a hostname like www.server.com. |
O | Organization |
OU | Organizational Unit |
L | Locality |
S | State |
C | Country |
E | Email Address |
If a field value contains a comma, it must be quoted.
This property is read-only.
Data Type
String
SSLServerCertEncoded Property (Office365Tasks Component)
The certificate (PEM/Base64 encoded).
Syntax
__property String SSLServerCertEncoded = { read=FSSLServerCertEncoded }; __property DynamicArray<Byte> SSLServerCertEncodedB = { read=FSSLServerCertEncodedB };
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
Byte Array
TaskListsCount Property (Office365Tasks Component)
The number of records in the TaskList arrays.
Syntax
__property int TaskListsCount = { read=FTaskListsCount, write=FSetTaskListsCount };
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at TaskListsCount - 1.This property is not available at design time.
Data Type
Integer
TaskListDisplayName Property (Office365Tasks Component)
the name of the task list.
Syntax
__property String TaskListDisplayName[int TaskListIndex] = { read=FTaskListDisplayName, write=FSetTaskListDisplayName };
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 (Office365Tasks Component)
The unique identifier of the task list.
Syntax
__property String TaskListId[int TaskListIndex] = { read=FTaskListId };
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 (Office365Tasks Component)
True if this is the default task list where new tasks are created by default, false otherwise.
Syntax
__property bool TaskListIsDefault[int TaskListIndex] = { read=FTaskListIsDefault };
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 (Office365Tasks Component)
True if the user is the owner of the given task list.
Syntax
__property bool TaskListIsOwner[int TaskListIndex] = { read=FTaskListIsOwner };
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 (Office365Tasks Component)
True if the task list is shared with other users.
Syntax
__property bool TaskListIsShared[int TaskListIndex] = { read=FTaskListIsShared };
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 (Office365Tasks Component)
The number of records in the Task arrays.
Syntax
__property int TasksCount = { read=FTasksCount, write=FSetTasksCount };
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
This property is not available at design time.
Data Type
Integer
TaskBody Property (Office365Tasks Component)
The task body that typically contains information about the task.
Syntax
__property String TaskBody[int TaskIndex] = { read=FTaskBody, write=FSetTaskBody };
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 (Office365Tasks Component)
The date and time when the task body was last modified.
Syntax
__property String TaskBodyLastModifiedDateTime[int TaskIndex] = { read=FTaskBodyLastModifiedDateTime };
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 (Office365Tasks Component)
The categories associated with the task.
Syntax
__property String TaskCategories[int TaskIndex] = { read=FTaskCategories, write=FSetTaskCategories };
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 (Office365Tasks Component)
The date and time the task was finished.
Syntax
__property String TaskCompletedDateTime[int TaskIndex] = { read=FTaskCompletedDateTime, write=FSetTaskCompletedDateTime };
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 (Office365Tasks Component)
The time zone of the time the task was finished.
Syntax
__property String TaskCompletedTimeZone[int TaskIndex] = { read=FTaskCompletedTimeZone, write=FSetTaskCompletedTimeZone };
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 (Office365Tasks Component)
The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time.
Syntax
__property String TaskCreatedDateTime[int TaskIndex] = { read=FTaskCreatedDateTime };
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 (Office365Tasks Component)
The date and time the task is to be finished.
Syntax
__property String TaskDueDateTime[int TaskIndex] = { read=FTaskDueDateTime, write=FSetTaskDueDateTime };
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 (Office365Tasks Component)
The time zone of the time the task is to be finished.
Syntax
__property String TaskDueTimeZone[int TaskIndex] = { read=FTaskDueTimeZone, write=FSetTaskDueTimeZone };
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 (Office365Tasks Component)
Set to true if the task has attachments.
Syntax
__property bool TaskHasAttachments[int TaskIndex] = { read=FTaskHasAttachments };
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 (Office365Tasks Component)
The unique identifier of the task.
Syntax
__property String TaskId[int TaskIndex] = { read=FTaskId };
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 (Office365Tasks Component)
The importance of the task.
Syntax
__property TccOffice365TasksTaskImportances TaskImportance[int TaskIndex] = { read=FTaskImportance, write=FSetTaskImportance };
enum TccOffice365TasksTaskImportances { otiLow=0, otiNormal=1, otiHigh=2 };
Default Value
otiLow
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 (Office365Tasks Component)
Set to true if an alert is set to remind the user of the task.
Syntax
__property bool TaskIsReminderOn[int TaskIndex] = { read=FTaskIsReminderOn, write=FSetTaskIsReminderOn };
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 (Office365Tasks Component)
A JSON representation of the task.
Syntax
__property String TaskJSON[int TaskIndex] = { read=FTaskJSON, write=FSetTaskJSON };
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 (Office365Tasks Component)
The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time.
Syntax
__property String TaskLastModifiedDateTime[int TaskIndex] = { read=FTaskLastModifiedDateTime };
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 (Office365Tasks Component)
The day of the month on which the task occurs.
Syntax
__property int TaskRecurDayOfMonth[int TaskIndex] = { read=FTaskRecurDayOfMonth, write=FSetTaskRecurDayOfMonth };
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 (Office365Tasks Component)
A space separated collection of the days of the week on which the task occurs.
Syntax
__property String TaskRecurDaysOfWeek[int TaskIndex] = { read=FTaskRecurDaysOfWeek, write=FSetTaskRecurDaysOfWeek };
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 (Office365Tasks Component)
The date to stop applying the recurrence pattern.
Syntax
__property String TaskRecurEndDate[int TaskIndex] = { read=FTaskRecurEndDate, write=FSetTaskRecurEndDate };
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 (Office365Tasks Component)
The first day of the week.
Syntax
__property String TaskRecurFirstDayOfWeek[int TaskIndex] = { read=FTaskRecurFirstDayOfWeek, write=FSetTaskRecurFirstDayOfWeek };
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 (Office365Tasks Component)
Specifies on which instance of the allowed days specified in daysOfWeek the task occurs, counted from the first instance in the month.
Syntax
__property String TaskRecurIndex[int TaskIndex] = { read=FTaskRecurIndex, write=FSetTaskRecurIndex };
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 (Office365Tasks Component)
The number of units between occurrences, where units can be in days, weeks, months, or years, depending on the type.
Syntax
__property int TaskRecurInterval[int TaskIndex] = { read=FTaskRecurInterval, write=FSetTaskRecurInterval };
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 (Office365Tasks Component)
The month in which the task occurs.
Syntax
__property int TaskRecurMonth[int TaskIndex] = { read=FTaskRecurMonth, write=FSetTaskRecurMonth };
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 (Office365Tasks Component)
The number of times to repeat the task.
Syntax
__property int TaskRecurNumberOfOccurrences[int TaskIndex] = { read=FTaskRecurNumberOfOccurrences, write=FSetTaskRecurNumberOfOccurrences };
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 (Office365Tasks Component)
The recurrence range.
Syntax
__property TccOffice365TasksTaskRecurRangeTypes TaskRecurRangeType[int TaskIndex] = { read=FTaskRecurRangeType, write=FSetTaskRecurRangeType };
enum TccOffice365TasksTaskRecurRangeTypes { otrrtEndDate=0, otrrtNoEnd=1, otrrtNumbered=2 };
Default Value
otrrtEndDate
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 (Office365Tasks Component)
The date to start applying the recurrence pattern.
Syntax
__property String TaskRecurStartDate[int TaskIndex] = { read=FTaskRecurStartDate, write=FSetTaskRecurStartDate };
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 (Office365Tasks Component)
Time zone for the startDate and endDate properties.
Syntax
__property String TaskRecurTimeZone[int TaskIndex] = { read=FTaskRecurTimeZone, write=FSetTaskRecurTimeZone };
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 (Office365Tasks Component)
The recurrence pattern type Possible values are: 0 (otrtDaily) 1 (otrtWeekly) 2 (otrtAbsoluteMonthly) 3 (otrtRelativeMonthly) 4 (otrtAbsoluteYearly) 5 (otrtRelativeYearly) .
Syntax
__property TccOffice365TasksTaskRecurTypes TaskRecurType[int TaskIndex] = { read=FTaskRecurType, write=FSetTaskRecurType };
enum TccOffice365TasksTaskRecurTypes { otrtDaily=0, otrtWeekly=1, otrtAbsoluteMonthly=2, otrtRelativeMonthly=3, otrtAbsoluteYearly=4, otrtRelativeYearly=5 };
Default Value
otrtDaily
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 (Office365Tasks Component)
The date and time for a reminder alert of the task to occur.
Syntax
__property String TaskReminderDateTime[int TaskIndex] = { read=FTaskReminderDateTime, write=FSetTaskReminderDateTime };
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 (Office365Tasks Component)
The time zone of the time for a reminder alert of the task to occur.
Syntax
__property String TaskReminderTimeZone[int TaskIndex] = { read=FTaskReminderTimeZone, write=FSetTaskReminderTimeZone };
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 (Office365Tasks Component)
The date and time at which the task is scheduled to start.
Syntax
__property String TaskStartDateTime[int TaskIndex] = { read=FTaskStartDateTime, write=FSetTaskStartDateTime };
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 (Office365Tasks Component)
The time zone of the time at which the task is scheduled to start.
Syntax
__property String TaskStartTimeZone[int TaskIndex] = { read=FTaskStartTimeZone, write=FSetTaskStartTimeZone };
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 (Office365Tasks Component)
The status of the task.
Syntax
__property TccOffice365TasksTaskStatus TaskStatus[int TaskIndex] = { read=FTaskStatus, write=FSetTaskStatus };
enum TccOffice365TasksTaskStatus { otsNotStarted=0, otsInProgress=1, otsCompleted=2, otsWaitingOnOthers=3, otsDeferred=4 };
Default Value
otsNotStarted
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 (Office365Tasks Component)
The ID of the task list that contains the task.
Syntax
__property String TaskTaskListId[int TaskIndex] = { read=FTaskTaskListId };
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 (Office365Tasks Component)
A brief description of the task.
Syntax
__property String TaskTitle[int TaskIndex] = { read=FTaskTitle, write=FSetTaskTitle };
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 (Office365Tasks Component)
Adds a file attachment to an existing task.
Syntax
void __fastcall AddAttachment(String TaskListId, String TaskId, String Name, String 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 component 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 component 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 (Office365Tasks Component)
Get the authorization string required to access the protected resource.
Syntax
void __fastcall Authorize();
Remarks
This method is used to get an access token that is required to access the protected resource. The method will act differently based on what is set in the 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 (Office365Tasks Component)
Sets or retrieves a configuration setting.
Syntax
String __fastcall Config(String ConfigurationString);
Remarks
Config is a generic method available in every component. It is used to set and retrieve configuration settings for the component.
These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, 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 (Office365Tasks Component)
Creates a subtask.
Syntax
void __fastcall CreateCheckListItem(String Subject, String TaskListId, String 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 (Office365Tasks Component)
Creates a task.
Syntax
void __fastcall CreateTask(String Subject, String 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 (Office365Tasks Component)
Creates a new task list.
Syntax
void __fastcall CreateTaskList(String 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 (Office365Tasks Component)
Deletes an attachment.
Syntax
void __fastcall DeleteAttachment(String TaskListId, String TaskId, String 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 (Office365Tasks Component)
Deletes a subtask.
Syntax
void __fastcall DeleteCheckListItem(String TaskListId, String TaskId, String 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 (Office365Tasks Component)
Deletes a task.
Syntax
void __fastcall DeleteTask(String TaskListId, String 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 (Office365Tasks Component)
Deletes a task list.
Syntax
void __fastcall DeleteTaskList(String 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 (Office365Tasks Component)
Retrieves the subtask by Id.
Syntax
void __fastcall GetCheckListItem(String TaskListId, String TaskId, String 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 (Office365Tasks Component)
Retrieves the task by Id.
Syntax
void __fastcall GetTask(String TaskListId, String 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 (Office365Tasks Component)
Retrieves the task property value by JSONPath.
Syntax
String __fastcall GetTaskField(int index, String 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 (Office365Tasks Component)
Interrupt the current method.
Syntax
void __fastcall Interrupt();
Remarks
If there is no method in progress, Interrupt simply returns, doing nothing.
ListAttachments Method (Office365Tasks Component)
Lists all of a task's attachments.
Syntax
void __fastcall ListAttachments(String TaskListId, String 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 (Office365Tasks Component)
Lists the subtasks.
Syntax
void __fastcall ListCheckListItems(String TaskListId, String 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 (Office365Tasks Component)
Lists the task lists.
Syntax
void __fastcall ListTaskLists();
Remarks
List all Task lists associated with the current user. The retrieved Task lists are added to the TaskLists collection. For each Task list retrieved, the TaskListList event is fired.
ListTasks Method (Office365Tasks Component)
Lists the tasks.
Syntax
void __fastcall ListTasks(String 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 (Office365Tasks Component)
This method will reset the component.
Syntax
void __fastcall Reset();
Remarks
This method will reset the component's properties to their default values.
RetrieveAttachment Method (Office365Tasks Component)
Retrieves a task's attachment.
Syntax
void __fastcall RetrieveAttachment(String TaskListId, String TaskId, String 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 (Office365Tasks Component)
Send a custom HTTP request.
Syntax
void __fastcall SendCustomRequest(String HTTPMethod, String URL, String PostData);
Remarks
This method can be used to send a custom HTTP request to the server.
SetTaskField Method (Office365Tasks Component)
Sets the task field value by JSONPath.
Syntax
void __fastcall SetTaskField(int index, String JsonPath, String Value, int 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 (Office365Tasks Component)
Updates a subtask.
Syntax
void __fastcall UpdateCheckListItem(int 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 (Office365Tasks Component)
Updates a task.
Syntax
void __fastcall UpdateTask(int 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 (Office365Tasks Component)
Updates a task list.
Syntax
void __fastcall UpdateTaskList(int 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 (Office365Tasks Component)
Fired when an attachment is retrieved from the server.
Syntax
typedef struct { String Id; String Name; String ContentType; String LastModifiedDateTime; int Size; } TccOffice365TasksAttachmentListEventParams; typedef void __fastcall (__closure *TccOffice365TasksAttachmentListEvent)(System::TObject* Sender, TccOffice365TasksAttachmentListEventParams *e); __property TccOffice365TasksAttachmentListEvent OnAttachmentList = { read=FOnAttachmentList, write=FOnAttachmentList };
Remarks
The AttachmentList event is fired for each attachment retrieved from the server when ListAttachments is called. This event provides the attachment's Id, Name, ContentType, LastModifiedDateTime and Size.
CheckListItemList Event (Office365Tasks Component)
Fired when a subtask is retrieved from the server.
Syntax
typedef struct { String Id; String TaskId; String TaskListId; String Subject; } TccOffice365TasksCheckListItemListEventParams; typedef void __fastcall (__closure *TccOffice365TasksCheckListItemListEvent)(System::TObject* Sender, TccOffice365TasksCheckListItemListEventParams *e); __property TccOffice365TasksCheckListItemListEvent OnCheckListItemList = { read=FOnCheckListItemList, write=FOnCheckListItemList };
Remarks
The CheckListItemList event is fired for each subtask retrieved from the server when ListCheckListItems is called. This event provides the subtask's Id, TaskId, TaskListId and Subject.
Error Event (Office365Tasks Component)
Fired when information is available about errors during data delivery.
Syntax
typedef struct { int ErrorCode; String Description; } TccOffice365TasksErrorEventParams; typedef void __fastcall (__closure *TccOffice365TasksErrorEvent)(System::TObject* Sender, TccOffice365TasksErrorEventParams *e); __property TccOffice365TasksErrorEvent OnError = { read=FOnError, write=FOnError };
Remarks
The Error event is fired in case of exceptional conditions during message processing. Normally the component raises an exception.
The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.
Log Event (Office365Tasks Component)
Fired once for each log message.
Syntax
typedef struct { int LogLevel; String Message; String LogType; } TccOffice365TasksLogEventParams; typedef void __fastcall (__closure *TccOffice365TasksLogEvent)(System::TObject* Sender, TccOffice365TasksLogEventParams *e); __property TccOffice365TasksLogEvent OnLog = { read=FOnLog, write=FOnLog };
Remarks
This event is fired once for each log message generated by the component. The verbosity is controlled by the LogLevel setting.
LogLevel indicates the level of message. Possible values are as follows:
0 (None) | No events are logged. |
1 (Info - default) | Informational events are logged. |
2 (Verbose) | Detailed data are logged. |
3 (Debug) | Debug data are logged. |
The value 1 (Info) logs basic information, including the URL, HTTP version, and status details.
The value 2 (Verbose) logs additional information about the request and response.
The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any).
Message is the log entry.
LogType identifies the type of log entry. Possible values are as follows:
- "Info"
- "RequestHeaders"
- "ResponseHeaders"
- "RequestBody"
- "ResponseBody"
- "ProxyRequest"
- "ProxyResponse"
- "FirewallRequest"
- "FirewallResponse"
SSLServerAuthentication Event (Office365Tasks Component)
Fired after the server presents its certificate to the client.
Syntax
typedef struct { String CertEncoded; DynamicArray<Byte> CertEncodedB; String CertSubject; String CertIssuer; String Status; bool Accept; } TccOffice365TasksSSLServerAuthenticationEventParams; typedef void __fastcall (__closure *TccOffice365TasksSSLServerAuthenticationEvent)(System::TObject* Sender, TccOffice365TasksSSLServerAuthenticationEventParams *e); __property TccOffice365TasksSSLServerAuthenticationEvent OnSSLServerAuthentication = { read=FOnSSLServerAuthentication, write=FOnSSLServerAuthentication };
Remarks
During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.
When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.
SSLStatus Event (Office365Tasks Component)
Fired when secure connection progress messages are available.
Syntax
typedef struct { String Message; } TccOffice365TasksSSLStatusEventParams; typedef void __fastcall (__closure *TccOffice365TasksSSLStatusEvent)(System::TObject* Sender, TccOffice365TasksSSLStatusEventParams *e); __property TccOffice365TasksSSLStatusEvent OnSSLStatus = { read=FOnSSLStatus, write=FOnSSLStatus };
Remarks
The event is fired for informational and logging purposes only. This event tracks the progress of the connection.
TaskList Event (Office365Tasks Component)
Fired when a task is retrieved from the server.
Syntax
typedef struct { String Id; String TaskListId; String Subject; } TccOffice365TasksTaskListEventParams; typedef void __fastcall (__closure *TccOffice365TasksTaskListEvent)(System::TObject* Sender, TccOffice365TasksTaskListEventParams *e); __property TccOffice365TasksTaskListEvent OnTaskList = { read=FOnTaskList, write=FOnTaskList };
Remarks
The TaskList event is fired for each task retrieved from the server when ListTasks is called. This event provides the task's Id, TaskListId and Subject.
TaskListList Event (Office365Tasks Component)
Fired when a task list is retrieved from the server.
Syntax
typedef struct { String Id; String Name; } TccOffice365TasksTaskListListEventParams; typedef void __fastcall (__closure *TccOffice365TasksTaskListListEvent)(System::TObject* Sender, TccOffice365TasksTaskListListEventParams *e); __property TccOffice365TasksTaskListListEvent OnTaskListList = { read=FOnTaskListList, write=FOnTaskListList };
Remarks
The TaskListList event is fired for each task list retrieved from the server when ListTaskLists is called. This event provides the task list's Id and Name.
Transfer Event (Office365Tasks Component)
Fired while a document transfers (delivers document).
Syntax
typedef struct { int Direction; __int64 BytesTransferred; int PercentDone; String Text; DynamicArray<Byte> TextB; } TccOffice365TasksTransferEventParams; typedef void __fastcall (__closure *TccOffice365TasksTransferEvent)(System::TObject* Sender, TccOffice365TasksTransferEventParams *e); __property TccOffice365TasksTransferEvent OnTransfer = { read=FOnTransfer, write=FOnTransfer };
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 Component)
The component accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.Office365Tasks Config Settings
The default value is 2097152 (2MiBs).
The default value is 2097152 (2MiBs).
The default value is 100.
The default value is 100.
The current element is specified through the XPath configuration setting. This configuration setting is read-only.
The current element is specified through the XPath configuration setting. This configuration setting is read-only.
The current element is specified through the XPath configuration setting. This configuration setting is read-only.
The current element is specified through the XPath configuration setting. This configuration setting is read-only.
The current element is specified through the XPath configuration setting. This configuration setting is read-only.
When XPath is set to a valid path, XElement points to the name of the element, with XText, XParent, XSubTree, XChildCount, XChildName[i], and XChildXText[i] providing other properties of the element.
XPath syntax is available for both XML and JSON documents. An XPath is a series of one or more element accessors separated by the / character, for example, /A/B/C/D. An XPath can be absolute (i.e., it starts with /), or it can be relative to the current XPath location.
The following are possible values for an element accessor, which operates relative to the current location specified by the XPath accessors, which proceed it in the overall XPath string:
Accessor | Description |
name | The first element with a particular name. Can be *. |
[i] | The i-th element. |
name[i] | The i-th element with a particular name. |
[last()] | The last element. |
[last()-i] | The element i before the last element. |
name[@attrname="attrvalue"] | The first element with a particular name that contains the specified attribute-value pair.
Supports single and double quotes. (XML Only) |
. | The current element. |
.. | The parent element. |
For example, assume the following XML and JSON responses.
XML:
<firstlevel> <one>value</one> <two> <item>first</item> <item>second</item> </two> <three>value three</three> </firstlevel>
JSON:
{ "firstlevel": { "one": "value", "two": ["first", "second"], "three": "value three" } }
The following are examples of valid XPaths for these responses:
Description | XML XPath | JSON XPath |
Document root | / | /json |
Specific element | /firstlevel/one | /json/firstlevel/one |
i-th child | /firstlevel/two/item[2] | /json/firstlevel/two/[2] |
This list is not exhaustive, but it provides a general idea of the possibilities.
The current element is specified through the XPath configuration setting. This configuration setting is read-only.
The current element is specified in the XPath configuration setting. This configuration setting is read-only.
OAuth Config Settings
Bearer (default) | When the access token returned by the server is a Bearer type, the authorization string returned by Authorize will be in the format "Bearer access_token". This can be supplied as the value of the HTTP Authorization header. |
For example, when using the Authorization Code grant type, the OAuthRefreshToken property should be set to a valid refresh token. When using the Client Credential grant type however, the component does not need any additional properties set as it can already get a new access token without user interaction.
If set to true (default) the redirect_uri will be sent in all cases. If set to false the redirect_uri will only be sent if it has a value.
To parse the payload for specific claims, see OAuthJWTXPath.
The current element is specified in the OAuthJWTXPath configuration setting. This configuration setting is read-only.
The current element is specified in the OAuthJWTXPath configuration setting. This configuration setting is read-only.
The current element is specified in the OAuthJWTXPath configuration setting. This configuration setting is read-only.
The current element is specified in the OAuthJWTXPath configuration setting. This configuration setting is read-only.
The current element is specified in the OAuthJWTXPath configuration setting. This configuration setting is read-only.
XPath syntax is available for the payload of JWT based access tokens if available. An XPath is a series of one or more element accessors separated by the / character, for example: /A/B/C/D.
The following are possible values for an element accessor, which operates relative to the current location specified by the XPath accessors which proceed it in the overall XPath string:
Accessor | Description |
name | The first element with a particular name. Can be *. |
[i] | The i-th element. |
name[i] | The i-th element with a particular name. |
[last()] | The last element. |
[last()-i] | The element i before the last element. |
Description | JSON XPath |
Document root | /json |
Specific element | /json/element_one |
Username Claim (Microsoft Specific) | /json/preferred_username |
Registered Application Name Claim (Microsoft Specific) | /json/app_displayname |
This is not an exhaustive list by any means, but should provide a general idea of the possibilities. To get the text of the specified element, see OAuthJWTXText.
The current element is specified in the OAuthJWTXPath configuration setting. This configuration setting is read-only.
The current element is specified in the OAuthJWTXPath configuration setting. This configuration setting is read-only.
component.Config("OAuthParamCount=2");
component.Config("OAuthParamName[0]=myvar");
component.Config("OAuthParamValue[0]=myvalue");
component.Config("OAuthParamName[1]=testname");
component.Config("OAuthParamValue[1]=testvalue");
Additionally, this will also be updated to hold the parameters returned in the response.
for (int i = 0; i < int.Parse(component.Config("OAuthParamCount")); i++)
{
string name = component.Config("OAuthParamName[" + i + "]");
string value = component.Config("OAuthParamValue[" + i + "]");
}
- 1 (Plain)
- 2 (S256/SHA256 - default)
.NET
Gmail gmail = new Gmail();
gmail.Config("OAuthTransferredRequest=on");
gmail.Authorize();
Console.WriteLine(gmail.Config("OAuthTransferredRequest"));
C++
Gmail gmail;
gmail.Config("OAuthTransferredRequest=on");
gmail.Authorize();
printf("%s\r\n", gmail.Config("OAuthTransferredRequest"));
This setting can also be set to activate or deactivate the web server. Under normal circumstances, this would not be required as the component will automatically start and stop the web server when Authorize is called. In certain cases, it is required to start the webserver before calling Authorize. For example, if the OAuthReturnURL needs to be set to a relay server, then you will need to start the web server manually. Another example would be when the OAuthReUseWebServer is set to true, the server will not be automatically stopped, and this configuration setting must be set to "false" to stop the embedded web server.
The OAuthWebServerCertStoreType property specifies the type of the certificate store specified by OAuthWebServerCertStore. If the store is password protected, specify the password in OAuthWebServerCertStorePassword.
OAuthWebServerCertStore is used in conjunction with the OAuthWebServerCertSubject property in order to specify the certificate to be used during SSL.
Designations of certificate stores are platform dependent.
The following designations are the most common User and Machine certificate stores in Windows:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
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).
Note: This is required when OAuthWebServerSSLEnabled is set to true.
Note: This is only applicable when OAuthWebServerSSLEnabled is set to true.
0 | User - This is the default for Windows. This specifies that the certificate store is a certificate store owned by the current user. Note: This store type is not available in Java. |
1 | Machine - For Windows, this specifies that the certificate store is a machine store. Note: This store type is not available in Java. |
2 | PFXFile - The certificate store is the name of a PFX (PKCS12) file containing certificates. |
3 | PFXBlob - The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS12) format. |
4 | JKSFile - The certificate store is the name of a Java Key Store (JKS) file containing certificates. Note: This store type is available only in Java. |
5 | JKSBlob - The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. Note: This store type is available only in Java. |
6 | PEMKeyFile - The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
7 | PEMKeyBlob - The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
14 | PPKFile - The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
15 | PPKBlob - The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
16 | XMLFile - The certificate store is the name of a file that contains a certificate in XML format. |
17 | XMLBlob - The certificate store is a string that contains a certificate in XML format. |
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:
Field | Meaning |
CN | Common Name. This is commonly a hostname like www.server.com. |
O | Organization |
OU | Organizational Unit |
L | Locality |
S | State |
C | Country |
E | Email Address |
If a field value contains a comma, it must be quoted.
Note: This is required when OAuthWebServerSSLEnabled is set to true.
The default value is localhost.
HTTP Config Settings
When True, the component adds an Accept-Encoding header to the outgoing request. The value for this header can be controlled by the AcceptEncoding configuration setting. The default value for this header is "gzip, deflate".
The default value is True.
If set to True (default), the component will automatically use HTTP/1.1 if the server does not support HTTP/2. If set to False, the component raises an exception if the server does not support HTTP/2.
The default value is True.
This property is provided so that the HTTP component can be extended with other security schemes in addition to the authorization schemes already implemented by the component.
The AuthScheme property defines the authentication scheme used. In the case of HTTP Basic Authentication (default), every time User and Password are set, they are Base64 encoded, and the result is put in the Authorization property in the form "Basic [encoded-user-password]".
The default value is False.
If this property is set to 2 (Same Scheme), the new URL is retrieved automatically only if the URL Scheme is the same; otherwise, the component raises an exception.
Note: Following the HTTP specification, unless this option is set to 1 (Always), automatic redirects will be performed only for GET or HEAD requests. Other methods potentially could change the conditions of the initial request and create security vulnerabilities.
Furthermore, if either the new URL server or port are different from the existing one, User and Password are also reset to empty, unless this property is set to 1 (Always), in which case the same credentials are used to connect to the new server.
A Redirect event is fired for every URL the product is redirected to. In the case of automatic redirections, the Redirect event is a good place to set properties related to the new connection (e.g., new authentication parameters).
The default value is 0 (Never). In this case, redirects are never followed, and the component raises an exception instead.
Following are the valid options:
- 0 - Never
- 1 - Always
- 2 - Same Scheme
- "1.0"
- "1.1" (default)
- "2.0"
- "3.0"
When using HTTP/2 ("2.0"), additional restrictions apply. Please see the following notes for details.
HTTP/2 Notes
When using HTTP/2, a secure Secure Sockets Layer/Transport Layer Security (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/2 will result in an error.
If the server does not support HTTP/2, the component will automatically use HTTP/1.1 instead. This is done to provide compatibility without the need for any additional settings. To see which version was used, check NegotiatedHTTPVersion after calling a method. The AllowHTTPFallback setting controls whether this behavior is allowed (default) or disallowed.
HTTP/3 Notes
HTTP/3 is supported only in .NET and Java.
When using HTTP/3, a secure (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/3 will result in an error.
The format of the date value for IfModifiedSince is detailed in the HTTP specs. For example:
Sat, 29 Oct 2017 19:43:31 GMT.
The default value for KeepAlive is false.
0 (None) | No events are logged. |
1 (Info - default) | Informational events are logged. |
2 (Verbose) | Detailed data are logged. |
3 (Debug) | Debug data are logged. |
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).
The headers must follow the format "header: value" as described in the HTTP specifications. Header lines should be separated by CRLF ("\r\n") .
Use this configuration setting with caution. If this configuration setting contains invalid headers, HTTP requests may fail.
This configuration setting is useful for extending the functionality of the component beyond what is provided.
.NET
Http http = new Http();
http.Config("TransferredRequest=on");
http.PostData = "body";
http.Post("http://someserver.com");
Console.WriteLine(http.Config("TransferredRequest"));
C++
HTTP http;
http.Config("TransferredRequest=on");
http.SetPostData("body", 5);
http.Post("http://someserver.com");
printf("%s\r\n", http.Config("TransferredRequest"));
Note: Some servers (such as the ASP.NET Development Server) may not support chunked encoding.
The default value is False and the hostname will always be used exactly as specified. Note: The CodePage setting must be set to a value capable of interpreting the specified host name. For instance, to specify UTF-8, set CodePage to 65001.
When True (default), the component will check for the existence of a Proxy auto-config URL, and if found, will determine the appropriate proxy to use.
Override the default with the name and version of your software.
TCPClient Config Settings
If the FirewallHost setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the FirewallHost setting is set to the corresponding address. If the search is not successful, an error is returned.
Note: This setting is provided for use by components that do not directly expose Firewall properties.
Note: This setting is provided for use by components that do not directly expose Firewall properties.
Note: This configuration setting is provided for use by components that do not directly expose Firewall properties.
0 | No firewall (default setting). |
1 | Connect through a tunneling proxy. FirewallPort is set to 80. |
2 | Connect through a SOCKS4 Proxy. FirewallPort is set to 1080. |
3 | Connect through a SOCKS5 Proxy. FirewallPort is set to 1080. |
10 | Connect through a SOCKS4A Proxy. FirewallPort is set to 1080. |
Note: This setting is provided for use by components that do not directly expose Firewall properties.
Note: This setting is provided for use by components that do not directly expose Firewall properties.
Note: This value is not applicable in macOS.
In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if LingerTime is 0 (default), the system will attempt to send pending data for a connection until the default IP timeout expires.
In the second scenario, if LingerTime is a positive value, the system will attempt to send pending data until the specified LingerTime is reached. If this attempt fails, then the system will reset the connection.
The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the component returns control immediately, the system could hold system resources until all pending data are sent (even after your application closes).
Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (e.g., by a client acknowledgment), setting this property to False might be the appropriate course of action.
In multihomed hosts (machines with more than one IP interface), setting LocalHost to the value of an interface will make the component initiate connections (or accept in the case of server components) only through that interface.
If the component is connected, the LocalHost setting shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).
Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by LocalPort after the connection is established.
LocalPort cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error.
This configuration setting is useful when trying to connect to services that require a trusted port on the client side. An example is the remote shell (rsh) service in UNIX systems.
If an EOL string is found in the input stream before MaxLineLength bytes are received, the DataIn event is fired with the EOL parameter set to True, and the buffer is reset.
If no EOL is found, and MaxLineLength bytes are accumulated in the buffer, the DataIn event is fired with the EOL parameter set to False, and the buffer is reset.
The minimum value for MaxLineLength is 256 bytes. The default value is 2048 bytes.
www.google.com;www.nsoftware.com
Note: This value is not applicable in Java.
By default, this configuration setting is set to False.
0 | IPv4 only |
1 | IPv6 only |
2 | IPv6 with IPv4 fallback |
SSL Config Settings
When enabled, SSL packet logs are output using the SSLStatus event, which will fire each time an SSL packet is sent or received.
Enabling this configuration setting has no effect if SSLProvider is set to Platform.
The path set by this property should point to a directory containing CA certificates in PEM format. The files each contain one CA certificate. The files are looked up by the CA subject name hash value, which must hence be available. If more than one CA certificate with the same name hash value exist, the extension must be different (e.g., 9d66eef0.0, 9d66eef0.1). OpenSSL recommends the use of the c_rehash utility to create the necessary links. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.
The file set by this property should contain a list of CA certificates in PEM format. The file can contain several CA certificates identified by the following sequences:
-----BEGIN CERTIFICATE-----
... (CA certificate in base64 encoding) ...
-----END CERTIFICATE-----
Before, between, and after the certificate text is allowed, which can be used, for example, for descriptions of the certificates. Refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.
The format of this string is described in the OpenSSL man page ciphers(1) section "CIPHER LIST FORMAT". Please refer to it for details. The default string "DEFAULT" is determined at compile time and is normally equivalent to "ALL:!ADH:RC4+RSA:+SSLv2:@STRENGTH".
By default, OpenSSL uses the device file "/dev/urandom" to seed the PRNG, and setting OpenSSLPrngSeedData is not required. If set, the string specified is used to seed the PRNG.
If set to True, the component will reuse the context if and only if the following criteria are met:
- The target host name is the same.
- The system cache entry has not expired (default timeout is 10 hours).
- The application process that calls the function is the same.
- The logon session is the same.
- The instance of the component is the same.
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert ... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
When set to 0 (default), the CRL check will not be performed by the component. When set to 1, it will attempt to perform the CRL check, but it will continue without an error if the server's certificate does not support CRL. When set to 2, it will perform the CRL check and will throw an error if CRL is not supported.
This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems.
When set to 0 (default), the component will not perform an OCSP check. When set to 1, it will attempt to perform the OCSP check, but it will continue without an error if the server's certificate does not support OCSP. When set to 2, it will perform the OCSP check and will throw an error if OCSP is not supported.
This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems.
Note: This configuration setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the SSLStatus event.
Use this configuration setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application.
When the provider is OpenSSL, SSLCipherStrength is currently not supported. This functionality is instead made available through the OpenSSLCipherList configuration setting.
The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert ... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
By default, the enabled cipher suites will include all available ciphers ("*").
The special value "*" means that the component will pick all of the supported cipher suites. If SSLEnabledCipherSuites is set to any other value, only the specified cipher suites will be considered.
Multiple cipher suites are separated by semicolons.
Example values when SSLProvider is set to Platform include the following:
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=CALG_AES_256");
obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES");
Possible values when SSLProvider is set to Platform include the following:
- CALG_3DES
- CALG_3DES_112
- CALG_AES
- CALG_AES_128
- CALG_AES_192
- CALG_AES_256
- CALG_AGREEDKEY_ANY
- CALG_CYLINK_MEK
- CALG_DES
- CALG_DESX
- CALG_DH_EPHEM
- CALG_DH_SF
- CALG_DSS_SIGN
- CALG_ECDH
- CALG_ECDH_EPHEM
- CALG_ECDSA
- CALG_ECMQV
- CALG_HASH_REPLACE_OWF
- CALG_HUGHES_MD5
- CALG_HMAC
- CALG_KEA_KEYX
- CALG_MAC
- CALG_MD2
- CALG_MD4
- CALG_MD5
- CALG_NO_SIGN
- CALG_OID_INFO_CNG_ONLY
- CALG_OID_INFO_PARAMETERS
- CALG_PCT1_MASTER
- CALG_RC2
- CALG_RC4
- CALG_RC5
- CALG_RSA_KEYX
- CALG_RSA_SIGN
- CALG_SCHANNEL_ENC_KEY
- CALG_SCHANNEL_MAC_KEY
- CALG_SCHANNEL_MASTER_HASH
- CALG_SEAL
- CALG_SHA
- CALG_SHA1
- CALG_SHA_256
- CALG_SHA_384
- CALG_SHA_512
- CALG_SKIPJACK
- CALG_SSL2_MASTER
- CALG_SSL3_MASTER
- CALG_SSL3_SHAMD5
- CALG_TEK
- CALG_TLS1_MASTER
- CALG_TLS1PRF
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_ECDH_RSA_WITH_AES_128_CBC_SHA");
Possible values when SSLProvider is set to Internal include the following:
- TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
- TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
- TLS_RSA_WITH_AES_256_GCM_SHA384
- TLS_RSA_WITH_AES_128_GCM_SHA256
- TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_DSS_WITH_AES_256_GCM_SHA384
- TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_DSS_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
- TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
- TLS_DHE_DSS_WITH_AES_256_CBC_SHA256
- TLS_RSA_WITH_AES_256_CBC_SHA256
- TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
- TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
- TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
- TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
- TLS_RSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
- TLS_DHE_DSS_WITH_AES_128_CBC_SHA256
- TLS_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
- TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
- TLS_DHE_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
- TLS_DHE_DSS_WITH_AES_256_CBC_SHA
- TLS_RSA_WITH_AES_128_CBC_SHA
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
- TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
- TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
- TLS_DHE_RSA_WITH_AES_128_CBC_SHA
- TLS_DHE_DSS_WITH_AES_128_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA
- TLS_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_RSA_WITH_DES_CBC_SHA
- TLS_DHE_RSA_WITH_DES_CBC_SHA
- TLS_DHE_DSS_WITH_DES_CBC_SHA
- TLS_RSA_WITH_RC4_128_MD5
- TLS_RSA_WITH_RC4_128_SHA
When TLS 1.3 is negotiated (see SSLEnabledProtocols), only the following cipher suites are supported:
- TLS_AES_256_GCM_SHA384
- TLS_CHACHA20_POLY1305_SHA256
- TLS_AES_128_GCM_SHA256
SSLEnabledCipherSuites is used together with SSLCipherStrength.
Not all supported protocols are enabled by default. The default value is 4032 for client components, and 3072 for server components. To specify a combination of enabled protocol versions set this config to the binary OR of one or more of the following values:
TLS1.3 | 12288 (Hex 3000) |
TLS1.2 | 3072 (Hex C00) (Default - Client and Server) |
TLS1.1 | 768 (Hex 300) (Default - Client) |
TLS1 | 192 (Hex C0) (Default - Client) |
SSL3 | 48 (Hex 30) |
SSL2 | 12 (Hex 0C) |
Note that only TLS 1.2 is enabled for server components that accept incoming connections. This adheres to industry standards to ensure a secure connection. Client components enable TLS 1.0, TLS 1.1, and TLS 1.2 by default and will negotiate the highest mutually supported version when connecting to a server, which should be TLS 1.2 in most cases.
SSLEnabledProtocols: Transport Layer Security (TLS) 1.3 Notes:
By default when TLS 1.3 is enabled, the component will use the internal TLS implementation when the SSLProvider is set to Automatic for all editions.
In editions that are designed to run on Windows, SSLProvider can be set to Platform to use the platform implementation instead of the internal implementation. When configured in this manner, please note that the platform provider is supported only on Windows 11/Windows Server 2022 and up. The default internal provider is available on all platforms and is not restricted to any specific OS version.
If set to 1 (Platform provider), please be aware of the following notes:
- The platform provider is available only on Windows 11/Windows Server 2022 and up.
- SSLEnabledCipherSuites and other similar SSL configuration settings are not supported.
- If SSLEnabledProtocols includes both TLS 1.3 and TLS 1.2, these restrictions are still applicable even if TLS 1.2 is negotiated. Enabling TLS 1.3 with the platform provider changes the implementation used for all TLS versions.
SSLEnabledProtocols: SSL2 and SSL3 Notes:
SSL 2.0 and 3.0 are not supported by the component when the SSLProvider is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and SSLProvider needs to be set to platform.
This configuration setting is applicable only when SSLProvider is set to Internal.
If set to True, all certificates returned by the server will be present in the Encoded parameter of the SSLServerAuthentication event. This includes the leaf certificate, any intermediate certificate, and the root certificate.
When set, the component will save the session secrets in the same format as the SSLKEYLOGFILE environment variable functionality used by most major browsers and tools, such as Chrome, Firefox, and cURL. This file can then be used in tools such as Wireshark to decrypt TLS traffic for debugging purposes. When writing to this file, the component will only append, it will not overwrite previous values.
Note: This configuration setting is applicable only when SSLProvider is set to Internal.
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipher[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherStrength[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherSuite[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchange[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchangeStrength[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedVersion[connId]");
0x00000001 | Ignore time validity status of certificate. |
0x00000002 | Ignore time validity status of CTL. |
0x00000004 | Ignore non-nested certificate times. |
0x00000010 | Allow unknown certificate authority. |
0x00000020 | Ignore wrong certificate usage. |
0x00000100 | Ignore unknown certificate revocation status. |
0x00000200 | Ignore unknown CTL signer revocation status. |
0x00000400 | Ignore unknown certificate authority revocation status. |
0x00000800 | Ignore unknown root revocation status. |
0x00008000 | Allow test root certificate. |
0x00004000 | Trust test root certificate. |
0x80000000 | Ignore non-matching CN (certificate CN non-matching server name). |
This functionality is currently not available when the provider is OpenSSL.
The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
When specified the component will verify that the server certificate signature algorithm is among the values specified in this configuration setting. If the server certificate signature algorithm is unsupported, the component raises an exception.
The format of this value is a comma-separated list of hash-signature combinations. For instance:
component.SSLProvider = TCPClientSSLProviders.sslpInternal;
component.Config("SSLEnabledProtocols=3072"); //TLS 1.2
component.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa");
The default value for this configuration setting is sha512-ecdsa,sha512-rsa,sha512-dsa,sha384-ecdsa,sha384-rsa,sha384-dsa,sha256-ecdsa,sha256-rsa,sha256-dsa,sha224-ecdsa,sha224-rsa,sha224-dsa,sha1-ecdsa,sha1-rsa,sha1-dsa.
To not restrict the server's certificate signature algorithm, specify an empty string as the value for this configuration setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent.
The default value is ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1.
When using TLS 1.2 and SSLProvider is set to Internal, the values refer to the supported groups for ECC. The following values are supported:
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1" (default)
The default value is set to balance common supported groups and the computational resources required to generate key shares. As a result, only some groups are included by default in this configuration setting.
Note: All supported groups can always be used during the handshake even if not listed here, but if a group is used that is not present in this list, it will incur an additional roundtrip and time to generate the key share for that group.
In most cases, this configuration setting does not need to be modified. This should be modified only if there is a specific reason to do so.
The default value is ecdhe_x25519,ecdhe_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072
The values are ordered from most preferred to least preferred. The following values are supported:
- "ecdhe_x25519" (default)
- "ecdhe_x448"
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1"
- "ffdhe_2048" (default)
- "ffdhe_3072" (default)
- "ffdhe_4096"
- "ffdhe_6144"
- "ffdhe_8192"
- "ed25519" (default)
- "ed448" (default)
- "ecdsa_secp256r1_sha256" (default)
- "ecdsa_secp384r1_sha384" (default)
- "ecdsa_secp521r1_sha512" (default)
- "rsa_pkcs1_sha256" (default)
- "rsa_pkcs1_sha384" (default)
- "rsa_pkcs1_sha512" (default)
- "rsa_pss_sha256" (default)
- "rsa_pss_sha384" (default)
- "rsa_pss_sha512" (default)
The default value is ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192
The values are ordered from most preferred to least preferred. The following values are supported:
- "ecdhe_x25519" (default)
- "ecdhe_x448" (default)
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1" (default)
- "ffdhe_2048" (default)
- "ffdhe_3072" (default)
- "ffdhe_4096" (default)
- "ffdhe_6144" (default)
- "ffdhe_8192" (default)
Socket Config Settings
Note: This option is not valid for User Datagram Protocol (UDP) ports.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the component is activated the InBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the component is activated the OutBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.
Base Config Settings
The following is a list of valid code page identifiers:
Identifier | Name |
037 | IBM EBCDIC - U.S./Canada |
437 | OEM - United States |
500 | IBM EBCDIC - International |
708 | Arabic - ASMO 708 |
709 | Arabic - ASMO 449+, BCON V4 |
710 | Arabic - Transparent Arabic |
720 | Arabic - Transparent ASMO |
737 | OEM - Greek (formerly 437G) |
775 | OEM - Baltic |
850 | OEM - Multilingual Latin I |
852 | OEM - Latin II |
855 | OEM - Cyrillic (primarily Russian) |
857 | OEM - Turkish |
858 | OEM - Multilingual Latin I + Euro symbol |
860 | OEM - Portuguese |
861 | OEM - Icelandic |
862 | OEM - Hebrew |
863 | OEM - Canadian-French |
864 | OEM - Arabic |
865 | OEM - Nordic |
866 | OEM - Russian |
869 | OEM - Modern Greek |
870 | IBM EBCDIC - Multilingual/ROECE (Latin-2) |
874 | ANSI/OEM - Thai (same as 28605, ISO 8859-15) |
875 | IBM EBCDIC - Modern Greek |
932 | ANSI/OEM - Japanese, Shift-JIS |
936 | ANSI/OEM - Simplified Chinese (PRC, Singapore) |
949 | ANSI/OEM - Korean (Unified Hangul Code) |
950 | ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) |
1026 | IBM EBCDIC - Turkish (Latin-5) |
1047 | IBM EBCDIC - Latin 1/Open System |
1140 | IBM EBCDIC - U.S./Canada (037 + Euro symbol) |
1141 | IBM EBCDIC - Germany (20273 + Euro symbol) |
1142 | IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) |
1143 | IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) |
1144 | IBM EBCDIC - Italy (20280 + Euro symbol) |
1145 | IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) |
1146 | IBM EBCDIC - United Kingdom (20285 + Euro symbol) |
1147 | IBM EBCDIC - France (20297 + Euro symbol) |
1148 | IBM EBCDIC - International (500 + Euro symbol) |
1149 | IBM EBCDIC - Icelandic (20871 + Euro symbol) |
1200 | Unicode UCS-2 Little-Endian (BMP of ISO 10646) |
1201 | Unicode UCS-2 Big-Endian |
1250 | ANSI - Central European |
1251 | ANSI - Cyrillic |
1252 | ANSI - Latin I |
1253 | ANSI - Greek |
1254 | ANSI - Turkish |
1255 | ANSI - Hebrew |
1256 | ANSI - Arabic |
1257 | ANSI - Baltic |
1258 | ANSI/OEM - Vietnamese |
1361 | Korean (Johab) |
10000 | MAC - Roman |
10001 | MAC - Japanese |
10002 | MAC - Traditional Chinese (Big5) |
10003 | MAC - Korean |
10004 | MAC - Arabic |
10005 | MAC - Hebrew |
10006 | MAC - Greek I |
10007 | MAC - Cyrillic |
10008 | MAC - Simplified Chinese (GB 2312) |
10010 | MAC - Romania |
10017 | MAC - Ukraine |
10021 | MAC - Thai |
10029 | MAC - Latin II |
10079 | MAC - Icelandic |
10081 | MAC - Turkish |
10082 | MAC - Croatia |
12000 | Unicode UCS-4 Little-Endian |
12001 | Unicode UCS-4 Big-Endian |
20000 | CNS - Taiwan |
20001 | TCA - Taiwan |
20002 | Eten - Taiwan |
20003 | IBM5550 - Taiwan |
20004 | TeleText - Taiwan |
20005 | Wang - Taiwan |
20105 | IA5 IRV International Alphabet No. 5 (7-bit) |
20106 | IA5 German (7-bit) |
20107 | IA5 Swedish (7-bit) |
20108 | IA5 Norwegian (7-bit) |
20127 | US-ASCII (7-bit) |
20261 | T.61 |
20269 | ISO 6937 Non-Spacing Accent |
20273 | IBM EBCDIC - Germany |
20277 | IBM EBCDIC - Denmark/Norway |
20278 | IBM EBCDIC - Finland/Sweden |
20280 | IBM EBCDIC - Italy |
20284 | IBM EBCDIC - Latin America/Spain |
20285 | IBM EBCDIC - United Kingdom |
20290 | IBM EBCDIC - Japanese Katakana Extended |
20297 | IBM EBCDIC - France |
20420 | IBM EBCDIC - Arabic |
20423 | IBM EBCDIC - Greek |
20424 | IBM EBCDIC - Hebrew |
20833 | IBM EBCDIC - Korean Extended |
20838 | IBM EBCDIC - Thai |
20866 | Russian - KOI8-R |
20871 | IBM EBCDIC - Icelandic |
20880 | IBM EBCDIC - Cyrillic (Russian) |
20905 | IBM EBCDIC - Turkish |
20924 | IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) |
20932 | JIS X 0208-1990 & 0121-1990 |
20936 | Simplified Chinese (GB2312) |
21025 | IBM EBCDIC - Cyrillic (Serbian, Bulgarian) |
21027 | Extended Alpha Lowercase |
21866 | Ukrainian (KOI8-U) |
28591 | ISO 8859-1 Latin I |
28592 | ISO 8859-2 Central Europe |
28593 | ISO 8859-3 Latin 3 |
28594 | ISO 8859-4 Baltic |
28595 | ISO 8859-5 Cyrillic |
28596 | ISO 8859-6 Arabic |
28597 | ISO 8859-7 Greek |
28598 | ISO 8859-8 Hebrew |
28599 | ISO 8859-9 Latin 5 |
28605 | ISO 8859-15 Latin 9 |
29001 | Europa 3 |
38598 | ISO 8859-8 Hebrew |
50220 | ISO 2022 Japanese with no halfwidth Katakana |
50221 | ISO 2022 Japanese with halfwidth Katakana |
50222 | ISO 2022 Japanese JIS X 0201-1989 |
50225 | ISO 2022 Korean |
50227 | ISO 2022 Simplified Chinese |
50229 | ISO 2022 Traditional Chinese |
50930 | Japanese (Katakana) Extended |
50931 | US/Canada and Japanese |
50933 | Korean Extended and Korean |
50935 | Simplified Chinese Extended and Simplified Chinese |
50936 | Simplified Chinese |
50937 | US/Canada and Traditional Chinese |
50939 | Japanese (Latin) Extended and Japanese |
51932 | EUC - Japanese |
51936 | EUC - Simplified Chinese |
51949 | EUC - Korean |
51950 | EUC - Traditional Chinese |
52936 | HZ-GB2312 Simplified Chinese |
54936 | Windows XP: GB18030 Simplified Chinese (4 Byte) |
57002 | ISCII Devanagari |
57003 | ISCII Bengali |
57004 | ISCII Tamil |
57005 | ISCII Telugu |
57006 | ISCII Assamese |
57007 | ISCII Oriya |
57008 | ISCII Kannada |
57009 | ISCII Malayalam |
57010 | ISCII Gujarati |
57011 | ISCII Punjabi |
65000 | Unicode UTF-7 |
65001 | Unicode UTF-8 |
Identifier | Name |
1 | ASCII |
2 | NEXTSTEP |
3 | JapaneseEUC |
4 | UTF8 |
5 | ISOLatin1 |
6 | Symbol |
7 | NonLossyASCII |
8 | ShiftJIS |
9 | ISOLatin2 |
10 | Unicode |
11 | WindowsCP1251 |
12 | WindowsCP1252 |
13 | WindowsCP1253 |
14 | WindowsCP1254 |
15 | WindowsCP1250 |
21 | ISO2022JP |
30 | MacOSRoman |
10 | UTF16String |
0x90000100 | UTF16BigEndian |
0x94000100 | UTF16LittleEndian |
0x8c000100 | UTF32String |
0x98000100 | UTF32BigEndian |
0x9c000100 | UTF32LittleEndian |
65536 | Proprietary |
- Product: The product the license is for.
- Product Key: The key the license was generated from.
- License Source: Where the license was found (e.g., RuntimeLicense, License File).
- License Type: The type of license installed (e.g., Royalty Free, Single Server).
- Last Valid Build: The last valid build number for which the license will work.
This setting only works on these components: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.
FIPS mode can be enabled by setting the UseFIPSCompliantAPI configuration setting to true. This is a static setting that applies to all instances of all components of the toolkit within the process. It is recommended to enable or disable this setting once before the component has been used to establish a connection. Enabling FIPS while an instance of the component is active and connected may result in unexpected behavior.
For more details, please see the FIPS 140-2 Compliance article.
Note: This setting is applicable only on Windows.
Note: Enabling FIPS compliance requires a special license; please contact sales@nsoftware.com for details.
Setting this configuration setting to true tells the component to use the internal implementation instead of using the system security libraries.
This setting is set to false by default on all platforms.
Trappable Errors (Office365Tasks Component)
Office365Tasks Errors
1301 | Invalid Input Error. |