Office365Calendars Class

Properties   Methods   Events   Config Settings   Errors  

The Office365Calendars class provides an easy way to manage calendars in Microsoft 365. The class includes support for creating, listing and managing both calendars and events.

Class Name

CloudCalendars_Office365Calendars

Procedural Interface

 cloudcalendars_office365calendars_open();
 cloudcalendars_office365calendars_close($res);
 cloudcalendars_office365calendars_register_callback($res, $id, $function);
 cloudcalendars_office365calendars_get_last_error($res);
 cloudcalendars_office365calendars_get_last_error_code($res);
 cloudcalendars_office365calendars_set($res, $id, $index, $value);
 cloudcalendars_office365calendars_get($res, $id, $index);
 cloudcalendars_office365calendars_do_addattachment($res, $eventid, $name, $localfile);
 cloudcalendars_office365calendars_do_authorize($res);
 cloudcalendars_office365calendars_do_config($res, $configurationstring);
 cloudcalendars_office365calendars_do_createcalendar($res, $name);
 cloudcalendars_office365calendars_do_createevent($res, $subject, $starttime, $endtime, $calendarid);
 cloudcalendars_office365calendars_do_deleteattachment($res, $id, $attachmentid);
 cloudcalendars_office365calendars_do_deletecalendar($res, $id);
 cloudcalendars_office365calendars_do_deleteevent($res, $id);
 cloudcalendars_office365calendars_do_getcalendarview($res, $calendarid, $starttime, $endtime);
 cloudcalendars_office365calendars_do_getevent($res, $id);
 cloudcalendars_office365calendars_do_geteventfield($res, $index, $jsonpath);
 cloudcalendars_office365calendars_do_interrupt($res);
 cloudcalendars_office365calendars_do_listattachments($res, $id);
 cloudcalendars_office365calendars_do_listcalendars($res);
 cloudcalendars_office365calendars_do_listevents($res, $calendarid);
 cloudcalendars_office365calendars_do_reset($res);
 cloudcalendars_office365calendars_do_retrieveattachment($res, $id, $attachmentid);
 cloudcalendars_office365calendars_do_sendcustomrequest($res, $httpmethod, $url, $postdata);
 cloudcalendars_office365calendars_do_seteventfield($res, $index, $jsonpath, $value, $valuetype);
 cloudcalendars_office365calendars_do_updatecalendar($res, $index);
 cloudcalendars_office365calendars_do_updateevent($res, $index);

Remarks

This class provides an easy to use interface for Microsoft Office365 Calendars. To use the class, first set the Authorization property to a valid OAuth token. The Office365Calendars class can be used for creating new calendars, retrieving, deleting and updating existing ones; and several other functionalities supported by the Office365 API.

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

The class has the following defaults:

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

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

Application Profile

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

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

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

Authorization Code

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

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

Client Credentials

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

Implicit

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

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

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

Password

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

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

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

Web Profile

External OAuth Support

Bearer ACCESS_TOKEN_VALUE

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

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

Creating a Calendar

To create a calendar using the Office365Calendars components we make use of the CreateCalendar method. The CreateCalendar method will create a new calendar with a name specified through the Name parameter.

Creating a calendar: office365.CreateCalendar("My Calendar");

After creating a calendar, select the calendar to be edited in the Calendars collection, edit its fields and make a call to the UpdateCalendar method. To edit the newly created calendar select the first calendar in the collection.

Example (Update The First Calendar Of The Collection) // Set properties to update office365.Calendars[0].Color = TOfficeColors.occLightGreen; office365.Calendars[0].Name = "new name"; office365.UpdateCalendar(0);

Listing Calendars

Information about calendars fetched by the component can be accessed through the Calendars properties. The Calendars properties is populated when the ListCalendars method is called.

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

Creating Events

To create a new event use the CreateEvent method. The newly created event is added at the beginning of the Events properties.

Example (Create a new event in a specific calendar)

office365.CreateEvent("My event", "2024-11-08T16:00:00", "2024-11-08T17:00:00", office365.Calendars[0].Id); // The ID of the calendar to which the event will belong to

After creating an event with the basic information, select the event to be edited in the Events collection, edit its fields and make a call to the UpdateEvent method. To edit the newly created event select the first event in the collection.

Example (Update The First Event Of The List) // Set properties to update office365.Events[0].Subject = "new event name"; office365.Events[0].AttendeesCount = 2; office365.Events[0].AttendeeIndex = 0; office365.Events[0].AttendeeEmail = "person1@example.com"; office365.Events[0].AttendeeStatusResponse = TOCAttendeeStatusResponses.oasrAccepted; office365.Events[0].AttendeeType = TOCAttendeeTypes.ocatOptional; office365.Events[0].AttendeeIndex = 1; office365.Events[0].AttendeeEmail = "person2@example.com"; office365.Events[0].AttendeeStatusResponse = TOCAttendeeStatusResponses.oasrAccepted; office365.Events[0].AttendeeType = TOCAttendeeTypes.ocatRequired; // Set a reminder 15 minutes before office365.Events[0].IsReminderOn = true; office365.Events[0].ReminderMinutesBeforeStart = 15; office365.UpdateEvent(0);

Listing Events

Information about events fetched by the component can be accessed through the Events properties. The Events properties is populated when the ListEvents method is called.

By default, the component will fetch one page of 100 events when ListEvents is called. If additional events remain, the ListEventsMarker property will be populated, it contains the nextPageToken that will be included in the next request as a parameter if ListEvents is then called again on the same calendar, if called the next page of events will be fetched. The example below populates the Events properties with all the events associated with the specified calendar. do { office365.ListEvents(office365.Calendars[0].Id); } while (office365.ListEventsMarker.Length > 0);

Retrieving an Event

To retrieve an event use the GetEvent method and provide the Id of the event. The event is added to the end of the Events collection.

Example (Retrieve an Event)

// Retrieve an event by its ID string eventId = "12345"; // Replace with the actual event ID gcal.GetEvent(eventId); // Access the retrieved event var retrievedEvent = office365.Events[office365.Events.Count - 1]; retrievedEvent.Subject; //event subject retrievedEvent.StartDateTime; //start dateTime of event retrievedEvent.AttendeeStatusResponse; //attendee status response gcal.GetEventField(gcal.Events.Count - 1, "/json/subject"); //event name gcal.GetEventField(gcal.Events.Count - 1, "/json/isCancelled"); //if the event is cancelled

Deleting an Event

To delete an event use the DeleteEvent method, provide the Id of the event and the Id of the calendar as the argument. The event will stay in the Events collection until ListEvents method is called again.

Example (Delete Events

// List events and delete the event named "new event name" office365.ListEvents(office365.Calendars[0].Id); for (int i = 0; i < office365.Events.Count; i++) { if (office365.Events[i].Subject == "new event name") { office365.DeleteEvent(office365.Calendars[0].Id, office365.Events[i].Id); break; } // Note: the component would let you name more than one event with the same name so the example would delete the first encounter with the event that has the specified name }

Property List

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

Method List

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

Event List

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

Config Settings

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

AttachmentsCount Property (CloudCalendars_Office365Calendars Class)

The number of records in the Attachment arrays.

Object Oriented Interface

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

Procedural Interface

cloudcalendars_office365calendars_get($res, 1 );
cloudcalendars_office365calendars_set($res, 1, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• AttachmentContentType
• AttachmentData
• AttachmentEventId
• AttachmentFileName
• AttachmentId
• AttachmentIsInline
• AttachmentJSON
• AttachmentLastModifiedDate
• AttachmentName
• AttachmentSize

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

This property is not available at design time.

Data Type

Integer

AttachmentContentType Property (CloudCalendars_Office365Calendars Class)

This property contains the content type of the attachment.

Object Oriented Interface

public function getAttachmentContentType($attachmentindex);

Procedural Interface

cloudcalendars_office365calendars_get($res, 2 , $attachmentindex);

Default Value

''

Remarks

This field contains the content type of the attachment.

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

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

Data Type

String

AttachmentData Property (CloudCalendars_Office365Calendars Class)

This property contains the raw data of the attachment.

Object Oriented Interface

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

Procedural Interface

cloudcalendars_office365calendars_get($res, 3 , $attachmentindex);
cloudcalendars_office365calendars_set($res, 3, $value , $attachmentindex);

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

AttachmentEventId Property (CloudCalendars_Office365Calendars Class)

This property contains the event identifier of the attachment.

Object Oriented Interface

public function getAttachmentEventId($attachmentindex);

Procedural Interface

cloudcalendars_office365calendars_get($res, 4 , $attachmentindex);

Default Value

''

Remarks

This field contains the event 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

AttachmentFileName Property (CloudCalendars_Office365Calendars Class)

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

Object Oriented Interface

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

Procedural Interface

cloudcalendars_office365calendars_get($res, 5 , $attachmentindex);
cloudcalendars_office365calendars_set($res, 5, $value , $attachmentindex);

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

String

AttachmentId Property (CloudCalendars_Office365Calendars Class)

This property contains the attachment identifier of the attachment.

Object Oriented Interface

public function getAttachmentId($attachmentindex);

Procedural Interface

cloudcalendars_office365calendars_get($res, 6 , $attachmentindex);

Default Value

''

Remarks

This field contains the attachment identifier of the attachment.

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

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

Data Type

String

AttachmentIsInline Property (CloudCalendars_Office365Calendars Class)

This property is true if the attachment is an inline attachment.

Object Oriented Interface

public function getAttachmentIsInline($attachmentindex);
public function setAttachmentIsInline($attachmentindex, $value);

Procedural Interface

cloudcalendars_office365calendars_get($res, 8 , $attachmentindex);
cloudcalendars_office365calendars_set($res, 8, $value , $attachmentindex);

Default Value

false

Remarks

This field is true if the attachment is an inline 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

Boolean

AttachmentJSON Property (CloudCalendars_Office365Calendars Class)

A JSON representation of the attachment.

Object Oriented Interface

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

Procedural Interface

cloudcalendars_office365calendars_get($res, 9 , $attachmentindex);
cloudcalendars_office365calendars_set($res, 9, $value , $attachmentindex);

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

String

AttachmentLastModifiedDate Property (CloudCalendars_Office365Calendars Class)

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

Object Oriented Interface

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

Procedural Interface

cloudcalendars_office365calendars_get($res, 10 , $attachmentindex);
cloudcalendars_office365calendars_set($res, 10, $value , $attachmentindex);

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

String

AttachmentName Property (CloudCalendars_Office365Calendars Class)

This property contains the name of the attachment.

Object Oriented Interface

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

Procedural Interface

cloudcalendars_office365calendars_get($res, 11 , $attachmentindex);
cloudcalendars_office365calendars_set($res, 11, $value , $attachmentindex);

Default Value

''

Remarks

This field contains the name of the attachment.

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

This property is not available at design time.

Data Type

String

AttachmentSize Property (CloudCalendars_Office365Calendars Class)

This property contains the size in bytes of the attachment.

Object Oriented Interface

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

Procedural Interface

cloudcalendars_office365calendars_get($res, 12 , $attachmentindex);
cloudcalendars_office365calendars_set($res, 12, $value , $attachmentindex);

Default Value

0

Remarks

This field contains the size in bytes of the attachment.

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

This property is not available at design time.

Data Type

Integer

Authorization Property (CloudCalendars_Office365Calendars Class)

An OAuth Authorization String.

Object Oriented Interface

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

Procedural Interface

cloudcalendars_office365calendars_get($res, 13 );
cloudcalendars_office365calendars_set($res, 13, $value );

Default Value

''

Remarks

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

Example

Oauth oauth = new Oauth(); oauth.ClientId = "YourClientId"; oauth.ClientSecret = "YourClientSecret"; oauth.ServerAuthURL = "https://login.microsoftonline.com/common/oauth2/v2.0/authorize"; oauth.ServerTokenURL = "https://login.microsoftonline.com/common/oauth2/v2.0/token"; oauth.AuthorizationScope = "offline_access user.read Calendars.Read Calendars.ReadWrite"; oauth.ClientProfile = OAuthClientProfiles.ocpApplication; oauth.GrantType = OauthGrantTypes.ogtAuthorizationCode; office365calendar.Authorization = oauth.GetAuthorization();

This property is not available at design time.

Data Type

String

CalendarsCount Property (CloudCalendars_Office365Calendars Class)

The number of records in the Calendar arrays.

Object Oriented Interface

public function getCalendarsCount();
public function setCalendarsCount($value);

Procedural Interface

cloudcalendars_office365calendars_get($res, 14 );
cloudcalendars_office365calendars_set($res, 14, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• CalendarCanEdit
• CalendarCanShare
• CalendarCanViewPrivateItems
• CalendarChangeKey
• CalendarColor
• CalendarHexColor
• CalendarId
• CalendarIsDefaultCalendar
• CalendarIsRemovable
• CalendarName
• CalendarOwner

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

This property is not available at design time.

Data Type

Integer

CalendarCanEdit Property (CloudCalendars_Office365Calendars Class)

true if the user can write to the calendar, false otherwise.

Object Oriented Interface

public function getCalendarCanEdit($calendarindex);

Procedural Interface

cloudcalendars_office365calendars_get($res, 15 , $calendarindex);

Default Value

false

Remarks

true if the user can write to the calendar, false otherwise.

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

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

Data Type

Boolean

CalendarCanShare Property (CloudCalendars_Office365Calendars Class)

true if the user has the permission to share the calendar, false otherwise.

Object Oriented Interface

public function getCalendarCanShare($calendarindex);

Procedural Interface

cloudcalendars_office365calendars_get($res, 16 , $calendarindex);

Default Value

false

Remarks

true if the user has the permission to share the calendar, false otherwise.

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

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

Data Type

Boolean

CalendarCanViewPrivateItems Property (CloudCalendars_Office365Calendars Class)

true if the user can read calendar items that have been marked private, false otherwise.

Object Oriented Interface

public function getCalendarCanViewPrivateItems($calendarindex);

Procedural Interface

cloudcalendars_office365calendars_get($res, 17 , $calendarindex);

Default Value

false

Remarks

true if the user can read calendar items that have been marked private, false otherwise.

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

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

Data Type

Boolean

CalendarChangeKey Property (CloudCalendars_Office365Calendars Class)

Identifies the version of the calendar object.

Object Oriented Interface

public function getCalendarChangeKey($calendarindex);

Procedural Interface

cloudcalendars_office365calendars_get($res, 18 , $calendarindex);

Default Value

''

Remarks

Identifies the version of the calendar object.

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

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

Data Type

String

CalendarColor Property (CloudCalendars_Office365Calendars Class)

Specifies the color theme to distinguish the calendar from other calendars in a UI.

Object Oriented Interface

public function getCalendarColor($calendarindex);
public function setCalendarColor($calendarindex, $value);

Procedural Interface

cloudcalendars_office365calendars_get($res, 19 , $calendarindex);
cloudcalendars_office365calendars_set($res, 19, $value , $calendarindex);

Default Value

0

Remarks

Specifies the color theme to distinguish the calendar from other calendars in a UI.

Possible values are:

• 0 (occAuto)
• 1 (occLightBlue)
• 2 (occLightGreen)
• 3 (occLightOrange)
• 4 (occLightGray)
• 5 (occLightYellow)
• 6 (occLightTeal)
• 7 (occLightPink)
• 8 (occLightBrown)
• 9 (occLightRed)
• 10 (occMaxColor)

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

This property is not available at design time.

Data Type

Integer

CalendarHexColor Property (CloudCalendars_Office365Calendars Class)

The calendar color, expressed in a hex color code.

Object Oriented Interface

public function getCalendarHexColor($calendarindex);

Procedural Interface

cloudcalendars_office365calendars_get($res, 20 , $calendarindex);

Default Value

''

Remarks

The calendar color, expressed in a hex color code.

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

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

Data Type

String

CalendarId Property (CloudCalendars_Office365Calendars Class)

The unique identifier of the calendar.

Object Oriented Interface

public function getCalendarId($calendarindex);

Procedural Interface

cloudcalendars_office365calendars_get($res, 21 , $calendarindex);

Default Value

''

Remarks

The unique identifier of the calendar.

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

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

Data Type

String

CalendarIsDefaultCalendar Property (CloudCalendars_Office365Calendars Class)

True if this is the default calendar where new events are created by default, false otherwise.

Object Oriented Interface

public function getCalendarIsDefaultCalendar($calendarindex);

Procedural Interface

cloudcalendars_office365calendars_get($res, 22 , $calendarindex);

Default Value

false

Remarks

True if this is the default calendar where new events are created by default, false otherwise.

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

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

Data Type

Boolean

CalendarIsRemovable Property (CloudCalendars_Office365Calendars Class)

Indicates whether this user calendar can be deleted from the user mailbox.

Object Oriented Interface

public function getCalendarIsRemovable($calendarindex);

Procedural Interface

cloudcalendars_office365calendars_get($res, 23 , $calendarindex);

Default Value

false

Remarks

Indicates whether this user calendar can be deleted from the user mailbox.

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

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

Data Type

Boolean

CalendarName Property (CloudCalendars_Office365Calendars Class)

the calendar's name.

Object Oriented Interface

public function getCalendarName($calendarindex);
public function setCalendarName($calendarindex, $value);

Procedural Interface

cloudcalendars_office365calendars_get($res, 24 , $calendarindex);
cloudcalendars_office365calendars_set($res, 24, $value , $calendarindex);

Default Value

''

Remarks

the calendar's name

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

This property is not available at design time.

Data Type

String

CalendarOwner Property (CloudCalendars_Office365Calendars Class)

If set, this represents the user who created or added the calendar.

Object Oriented Interface

public function getCalendarOwner($calendarindex);

Procedural Interface

cloudcalendars_office365calendars_get($res, 25 , $calendarindex);

Default Value

''

Remarks

If set, this represents the user who created or added the calendar. For a calendar that the user created or added, the owner property is set to the user. For a calendar shared with the user, the owner property is set to the person who shared that calendar with the user.

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

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

Data Type

String

EventsCount Property (CloudCalendars_Office365Calendars Class)

The number of records in the Event arrays.

Object Oriented Interface

public function getEventsCount();
public function setEventsCount($value);

Procedural Interface

cloudcalendars_office365calendars_get($res, 26 );
cloudcalendars_office365calendars_set($res, 26, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• EventAttendeeEmail
• EventAttendeeIndex
• EventAttendeeNewTimeEnd
• EventAttendeeNewTimeEndTimeZone
• EventAttendeeNewTimeStart
• EventAttendeeNewTimeStartTimeZone
• EventAttendeesCount
• EventAttendeeStatusResponse
• EventAttendeeStatusTime
• EventAttendeeType
• EventBody
• EventBodyIsHTML
• EventBodyPreview
• EventCalendarId
• EventCategories
• EventChangeKey
• EventCreatedDateTime
• EventEndDateTime
• EventEndTimeZone
• EventEventType
• EventHasAttachments
• EventId
• EventImportance
• EventIsAllDay
• EventIsCancelled
• EventIsReminderOn
• EventJSON
• EventLastModifiedDateTime
• EventOriginalEndTimeZone
• EventOriginalStartDateTime
• EventOriginalStartTimeZone
• EventRecurDayOfMonth
• EventRecurDaysOfWeek
• EventRecurEndDate
• EventRecurFirstDayOfWeek
• EventRecurIndex
• EventRecurInterval
• EventRecurMonth
• EventRecurNumberOfOccurrences
• EventRecurRangeType
• EventRecurStartDate
• EventRecurTimeZone
• EventRecurType
• EventReminderMinutesBeforeStart
• EventSensitivity
• EventSeriesMasterId
• EventShowAs
• EventStartDateTime
• EventStartTimeZone
• EventSubject

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

This property is not available at design time.

Data Type

Integer

EventAttendeeEmail Property (CloudCalendars_Office365Calendars Class)

Attendee email address.

Object Oriented Interface

public function getEventAttendeeEmail($eventindex);
public function setEventAttendeeEmail($eventindex, $value);

Procedural Interface

cloudcalendars_office365calendars_get($res, 27 , $eventindex);
cloudcalendars_office365calendars_set($res, 27, $value , $eventindex);

Default Value

''

Remarks

Attendee email address. Set to empty string or null to delete.

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

This property is not available at design time.

Data Type

String

EventAttendeeIndex Property (CloudCalendars_Office365Calendars Class)

Index of attendee to get or set its properties.

Object Oriented Interface

public function getEventAttendeeIndex($eventindex);
public function setEventAttendeeIndex($eventindex, $value);

Procedural Interface

cloudcalendars_office365calendars_get($res, 28 , $eventindex);
cloudcalendars_office365calendars_set($res, 28, $value , $eventindex);

Default Value

0

Remarks

Index of attendee to get or set its fields.

Example OCalEvent currentEvent = ocal.Events[0]; //retrieve event after creation //Set properties to update currentEvent.Subject = "Birthday party"; currentEvent.AttendeesCount = 2; //this event will have 2 attendees //Set the attendee properties for both attendees currentEvent.AttendeeIndex = 0; //set index of attendee currentEvent.AttendeeEmail = "example@example.com"; currentEvent.AttendeeIndex = 1; //set index of attendee currentEvent.AttendeeEmail = "example2@example.com";

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

This property is not available at design time.

Data Type

Integer

EventAttendeeNewTimeEnd Property (CloudCalendars_Office365Calendars Class)

Attendee's proposed new event ending time.

Object Oriented Interface

public function getEventAttendeeNewTimeEnd($eventindex);

Procedural Interface

cloudcalendars_office365calendars_get($res, 29 , $eventindex);

Default Value

''

Remarks

Attendee's proposed new event ending time.

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

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

Data Type

String

EventAttendeeNewTimeEndTimeZone Property (CloudCalendars_Office365Calendars Class)

The end time zone that was proposed by attendee.

Object Oriented Interface

public function getEventAttendeeNewTimeEndTimeZone($eventindex);

Procedural Interface

cloudcalendars_office365calendars_get($res, 30 , $eventindex);

Default Value

''

Remarks

The end time zone that was proposed by attendee. A value of tzone://Microsoft/Custom indicates that a legacy custom time zone was set in desktop Outlook.

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

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

Data Type

String

EventAttendeeNewTimeStart Property (CloudCalendars_Office365Calendars Class)

Attendee's new event starting time.

Object Oriented Interface

public function getEventAttendeeNewTimeStart($eventindex);

Procedural Interface

cloudcalendars_office365calendars_get($res, 31 , $eventindex);

Default Value

''

Remarks

Attendee's new event starting time.

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

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

Data Type

String

EventAttendeeNewTimeStartTimeZone Property (CloudCalendars_Office365Calendars Class)

The start time zone that was proposed by attendee.

Object Oriented Interface

public function getEventAttendeeNewTimeStartTimeZone($eventindex);

Procedural Interface

cloudcalendars_office365calendars_get($res, 32 , $eventindex);

Default Value

''

Remarks

The start time zone that was proposed by attendee. A value of tzone://Microsoft/Custom indicates that a legacy custom time zone was set in desktop Outlook.

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

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

Data Type

String

EventAttendeesCount Property (CloudCalendars_Office365Calendars Class)

When retrieving events, it indicates the number of attendees linked to the event.

Object Oriented Interface

public function getEventAttendeesCount($eventindex);
public function setEventAttendeesCount($eventindex, $value);

Procedural Interface

cloudcalendars_office365calendars_get($res, 33 , $eventindex);
cloudcalendars_office365calendars_set($res, 33, $value , $eventindex);

Default Value

0

Remarks

When retrieving events, it indicates the number of attendees linked to the event. When updating an event, this property is set to the number of attendees the event will have.

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

This property is not available at design time.

Data Type

Integer

EventAttendeeStatusResponse Property (CloudCalendars_Office365Calendars Class)

The attendee's response status.

Object Oriented Interface

public function getEventAttendeeStatusResponse($eventindex);
public function setEventAttendeeStatusResponse($eventindex, $value);

Procedural Interface

cloudcalendars_office365calendars_get($res, 34 , $eventindex);
cloudcalendars_office365calendars_set($res, 34, $value , $eventindex);

Default Value

0

Remarks

The attendee's response status.

Possible values are:

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

This property is not available at design time.

Data Type

Integer

EventAttendeeStatusTime Property (CloudCalendars_Office365Calendars Class)

The date and time when the response was returned.

Object Oriented Interface

public function getEventAttendeeStatusTime($eventindex);
public function setEventAttendeeStatusTime($eventindex, $value);

Procedural Interface

cloudcalendars_office365calendars_get($res, 35 , $eventindex);
cloudcalendars_office365calendars_set($res, 35, $value , $eventindex);

Default Value

''

Remarks

The date and time when the response was returned. It uses ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z

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

This property is not available at design time.

Data Type

String

EventAttendeeType Property (CloudCalendars_Office365Calendars Class)

The attendee type.

Object Oriented Interface

public function getEventAttendeeType($eventindex);
public function setEventAttendeeType($eventindex, $value);

Procedural Interface

cloudcalendars_office365calendars_get($res, 36 , $eventindex);
cloudcalendars_office365calendars_set($res, 36, $value , $eventindex);

Default Value

0

Remarks

The attendee type.

Possible values are:

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

This property is not available at design time.

Data Type

Integer

EventBody Property (CloudCalendars_Office365Calendars Class)

The body of the message associated with the event.

Object Oriented Interface

public function getEventBody($eventindex);
public function setEventBody($eventindex, $value);

Procedural Interface

cloudcalendars_office365calendars_get($res, 37 , $eventindex);
cloudcalendars_office365calendars_set($res, 37, $value , $eventindex);

Default Value

''

Remarks

The body of the message associated with the event. It can be in HTML or text format.

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

This property is not available at design time.

Data Type

String

EventBodyIsHTML Property (CloudCalendars_Office365Calendars Class)

Indicates the text format of the body is HTML.

Object Oriented Interface

public function getEventBodyIsHTML($eventindex);
public function setEventBodyIsHTML($eventindex, $value);

Procedural Interface

cloudcalendars_office365calendars_get($res, 38 , $eventindex);
cloudcalendars_office365calendars_set($res, 38, $value , $eventindex);

Default Value

false

Remarks

Indicates the text format of the body is HTML.

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

This property is not available at design time.

Data Type

Boolean

EventBodyPreview Property (CloudCalendars_Office365Calendars Class)

The preview of the message associated with the event.

Object Oriented Interface

public function getEventBodyPreview($eventindex);
public function setEventBodyPreview($eventindex, $value);

Procedural Interface

cloudcalendars_office365calendars_get($res, 39 , $eventindex);
cloudcalendars_office365calendars_set($res, 39, $value , $eventindex);

Default Value

''

Remarks

The preview of the message associated with the event. It is in text format.

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

This property is not available at design time.

Data Type

String

EventCalendarId Property (CloudCalendars_Office365Calendars Class)

The ID of the calendar that contains the event.

Object Oriented Interface

public function getEventCalendarId($eventindex);

Procedural Interface

cloudcalendars_office365calendars_get($res, 40 , $eventindex);

Default Value

''

Remarks

The ID of the calendar that contains the event.

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

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

Data Type

String

EventCategories Property (CloudCalendars_Office365Calendars Class)

The categories associated with the event.

Object Oriented Interface

public function getEventCategories($eventindex);
public function setEventCategories($eventindex, $value);

Procedural Interface

cloudcalendars_office365calendars_get($res, 41 , $eventindex);
cloudcalendars_office365calendars_set($res, 41, $value , $eventindex);

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

String

EventChangeKey Property (CloudCalendars_Office365Calendars Class)

Identifies the version of the event object.

Object Oriented Interface

public function getEventChangeKey($eventindex);

Procedural Interface

cloudcalendars_office365calendars_get($res, 42 , $eventindex);

Default Value

''

Remarks

Identifies the version of the event object.

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

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

Data Type

String

EventCreatedDateTime Property (CloudCalendars_Office365Calendars Class)

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

Object Oriented Interface

public function getEventCreatedDateTime($eventindex);

Procedural Interface

cloudcalendars_office365calendars_get($res, 43 , $eventindex);

Default Value

''

Remarks

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

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

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

Data Type

String

EventEndDateTime Property (CloudCalendars_Office365Calendars Class)

The date, time, and time zone that the event ends.

Object Oriented Interface

public function getEventEndDateTime($eventindex);
public function setEventEndDateTime($eventindex, $value);

Procedural Interface

cloudcalendars_office365calendars_get($res, 44 , $eventindex);
cloudcalendars_office365calendars_set($res, 44, $value , $eventindex);

Default Value

''

Remarks

The date, time, and time zone that the event ends. By default, the end time is in UTC.

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

This property is not available at design time.

Data Type

String

EventEndTimeZone Property (CloudCalendars_Office365Calendars Class)

The current end time zone.

Object Oriented Interface

public function getEventEndTimeZone($eventindex);
public function setEventEndTimeZone($eventindex, $value);

Procedural Interface

cloudcalendars_office365calendars_get($res, 45 , $eventindex);
cloudcalendars_office365calendars_set($res, 45, $value , $eventindex);

Default Value

''

Remarks

The current end time zone. A value of tzone://Microsoft/Custom indicates that a legacy custom time zone was set in desktop Outlook.

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

This property is not available at design time.

Data Type

String

EventEventType Property (CloudCalendars_Office365Calendars Class)

The event type.

Object Oriented Interface

public function getEventEventType($eventindex);

Procedural Interface

cloudcalendars_office365calendars_get($res, 46 , $eventindex);

Default Value

0

Remarks

The event type.

Possible values are:

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

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

Data Type

Integer

EventHasAttachments Property (CloudCalendars_Office365Calendars Class)

Set to true if the event has attachments.

Object Oriented Interface

public function getEventHasAttachments($eventindex);

Procedural Interface

cloudcalendars_office365calendars_get($res, 47 , $eventindex);

Default Value

false

Remarks

Set to true if the event has attachments.

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

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

Data Type

Boolean

EventId Property (CloudCalendars_Office365Calendars Class)

The unique identifier of the event.

Object Oriented Interface

public function getEventId($eventindex);

Procedural Interface

cloudcalendars_office365calendars_get($res, 48 , $eventindex);

Default Value

''

Remarks

The unique identifier of the event.

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

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

Data Type

String

EventImportance Property (CloudCalendars_Office365Calendars Class)

The importance of the event.

Object Oriented Interface

public function getEventImportance($eventindex);
public function setEventImportance($eventindex, $value);

Procedural Interface

cloudcalendars_office365calendars_get($res, 49 , $eventindex);
cloudcalendars_office365calendars_set($res, 49, $value , $eventindex);

Default Value

0

Remarks

The importance of the event.

Possible values are:

• 0 (ociLow)
• 1 (ociNormal)
• 2 (ociHigh)

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

This property is not available at design time.

Data Type

Integer

EventIsAllDay Property (CloudCalendars_Office365Calendars Class)

Set to true if the event lasts all day.

Object Oriented Interface

public function getEventIsAllDay($eventindex);
public function setEventIsAllDay($eventindex, $value);

Procedural Interface

cloudcalendars_office365calendars_get($res, 50 , $eventindex);
cloudcalendars_office365calendars_set($res, 50, $value , $eventindex);

Default Value

false

Remarks

Set to true if the event lasts all day. Setting Start and End is required when changing this value.

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

This property is not available at design time.

Data Type

Boolean

EventIsCancelled Property (CloudCalendars_Office365Calendars Class)

Set to true if the event has been canceled.

Object Oriented Interface

public function getEventIsCancelled($eventindex);

Procedural Interface

cloudcalendars_office365calendars_get($res, 51 , $eventindex);

Default Value

false

Remarks

Set to true if the event has been canceled.

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

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

Data Type

Boolean

EventIsReminderOn Property (CloudCalendars_Office365Calendars Class)

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

Object Oriented Interface

public function getEventIsReminderOn($eventindex);
public function setEventIsReminderOn($eventindex, $value);

Procedural Interface

cloudcalendars_office365calendars_get($res, 52 , $eventindex);
cloudcalendars_office365calendars_set($res, 52, $value , $eventindex);

Default Value

false

Remarks

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

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

This property is not available at design time.

Data Type

Boolean

EventJSON Property (CloudCalendars_Office365Calendars Class)

A JSON representation of the event.

Object Oriented Interface

public function getEventJSON($eventindex);
public function setEventJSON($eventindex, $value);

Procedural Interface

cloudcalendars_office365calendars_get($res, 53 , $eventindex);
cloudcalendars_office365calendars_set($res, 53, $value , $eventindex);

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

String

EventLastModifiedDateTime Property (CloudCalendars_Office365Calendars Class)

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

Object Oriented Interface

public function getEventLastModifiedDateTime($eventindex);

Procedural Interface

cloudcalendars_office365calendars_get($res, 54 , $eventindex);

Default Value

''

Remarks

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

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

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

Data Type

String

EventOriginalEndTimeZone Property (CloudCalendars_Office365Calendars Class)

The end time zone that was set when the event was created.

Object Oriented Interface

public function getEventOriginalEndTimeZone($eventindex);

Procedural Interface

cloudcalendars_office365calendars_get($res, 55 , $eventindex);

Default Value

''

Remarks

The end time zone that was set when the event was created. A value of tzone://Microsoft/Custom indicates that a legacy custom time zone was set in desktop Outlook.

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

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

Data Type

String

EventOriginalStartDateTime Property (CloudCalendars_Office365Calendars Class)

Represents the start time of an event when it is initially created as an occurrence or exception in a recurring series.

Object Oriented Interface

public function getEventOriginalStartDateTime($eventindex);

Procedural Interface

cloudcalendars_office365calendars_get($res, 56 , $eventindex);

Default Value

''

Remarks

Represents the start time of an event when it is initially created as an occurrence or exception in a recurring series. This property is not returned for events that are single instances.

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

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

Data Type

String

EventOriginalStartTimeZone Property (CloudCalendars_Office365Calendars Class)

The start time zone that was set when the event was created.

Object Oriented Interface

public function getEventOriginalStartTimeZone($eventindex);

Procedural Interface

cloudcalendars_office365calendars_get($res, 57 , $eventindex);

Default Value

''

Remarks

The start time zone that was set when the event was created. A value of tzone://Microsoft/Custom indicates that a legacy custom time zone was set in desktop Outlook.

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

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

Data Type

String

EventRecurDayOfMonth Property (CloudCalendars_Office365Calendars Class)

The day of the month on which the event occurs.

Object Oriented Interface

public function getEventRecurDayOfMonth($eventindex);
public function setEventRecurDayOfMonth($eventindex, $value);

Procedural Interface

cloudcalendars_office365calendars_get($res, 58 , $eventindex);
cloudcalendars_office365calendars_set($res, 58, $value , $eventindex);

Default Value

0

Remarks

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

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

This property is not available at design time.

Data Type

Integer

EventRecurDaysOfWeek Property (CloudCalendars_Office365Calendars Class)

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

Object Oriented Interface

public function getEventRecurDaysOfWeek($eventindex);
public function setEventRecurDaysOfWeek($eventindex, $value);

Procedural Interface

cloudcalendars_office365calendars_get($res, 59 , $eventindex);
cloudcalendars_office365calendars_set($res, 59, $value , $eventindex);

Default Value

''

Remarks

A space separated collection of the days of the week on which the event 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 event falls on the first day that satisfies the pattern. Required if type is weekly, relativeMonthly, or relativeYearly.

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

This property is not available at design time.

Data Type

String

EventRecurEndDate Property (CloudCalendars_Office365Calendars Class)

The date to stop applying the recurrence pattern.

Object Oriented Interface

public function getEventRecurEndDate($eventindex);
public function setEventRecurEndDate($eventindex, $value);

Procedural Interface

cloudcalendars_office365calendars_get($res, 60 , $eventindex);
cloudcalendars_office365calendars_set($res, 60, $value , $eventindex);

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

String

EventRecurFirstDayOfWeek Property (CloudCalendars_Office365Calendars Class)

The first day of the week.

Object Oriented Interface

public function getEventRecurFirstDayOfWeek($eventindex);
public function setEventRecurFirstDayOfWeek($eventindex, $value);

Procedural Interface

cloudcalendars_office365calendars_get($res, 61 , $eventindex);
cloudcalendars_office365calendars_set($res, 61, $value , $eventindex);

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 $eventindex parameter specifies the index of the item in the array. The size of the array is controlled by the EventsCount property.

This property is not available at design time.

Data Type

String

EventRecurIndex Property (CloudCalendars_Office365Calendars Class)

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

Object Oriented Interface

public function getEventRecurIndex($eventindex);
public function setEventRecurIndex($eventindex, $value);

Procedural Interface

cloudcalendars_office365calendars_get($res, 62 , $eventindex);
cloudcalendars_office365calendars_set($res, 62, $value , $eventindex);

Default Value

''

Remarks

Specifies on which instance of the allowed days specified in daysOfWeek the event 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 $eventindex parameter specifies the index of the item in the array. The size of the array is controlled by the EventsCount property.

This property is not available at design time.

Data Type

String

EventRecurInterval Property (CloudCalendars_Office365Calendars Class)

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

Object Oriented Interface

public function getEventRecurInterval($eventindex);
public function setEventRecurInterval($eventindex, $value);

Procedural Interface

cloudcalendars_office365calendars_get($res, 63 , $eventindex);
cloudcalendars_office365calendars_set($res, 63, $value , $eventindex);

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 $eventindex parameter specifies the index of the item in the array. The size of the array is controlled by the EventsCount property.

This property is not available at design time.

Data Type

Integer

EventRecurMonth Property (CloudCalendars_Office365Calendars Class)

The month in which the event occurs.

Object Oriented Interface

public function getEventRecurMonth($eventindex);
public function setEventRecurMonth($eventindex, $value);

Procedural Interface

cloudcalendars_office365calendars_get($res, 64 , $eventindex);
cloudcalendars_office365calendars_set($res, 64, $value , $eventindex);

Default Value

0

Remarks

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

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

This property is not available at design time.

Data Type

Integer

EventRecurNumberOfOccurrences Property (CloudCalendars_Office365Calendars Class)

The number of times to repeat the event.

Object Oriented Interface

public function getEventRecurNumberOfOccurrences($eventindex);
public function setEventRecurNumberOfOccurrences($eventindex, $value);

Procedural Interface

cloudcalendars_office365calendars_get($res, 65 , $eventindex);
cloudcalendars_office365calendars_set($res, 65, $value , $eventindex);

Default Value

0

Remarks

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

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

This property is not available at design time.

Data Type

Integer

EventRecurRangeType Property (CloudCalendars_Office365Calendars Class)

The recurrence range.

Object Oriented Interface

public function getEventRecurRangeType($eventindex);
public function setEventRecurRangeType($eventindex, $value);

Procedural Interface

cloudcalendars_office365calendars_get($res, 66 , $eventindex);
cloudcalendars_office365calendars_set($res, 66, $value , $eventindex);

Default Value

0

Remarks

The recurrence range.

Possible values are:

• 0 (ocrrtEndDate)
• 1 (ocrrtNoEnd)
• 2 (ocrrtNumbered)

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

This property is not available at design time.

Data Type

Integer

EventRecurStartDate Property (CloudCalendars_Office365Calendars Class)

The date to start applying the recurrence pattern.

Object Oriented Interface

public function getEventRecurStartDate($eventindex);
public function setEventRecurStartDate($eventindex, $value);

Procedural Interface

cloudcalendars_office365calendars_get($res, 67 , $eventindex);
cloudcalendars_office365calendars_set($res, 67, $value , $eventindex);

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 event. Must be the same value as the start property of the recurring event. Required.

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

This property is not available at design time.

Data Type

String

EventRecurTimeZone Property (CloudCalendars_Office365Calendars Class)

Time zone for the startDate and endDate properties.

Object Oriented Interface

public function getEventRecurTimeZone($eventindex);
public function setEventRecurTimeZone($eventindex, $value);

Procedural Interface

cloudcalendars_office365calendars_get($res, 68 , $eventindex);
cloudcalendars_office365calendars_set($res, 68, $value , $eventindex);

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

String

EventRecurType Property (CloudCalendars_Office365Calendars Class)

The recurrence pattern type Possible values are: 0 (ocrtDaily) 1 (ocrtWeekly) 2 (ocrtAbsoluteMonthly) 3 (ocrtRelativeMonthly) 4 (ocrtAbsoluteYearly) 5 (ocrtRelativeYearly) .

Object Oriented Interface

public function getEventRecurType($eventindex);
public function setEventRecurType($eventindex, $value);

Procedural Interface

cloudcalendars_office365calendars_get($res, 69 , $eventindex);
cloudcalendars_office365calendars_set($res, 69, $value , $eventindex);

Default Value

0

Remarks

The recurrence pattern type

Possible values are:

• 0 (ocrtDaily)
• 1 (ocrtWeekly)
• 2 (ocrtAbsoluteMonthly)
• 3 (ocrtRelativeMonthly)
• 4 (ocrtAbsoluteYearly)
• 5 (ocrtRelativeYearly)

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

This property is not available at design time.

Data Type

Integer

EventReminderMinutesBeforeStart Property (CloudCalendars_Office365Calendars Class)

The number of minutes before the event start time that the reminder alert occurs.

Object Oriented Interface

public function getEventReminderMinutesBeforeStart($eventindex);
public function setEventReminderMinutesBeforeStart($eventindex, $value);

Procedural Interface

cloudcalendars_office365calendars_get($res, 70 , $eventindex);
cloudcalendars_office365calendars_set($res, 70, $value , $eventindex);

Default Value

0

Remarks

The number of minutes before the event start time that the reminder alert occurs.

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

This property is not available at design time.

Data Type

Integer

EventSensitivity Property (CloudCalendars_Office365Calendars Class)

The event sensitivity Possible values are: 0 (ocsNormal) 1 (ocsPersonal) 2 (ocsPrivate) 3 (ocsConfidential) .

Object Oriented Interface

public function getEventSensitivity($eventindex);
public function setEventSensitivity($eventindex, $value);

Procedural Interface

cloudcalendars_office365calendars_get($res, 71 , $eventindex);
cloudcalendars_office365calendars_set($res, 71, $value , $eventindex);

Default Value

0

Remarks

The event sensitivity

Possible values are:

• 0 (ocsNormal)
• 1 (ocsPersonal)
• 2 (ocsPrivate)
• 3 (ocsConfidential)

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

This property is not available at design time.

Data Type

Integer

EventSeriesMasterId Property (CloudCalendars_Office365Calendars Class)

The ID for the recurring series master item, if this event is part of a recurring series.

Object Oriented Interface

public function getEventSeriesMasterId($eventindex);

Procedural Interface

cloudcalendars_office365calendars_get($res, 72 , $eventindex);

Default Value

''

Remarks

The ID for the recurring series master item, if this event is part of a recurring series.

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

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

Data Type

String

EventShowAs Property (CloudCalendars_Office365Calendars Class)

The status to show.

Object Oriented Interface

public function getEventShowAs($eventindex);
public function setEventShowAs($eventindex, $value);

Procedural Interface

cloudcalendars_office365calendars_get($res, 73 , $eventindex);
cloudcalendars_office365calendars_set($res, 73, $value , $eventindex);

Default Value

0

Remarks

The status to show.

Possible values are:

• 0 (ocsaFree)
• 1 (ocsaTentative)
• 2 (ocsaBusy)
• 3 (ocsaOOF)
• 4 (ocsaWorkingElsewhere)
• 5 (ocsaUnknown)

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

This property is not available at design time.

Data Type

Integer

EventStartDateTime Property (CloudCalendars_Office365Calendars Class)

The start date, time, and time zone of the event.

Object Oriented Interface

public function getEventStartDateTime($eventindex);
public function setEventStartDateTime($eventindex, $value);

Procedural Interface

cloudcalendars_office365calendars_get($res, 74 , $eventindex);
cloudcalendars_office365calendars_set($res, 74, $value , $eventindex);

Default Value

''

Remarks

The start date, time, and time zone of the event. By default, the start time is in UTC.

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

This property is not available at design time.

Data Type

String

EventStartTimeZone Property (CloudCalendars_Office365Calendars Class)

The current start time zone.

Object Oriented Interface

public function getEventStartTimeZone($eventindex);
public function setEventStartTimeZone($eventindex, $value);

Procedural Interface

cloudcalendars_office365calendars_get($res, 75 , $eventindex);
cloudcalendars_office365calendars_set($res, 75, $value , $eventindex);

Default Value

''

Remarks

The current start time zone. A value of tzone://Microsoft/Custom indicates that a legacy custom time zone was set in desktop Outlook.

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

This property is not available at design time.

Data Type

String

EventSubject Property (CloudCalendars_Office365Calendars Class)

The text of the event's subject line.

Object Oriented Interface

public function getEventSubject($eventindex);
public function setEventSubject($eventindex, $value);

Procedural Interface

cloudcalendars_office365calendars_get($res, 76 , $eventindex);
cloudcalendars_office365calendars_set($res, 76, $value , $eventindex);

Default Value

''

Remarks

The text of the event's subject line.

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

This property is not available at design time.

Data Type

String

FirewallAutoDetect Property (CloudCalendars_Office365Calendars Class)

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

Object Oriented Interface

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

Procedural Interface

cloudcalendars_office365calendars_get($res, 77 );
cloudcalendars_office365calendars_set($res, 77, $value );

Default Value

false

Remarks

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

Data Type

Boolean

FirewallType Property (CloudCalendars_Office365Calendars Class)

The type of firewall to connect through.

Object Oriented Interface

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

Procedural Interface

cloudcalendars_office365calendars_get($res, 78 );
cloudcalendars_office365calendars_set($res, 78, $value );

Default Value

0

Remarks

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

Data Type

Integer

FirewallHost Property (CloudCalendars_Office365Calendars Class)

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

Object Oriented Interface

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

Procedural Interface

cloudcalendars_office365calendars_get($res, 79 );
cloudcalendars_office365calendars_set($res, 79, $value );

Default Value

''

Remarks

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

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

Data Type

String

FirewallPassword Property (CloudCalendars_Office365Calendars Class)

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

Object Oriented Interface

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

Procedural Interface

cloudcalendars_office365calendars_get($res, 80 );
cloudcalendars_office365calendars_set($res, 80, $value );

Default Value

''

Remarks

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

Data Type

String

FirewallPort Property (CloudCalendars_Office365Calendars Class)

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

Object Oriented Interface

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

Procedural Interface

cloudcalendars_office365calendars_get($res, 81 );
cloudcalendars_office365calendars_set($res, 81, $value );

Default Value

0

Remarks

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

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

Data Type

Integer

FirewallUser Property (CloudCalendars_Office365Calendars Class)

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

Object Oriented Interface

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

Procedural Interface

cloudcalendars_office365calendars_get($res, 82 );
cloudcalendars_office365calendars_set($res, 82, $value );

Default Value

''

Remarks

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

Data Type

String

ListEventsMarker Property (CloudCalendars_Office365Calendars Class)

The page marker for listing events.

Object Oriented Interface

public function getListEventsMarker();
public function setListEventsMarker($value);

Procedural Interface

cloudcalendars_office365calendars_get($res, 83 );
cloudcalendars_office365calendars_set($res, 83, $value );

Default Value

''

Remarks

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

Example (List All Events in a Calendar):

do { office365.ListEvents(calendarId); } while (office365.ListEventsMarker.Length > 0);

This property is not available at design time.

Data Type

String

OAuthAccessToken Property (CloudCalendars_Office365Calendars Class)

The access token returned by the authorization server.

Object Oriented Interface

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

Procedural Interface

cloudcalendars_office365calendars_get($res, 84 );
cloudcalendars_office365calendars_set($res, 84, $value );

Default Value

''

Remarks

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

This property is not available at design time.

Data Type

String

OAuthAuthorizationCode Property (CloudCalendars_Office365Calendars Class)

The authorization code that is exchanged for an access token.

Object Oriented Interface

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

Procedural Interface

cloudcalendars_office365calendars_get($res, 85 );
cloudcalendars_office365calendars_set($res, 85, $value );

Default Value

''

Remarks

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

This property is not available at design time.

Data Type

String

OAuthAuthorizationScope Property (CloudCalendars_Office365Calendars Class)

The scope request or response parameter used during authorization.

Object Oriented Interface

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

Procedural Interface

cloudcalendars_office365calendars_get($res, 86 );
cloudcalendars_office365calendars_set($res, 86, $value );

Default Value

''

Remarks

The scope request or response parameter used during authorization.

This property is not available at design time.

Data Type

String

OAuthClientId Property (CloudCalendars_Office365Calendars Class)

The id of the client assigned when registering the application.

Object Oriented Interface

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

Procedural Interface

cloudcalendars_office365calendars_get($res, 87 );
cloudcalendars_office365calendars_set($res, 87, $value );

Default Value

''

Remarks

The id of the client assigned when registering the application.

This property is not available at design time.

Data Type

String

OAuthClientProfile Property (CloudCalendars_Office365Calendars Class)

The type of client that is requesting authorization.

Object Oriented Interface

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

Procedural Interface

cloudcalendars_office365calendars_get($res, 88 );
cloudcalendars_office365calendars_set($res, 88, $value );

Default Value

0

Remarks

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

This property is not available at design time.

Data Type

Integer

OAuthClientSecret Property (CloudCalendars_Office365Calendars Class)

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

Object Oriented Interface

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

Procedural Interface

cloudcalendars_office365calendars_get($res, 89 );
cloudcalendars_office365calendars_set($res, 89, $value );

Default Value

''

Remarks

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

This property is not available at design time.

Data Type

String

OAuthGrantType Property (CloudCalendars_Office365Calendars Class)

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

Object Oriented Interface

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

Procedural Interface

cloudcalendars_office365calendars_get($res, 90 );
cloudcalendars_office365calendars_set($res, 90, $value );

Default Value

0

Remarks

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

This property is not available at design time.

Data Type

Integer

OAuthRefreshToken Property (CloudCalendars_Office365Calendars Class)

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

Object Oriented Interface

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

Procedural Interface

cloudcalendars_office365calendars_get($res, 91 );
cloudcalendars_office365calendars_set($res, 91, $value );

Default Value

''

Remarks

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

This property is not available at design time.

Data Type

String

OAuthRequestRefreshToken Property (CloudCalendars_Office365Calendars Class)

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

Object Oriented Interface

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

Procedural Interface

cloudcalendars_office365calendars_get($res, 92 );
cloudcalendars_office365calendars_set($res, 92, $value );

Default Value

true

Remarks

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

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

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

This property is not available at design time.

Data Type

Boolean

OAuthReturnURL Property (CloudCalendars_Office365Calendars Class)

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

Object Oriented Interface

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

Procedural Interface

cloudcalendars_office365calendars_get($res, 93 );
cloudcalendars_office365calendars_set($res, 93, $value );

Default Value

''

Remarks

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

This property is not available at design time.

Data Type

String

OAuthServerAuthURL Property (CloudCalendars_Office365Calendars Class)

The URL of the authorization server.

Object Oriented Interface

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

Procedural Interface

cloudcalendars_office365calendars_get($res, 94 );
cloudcalendars_office365calendars_set($res, 94, $value );

Default Value

''

Remarks

The URL of the authorization server.

This property is not available at design time.

Data Type

String

OAuthServerTokenURL Property (CloudCalendars_Office365Calendars Class)

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

Object Oriented Interface

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

Procedural Interface

cloudcalendars_office365calendars_get($res, 95 );
cloudcalendars_office365calendars_set($res, 95, $value );

Default Value

''

Remarks

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

This property is not available at design time.

Data Type

String

OAuthWebAuthURL Property (CloudCalendars_Office365Calendars Class)

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

Object Oriented Interface

public function getOAuthWebAuthURL();

Procedural Interface

cloudcalendars_office365calendars_get($res, 96 );

Default Value

''

Remarks

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

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

Data Type

String

ProxyAuthScheme Property (CloudCalendars_Office365Calendars Class)

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

Object Oriented Interface

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

Procedural Interface

cloudcalendars_office365calendars_get($res, 97 );
cloudcalendars_office365calendars_set($res, 97, $value );

Default Value

0

Remarks

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

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

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

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

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

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

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

Data Type

Integer

ProxyAutoDetect Property (CloudCalendars_Office365Calendars Class)

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

Object Oriented Interface

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

Procedural Interface

cloudcalendars_office365calendars_get($res, 98 );
cloudcalendars_office365calendars_set($res, 98, $value );

Default Value

false

Remarks

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

Data Type

Boolean

ProxyPassword Property (CloudCalendars_Office365Calendars Class)

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

Object Oriented Interface

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

Procedural Interface

cloudcalendars_office365calendars_get($res, 99 );
cloudcalendars_office365calendars_set($res, 99, $value );

Default Value

''

Remarks

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

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

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

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

Data Type

String

ProxyPort Property (CloudCalendars_Office365Calendars Class)

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

Object Oriented Interface

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

Procedural Interface

cloudcalendars_office365calendars_get($res, 100 );
cloudcalendars_office365calendars_set($res, 100, $value );

Default Value

80

Remarks

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

Data Type

Integer

ProxyServer Property (CloudCalendars_Office365Calendars Class)

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

Object Oriented Interface

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

Procedural Interface

cloudcalendars_office365calendars_get($res, 101 );
cloudcalendars_office365calendars_set($res, 101, $value );

Default Value

''

Remarks

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

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

Data Type

String

ProxySSL Property (CloudCalendars_Office365Calendars Class)

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

Object Oriented Interface

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

Procedural Interface

cloudcalendars_office365calendars_get($res, 102 );
cloudcalendars_office365calendars_set($res, 102, $value );

Default Value

0

Remarks

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

Data Type

Integer

ProxyUser Property (CloudCalendars_Office365Calendars Class)

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

Object Oriented Interface

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

Procedural Interface

cloudcalendars_office365calendars_get($res, 103 );
cloudcalendars_office365calendars_set($res, 103, $value );

Default Value

''

Remarks

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

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

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

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

Data Type

String

SSLAcceptServerCertEffectiveDate Property (CloudCalendars_Office365Calendars Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLAcceptServerCertEffectiveDate();

Procedural Interface

cloudcalendars_office365calendars_get($res, 104 );

Default Value

''

Remarks

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

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLAcceptServerCertExpirationDate Property (CloudCalendars_Office365Calendars Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLAcceptServerCertExpirationDate();

Procedural Interface

cloudcalendars_office365calendars_get($res, 105 );

Default Value

''

Remarks

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

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLAcceptServerCertExtendedKeyUsage Property (CloudCalendars_Office365Calendars Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLAcceptServerCertExtendedKeyUsage();

Procedural Interface

cloudcalendars_office365calendars_get($res, 106 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprint Property (CloudCalendars_Office365Calendars Class)

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

Object Oriented Interface

public function getSSLAcceptServerCertFingerprint();

Procedural Interface

cloudcalendars_office365calendars_get($res, 107 );

Default Value

''

Remarks

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

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

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprintSHA1 Property (CloudCalendars_Office365Calendars Class)

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

Object Oriented Interface

public function getSSLAcceptServerCertFingerprintSHA1();

Procedural Interface

cloudcalendars_office365calendars_get($res, 108 );

Default Value

''

Remarks

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

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

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprintSHA256 Property (CloudCalendars_Office365Calendars Class)

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

Object Oriented Interface

public function getSSLAcceptServerCertFingerprintSHA256();

Procedural Interface

cloudcalendars_office365calendars_get($res, 109 );

Default Value

''

Remarks

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

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

This property is read-only.

Data Type

String

SSLAcceptServerCertIssuer Property (CloudCalendars_Office365Calendars Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertIssuer();

Procedural Interface

cloudcalendars_office365calendars_get($res, 110 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertPrivateKey Property (CloudCalendars_Office365Calendars Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKey();

Procedural Interface

cloudcalendars_office365calendars_get($res, 111 );

Default Value

''

Remarks

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

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

This property is read-only.

Data Type

String

SSLAcceptServerCertPrivateKeyAvailable Property (CloudCalendars_Office365Calendars Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKeyAvailable();

Procedural Interface

cloudcalendars_office365calendars_get($res, 112 );

Default Value

false

Remarks

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

This property is read-only.

Data Type

Boolean

SSLAcceptServerCertPrivateKeyContainer Property (CloudCalendars_Office365Calendars Class)

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

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKeyContainer();

Procedural Interface

cloudcalendars_office365calendars_get($res, 113 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKey Property (CloudCalendars_Office365Calendars Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertPublicKey();

Procedural Interface

cloudcalendars_office365calendars_get($res, 114 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKeyAlgorithm Property (CloudCalendars_Office365Calendars Class)

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

Object Oriented Interface

public function getSSLAcceptServerCertPublicKeyAlgorithm();

Procedural Interface

cloudcalendars_office365calendars_get($res, 115 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKeyLength Property (CloudCalendars_Office365Calendars Class)

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

Object Oriented Interface

public function getSSLAcceptServerCertPublicKeyLength();

Procedural Interface

cloudcalendars_office365calendars_get($res, 116 );

Default Value

0

Remarks

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

This property is read-only.

Data Type

Integer

SSLAcceptServerCertSerialNumber Property (CloudCalendars_Office365Calendars Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLAcceptServerCertSerialNumber();

Procedural Interface

cloudcalendars_office365calendars_get($res, 117 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertSignatureAlgorithm Property (CloudCalendars_Office365Calendars Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLAcceptServerCertSignatureAlgorithm();

Procedural Interface

cloudcalendars_office365calendars_get($res, 118 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertStore Property (CloudCalendars_Office365Calendars Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

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

Procedural Interface

cloudcalendars_office365calendars_get($res, 119 );
cloudcalendars_office365calendars_set($res, 119, $value );

Default Value

'MY'

Remarks

The name of the certificate store for the client certificate.

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

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

Designations of certificate stores are platform dependent.

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

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

Data Type

Binary String

SSLAcceptServerCertStorePassword Property (CloudCalendars_Office365Calendars Class)

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

Object Oriented Interface

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

Procedural Interface

cloudcalendars_office365calendars_get($res, 120 );
cloudcalendars_office365calendars_set($res, 120, $value );

Default Value

''

Remarks

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

Data Type

String

SSLAcceptServerCertStoreType Property (CloudCalendars_Office365Calendars Class)

The type of certificate store for this certificate.

Object Oriented Interface

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

Procedural Interface

cloudcalendars_office365calendars_get($res, 121 );
cloudcalendars_office365calendars_set($res, 121, $value );

Default Value

0

Remarks

The type of certificate store for this certificate.

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

Data Type

Integer

SSLAcceptServerCertSubjectAltNames Property (CloudCalendars_Office365Calendars Class)

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

Object Oriented Interface

public function getSSLAcceptServerCertSubjectAltNames();

Procedural Interface

cloudcalendars_office365calendars_get($res, 122 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintMD5 Property (CloudCalendars_Office365Calendars Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintMD5();

Procedural Interface

cloudcalendars_office365calendars_get($res, 123 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintSHA1 Property (CloudCalendars_Office365Calendars Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintSHA1();

Procedural Interface

cloudcalendars_office365calendars_get($res, 124 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintSHA256 Property (CloudCalendars_Office365Calendars Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintSHA256();

Procedural Interface

cloudcalendars_office365calendars_get($res, 125 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertUsage Property (CloudCalendars_Office365Calendars Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLAcceptServerCertUsage();

Procedural Interface

cloudcalendars_office365calendars_get($res, 126 );

Default Value

''

Remarks

The text description of SSLAcceptServerCertUsageFlags.

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

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

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

This property is read-only.

Data Type

String

SSLAcceptServerCertUsageFlags Property (CloudCalendars_Office365Calendars Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertUsageFlags();

Procedural Interface

cloudcalendars_office365calendars_get($res, 127 );

Default Value

0

Remarks

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

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

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

This property is read-only.

Data Type

Integer

SSLAcceptServerCertVersion Property (CloudCalendars_Office365Calendars Class)

The certificate's version number.

Object Oriented Interface

public function getSSLAcceptServerCertVersion();

Procedural Interface

cloudcalendars_office365calendars_get($res, 128 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertSubject Property (CloudCalendars_Office365Calendars Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

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

Procedural Interface

cloudcalendars_office365calendars_get($res, 129 );
cloudcalendars_office365calendars_set($res, 129, $value );

Default Value

''

Remarks

The subject of the certificate used for client authentication.

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

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

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

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

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

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

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

Data Type

String

SSLAcceptServerCertEncoded Property (CloudCalendars_Office365Calendars Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

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

Procedural Interface

cloudcalendars_office365calendars_get($res, 130 );
cloudcalendars_office365calendars_set($res, 130, $value );

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

SSLCertEffectiveDate Property (CloudCalendars_Office365Calendars Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLCertEffectiveDate();

Procedural Interface

cloudcalendars_office365calendars_get($res, 131 );

Default Value

''

Remarks

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

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLCertExpirationDate Property (CloudCalendars_Office365Calendars Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLCertExpirationDate();

Procedural Interface

cloudcalendars_office365calendars_get($res, 132 );

Default Value

''

Remarks

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

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLCertExtendedKeyUsage Property (CloudCalendars_Office365Calendars Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLCertExtendedKeyUsage();

Procedural Interface

cloudcalendars_office365calendars_get($res, 133 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLCertFingerprint Property (CloudCalendars_Office365Calendars Class)

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

Object Oriented Interface

public function getSSLCertFingerprint();

Procedural Interface

cloudcalendars_office365calendars_get($res, 134 );

Default Value

''

Remarks

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

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

This property is read-only.

Data Type

String

SSLCertFingerprintSHA1 Property (CloudCalendars_Office365Calendars Class)

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

Object Oriented Interface

public function getSSLCertFingerprintSHA1();

Procedural Interface

cloudcalendars_office365calendars_get($res, 135 );

Default Value

''

Remarks

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

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

This property is read-only.

Data Type

String

SSLCertFingerprintSHA256 Property (CloudCalendars_Office365Calendars Class)

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

Object Oriented Interface

public function getSSLCertFingerprintSHA256();

Procedural Interface

cloudcalendars_office365calendars_get($res, 136 );

Default Value

''

Remarks

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

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

This property is read-only.

Data Type

String

SSLCertIssuer Property (CloudCalendars_Office365Calendars Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLCertIssuer();

Procedural Interface

cloudcalendars_office365calendars_get($res, 137 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLCertPrivateKey Property (CloudCalendars_Office365Calendars Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLCertPrivateKey();

Procedural Interface

cloudcalendars_office365calendars_get($res, 138 );

Default Value

''

Remarks

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

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

This property is read-only.

Data Type

String

SSLCertPrivateKeyAvailable Property (CloudCalendars_Office365Calendars Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLCertPrivateKeyAvailable();

Procedural Interface

cloudcalendars_office365calendars_get($res, 139 );

Default Value

false

Remarks

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

This property is read-only.

Data Type

Boolean

SSLCertPrivateKeyContainer Property (CloudCalendars_Office365Calendars Class)

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

Object Oriented Interface

public function getSSLCertPrivateKeyContainer();

Procedural Interface

cloudcalendars_office365calendars_get($res, 140 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLCertPublicKey Property (CloudCalendars_Office365Calendars Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLCertPublicKey();

Procedural Interface

cloudcalendars_office365calendars_get($res, 141 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLCertPublicKeyAlgorithm Property (CloudCalendars_Office365Calendars Class)

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

Object Oriented Interface

public function getSSLCertPublicKeyAlgorithm();

Procedural Interface

cloudcalendars_office365calendars_get($res, 142 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLCertPublicKeyLength Property (CloudCalendars_Office365Calendars Class)

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

Object Oriented Interface

public function getSSLCertPublicKeyLength();

Procedural Interface

cloudcalendars_office365calendars_get($res, 143 );

Default Value

0

Remarks

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

This property is read-only.

Data Type

Integer

SSLCertSerialNumber Property (CloudCalendars_Office365Calendars Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLCertSerialNumber();

Procedural Interface

cloudcalendars_office365calendars_get($res, 144 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLCertSignatureAlgorithm Property (CloudCalendars_Office365Calendars Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLCertSignatureAlgorithm();

Procedural Interface

cloudcalendars_office365calendars_get($res, 145 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLCertStore Property (CloudCalendars_Office365Calendars Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

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

Procedural Interface

cloudcalendars_office365calendars_get($res, 146 );
cloudcalendars_office365calendars_set($res, 146, $value );

Default Value

'MY'

Remarks

The name of the certificate store for the client certificate.

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

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

Designations of certificate stores are platform dependent.

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

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

Data Type

Binary String

SSLCertStorePassword Property (CloudCalendars_Office365Calendars Class)

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

Object Oriented Interface

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

Procedural Interface

cloudcalendars_office365calendars_get($res, 147 );
cloudcalendars_office365calendars_set($res, 147, $value );

Default Value

''

Remarks

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

Data Type

String

SSLCertStoreType Property (CloudCalendars_Office365Calendars Class)

The type of certificate store for this certificate.

Object Oriented Interface

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

Procedural Interface

cloudcalendars_office365calendars_get($res, 148 );
cloudcalendars_office365calendars_set($res, 148, $value );

Default Value

0

Remarks

The type of certificate store for this certificate.

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

Data Type

Integer

SSLCertSubjectAltNames Property (CloudCalendars_Office365Calendars Class)

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

Object Oriented Interface

public function getSSLCertSubjectAltNames();

Procedural Interface

cloudcalendars_office365calendars_get($res, 149 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLCertThumbprintMD5 Property (CloudCalendars_Office365Calendars Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintMD5();

Procedural Interface

cloudcalendars_office365calendars_get($res, 150 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLCertThumbprintSHA1 Property (CloudCalendars_Office365Calendars Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintSHA1();

Procedural Interface

cloudcalendars_office365calendars_get($res, 151 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLCertThumbprintSHA256 Property (CloudCalendars_Office365Calendars Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintSHA256();

Procedural Interface

cloudcalendars_office365calendars_get($res, 152 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLCertUsage Property (CloudCalendars_Office365Calendars Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLCertUsage();

Procedural Interface

cloudcalendars_office365calendars_get($res, 153 );

Default Value

''

Remarks

The text description of SSLCertUsageFlags.

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

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

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

This property is read-only.

Data Type

String

SSLCertUsageFlags Property (CloudCalendars_Office365Calendars Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLCertUsageFlags();

Procedural Interface

cloudcalendars_office365calendars_get($res, 154 );

Default Value

0

Remarks

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

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

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

This property is read-only.

Data Type

Integer

SSLCertVersion Property (CloudCalendars_Office365Calendars Class)

The certificate's version number.

Object Oriented Interface

public function getSSLCertVersion();

Procedural Interface

cloudcalendars_office365calendars_get($res, 155 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLCertSubject Property (CloudCalendars_Office365Calendars Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

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

Procedural Interface

cloudcalendars_office365calendars_get($res, 156 );
cloudcalendars_office365calendars_set($res, 156, $value );

Default Value

''

Remarks

The subject of the certificate used for client authentication.

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

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

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

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

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

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

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

Data Type

String

SSLCertEncoded Property (CloudCalendars_Office365Calendars Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

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

Procedural Interface

cloudcalendars_office365calendars_get($res, 157 );
cloudcalendars_office365calendars_set($res, 157, $value );

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

SSLProvider Property (CloudCalendars_Office365Calendars Class)

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

Object Oriented Interface

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

Procedural Interface

cloudcalendars_office365calendars_get($res, 158 );
cloudcalendars_office365calendars_set($res, 158, $value );

Default Value

0

Remarks

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

Possible values are as follows:

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

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

Data Type

Integer

SSLServerCertEffectiveDate Property (CloudCalendars_Office365Calendars Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLServerCertEffectiveDate();

Procedural Interface

cloudcalendars_office365calendars_get($res, 159 );

Default Value

''

Remarks

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

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLServerCertExpirationDate Property (CloudCalendars_Office365Calendars Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLServerCertExpirationDate();

Procedural Interface

cloudcalendars_office365calendars_get($res, 160 );

Default Value

''

Remarks

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

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLServerCertExtendedKeyUsage Property (CloudCalendars_Office365Calendars Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLServerCertExtendedKeyUsage();

Procedural Interface

cloudcalendars_office365calendars_get($res, 161 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertFingerprint Property (CloudCalendars_Office365Calendars Class)

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

Object Oriented Interface

public function getSSLServerCertFingerprint();

Procedural Interface

cloudcalendars_office365calendars_get($res, 162 );

Default Value

''

Remarks

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

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

This property is read-only.

Data Type

String

SSLServerCertFingerprintSHA1 Property (CloudCalendars_Office365Calendars Class)

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

Object Oriented Interface

public function getSSLServerCertFingerprintSHA1();

Procedural Interface

cloudcalendars_office365calendars_get($res, 163 );

Default Value

''

Remarks

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

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

This property is read-only.

Data Type

String

SSLServerCertFingerprintSHA256 Property (CloudCalendars_Office365Calendars Class)

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

Object Oriented Interface

public function getSSLServerCertFingerprintSHA256();

Procedural Interface

cloudcalendars_office365calendars_get($res, 164 );

Default Value

''

Remarks

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

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

This property is read-only.

Data Type

String

SSLServerCertIssuer Property (CloudCalendars_Office365Calendars Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLServerCertIssuer();

Procedural Interface

cloudcalendars_office365calendars_get($res, 165 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertPrivateKey Property (CloudCalendars_Office365Calendars Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLServerCertPrivateKey();

Procedural Interface

cloudcalendars_office365calendars_get($res, 166 );

Default Value

''

Remarks

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

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

This property is read-only.

Data Type

String

SSLServerCertPrivateKeyAvailable Property (CloudCalendars_Office365Calendars Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLServerCertPrivateKeyAvailable();

Procedural Interface

cloudcalendars_office365calendars_get($res, 167 );

Default Value

false

Remarks

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

This property is read-only.

Data Type

Boolean

SSLServerCertPrivateKeyContainer Property (CloudCalendars_Office365Calendars Class)

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

Object Oriented Interface

public function getSSLServerCertPrivateKeyContainer();

Procedural Interface

cloudcalendars_office365calendars_get($res, 168 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertPublicKey Property (CloudCalendars_Office365Calendars Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLServerCertPublicKey();

Procedural Interface

cloudcalendars_office365calendars_get($res, 169 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertPublicKeyAlgorithm Property (CloudCalendars_Office365Calendars Class)

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

Object Oriented Interface

public function getSSLServerCertPublicKeyAlgorithm();

Procedural Interface

cloudcalendars_office365calendars_get($res, 170 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertPublicKeyLength Property (CloudCalendars_Office365Calendars Class)

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

Object Oriented Interface

public function getSSLServerCertPublicKeyLength();

Procedural Interface

cloudcalendars_office365calendars_get($res, 171 );

Default Value

0

Remarks

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

This property is read-only.

Data Type

Integer

SSLServerCertSerialNumber Property (CloudCalendars_Office365Calendars Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLServerCertSerialNumber();

Procedural Interface

cloudcalendars_office365calendars_get($res, 172 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertSignatureAlgorithm Property (CloudCalendars_Office365Calendars Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLServerCertSignatureAlgorithm();

Procedural Interface

cloudcalendars_office365calendars_get($res, 173 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertStore Property (CloudCalendars_Office365Calendars Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLServerCertStore();

Procedural Interface

cloudcalendars_office365calendars_get($res, 174 );

Default Value

'MY'

Remarks

The name of the certificate store for the client certificate.

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

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

Designations of certificate stores are platform dependent.

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

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

This property is read-only.

Data Type

Binary String

SSLServerCertStorePassword Property (CloudCalendars_Office365Calendars Class)

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

Object Oriented Interface

public function getSSLServerCertStorePassword();

Procedural Interface

cloudcalendars_office365calendars_get($res, 175 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertStoreType Property (CloudCalendars_Office365Calendars Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLServerCertStoreType();

Procedural Interface

cloudcalendars_office365calendars_get($res, 176 );

Default Value

0

Remarks

The type of certificate store for this certificate.

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

This property is read-only.

Data Type

Integer

SSLServerCertSubjectAltNames Property (CloudCalendars_Office365Calendars Class)

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

Object Oriented Interface

public function getSSLServerCertSubjectAltNames();

Procedural Interface

cloudcalendars_office365calendars_get($res, 177 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertThumbprintMD5 Property (CloudCalendars_Office365Calendars Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintMD5();

Procedural Interface

cloudcalendars_office365calendars_get($res, 178 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertThumbprintSHA1 Property (CloudCalendars_Office365Calendars Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintSHA1();

Procedural Interface

cloudcalendars_office365calendars_get($res, 179 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertThumbprintSHA256 Property (CloudCalendars_Office365Calendars Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintSHA256();

Procedural Interface

cloudcalendars_office365calendars_get($res, 180 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertUsage Property (CloudCalendars_Office365Calendars Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLServerCertUsage();

Procedural Interface

cloudcalendars_office365calendars_get($res, 181 );

Default Value

''

Remarks

The text description of SSLServerCertUsageFlags.

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

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

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

This property is read-only.

Data Type

String

SSLServerCertUsageFlags Property (CloudCalendars_Office365Calendars Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLServerCertUsageFlags();

Procedural Interface

cloudcalendars_office365calendars_get($res, 182 );

Default Value

0

Remarks

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

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

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

This property is read-only.

Data Type

Integer

SSLServerCertVersion Property (CloudCalendars_Office365Calendars Class)

The certificate's version number.

Object Oriented Interface

public function getSSLServerCertVersion();

Procedural Interface

cloudcalendars_office365calendars_get($res, 183 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertSubject Property (CloudCalendars_Office365Calendars Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLServerCertSubject();

Procedural Interface

cloudcalendars_office365calendars_get($res, 184 );

Default Value

''

Remarks

The subject of the certificate used for client authentication.

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

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

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

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

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

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

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

This property is read-only.

Data Type

String

SSLServerCertEncoded Property (CloudCalendars_Office365Calendars Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLServerCertEncoded();

Procedural Interface

cloudcalendars_office365calendars_get($res, 185 );

Default Value

''

Remarks

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

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

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

Data Type

Binary String

AddAttachment Method (CloudCalendars_Office365Calendars Class)

Adds a file attachment to an existing event.

Object Oriented Interface

public function doAddAttachment($eventid, $name, $localfile);

Procedural Interface

cloudcalendars_office365calendars_do_addattachment($res, $eventid, $name, $localfile);

Remarks

This method adds a file attachment to an existing event, specified by the EventId parameter. To add a more complex attachment, set the Name and LocalFile parameters to empty strings and the class will use the first attachment in the Attachments properties. Note that this operation will not clear the Attachments properties.

If the file size exceeds the value set in the AttachmentSimpleUploadLimit configuration, the class will use an upload session to upload the attachment in fragments. The size of these fragments is specified in the AttachmentFragmentSize configuration. You can also set the LocalFile as an empty string, in which case the data will be read from the input stream set beforehand using SetAttachmentInStream().

Example (Adding a Simple Attachment to a New Event)

office365.CreateEvent("Event Subject", "yyyy-MM-ddTHH:mm:ss", "yyyy-MM-ddTHH:mm:ss", calendarId); string eventId = office365.Events[0].Id; office365.AddAttachment(eventId, "file1.zip", "./file1.zip"); Example (Adding a Complex Attachment to a New Event) Example (Uploading an Attachment in Fragments)

Authorize Method (CloudCalendars_Office365Calendars Class)

Get the authorization string required to access the protected resource.

Object Oriented Interface

public function doAuthorize();

Procedural Interface

cloudcalendars_office365calendars_do_authorize($res);

Remarks

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

For more information, see the introduction section.

Config Method (CloudCalendars_Office365Calendars Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

cloudcalendars_office365calendars_do_config($res, $configurationstring);

Remarks

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

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

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

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

CreateCalendar Method (CloudCalendars_Office365Calendars Class)

Creates a new calendar.

Object Oriented Interface

public function doCreateCalendar($name);

Procedural Interface

cloudcalendars_office365calendars_do_createcalendar($res, $name);

Remarks

Creates a new calendar identified by the Name parameter, the display name of the calendar to be created. If a calendar with the same name already exists, the class will not overwrite it and will return an error indicating conflict.

The newly created calendar is added at the beginning of the Calendars properties.

If you need to specify more properties or customize the calendar beyond the basic creation, first create the calendar and then update it using the UpdateCalendar method.

Example (Creating a New Calendar)

office365.CreateCalendar(name); string statusLine = office365.Config("StatusLine")); // It should be "HTTP/1.1 201 Created"

CreateEvent Method (CloudCalendars_Office365Calendars Class)

Creates an event. The timezone is UTC.

Object Oriented Interface

public function doCreateEvent($subject, $starttime, $endtime, $calendarid);

Procedural Interface

cloudcalendars_office365calendars_do_createevent($res, $subject, $starttime, $endtime, $calendarid);

Remarks

Creates a new event with the specified details. The Subject parameter defines the title or description of the event, while the StartTime and EndTime parameters specify the start and end times of the event in UTC. Both the StartTime and EndTime times should be in the format yyyy-MM-ddTHH:mm:ss. The CalendarId parameter identifies the calendar in which the event will be created. If CalendarId is set to "" the event will be added in the default Calendar.

Attachments can also be added to the event using the AddAttachment method. For more details on how to add attachments, refer to the AddAttachment method.

If you need to set additional properties or customize the event further, use the UpdateEvent method after creation to modify attributes like location, attendees, reminders etc.

Example(Create a New event) office365.ListCalendars(); office365.CreateEvent("TestSub", "yyyy-MM-ddTHH:mm:ss", "yyyy-MM-ddTHH:mm:ss", office365.Calendars[index].Id);

DeleteAttachment Method (CloudCalendars_Office365Calendars Class)

Deletes an attachment.

Object Oriented Interface

public function doDeleteAttachment($id, $attachmentid);

Procedural Interface

cloudcalendars_office365calendars_do_deleteattachment($res, $id, $attachmentid);

Remarks

Deletes an attachment from an event using the id parameter to identify the event and the attachmentId to identify the attachment to be removed. However, this operation does not delete the attachment from the Attachments properties.

Example(Delete an Attachment)

office365.DeleteAttachment(eventId, attachmentId);

DeleteCalendar Method (CloudCalendars_Office365Calendars Class)

Deletes a calendar.

Object Oriented Interface

public function doDeleteCalendar($id);

Procedural Interface

cloudcalendars_office365calendars_do_deletecalendar($res, $id);

Remarks

Deletes a calendar identified by the id parameter. The calendar and all its associated events will be removed, and this operation will also delete the calendar from the Calendars properties.

DeleteEvent Method (CloudCalendars_Office365Calendars Class)

Deletes an event.

Object Oriented Interface

public function doDeleteEvent($id);

Procedural Interface

cloudcalendars_office365calendars_do_deleteevent($res, $id);

Remarks

Deletes an event identified by the id parameter. The specified event will be permanently removed and any attachments associated with it. This method also deletes the event from the Events properties.

GetCalendarView Method (CloudCalendars_Office365Calendars Class)

Lists the events as calendar view.

Object Oriented Interface

public function doGetCalendarView($calendarid, $starttime, $endtime);

Procedural Interface

cloudcalendars_office365calendars_do_getcalendarview($res, $calendarid, $starttime, $endtime);

Remarks

Retrieves a list of events within a specified time range, displaying them in a calendar view format. The calendarId parameter identifies the calendar from which to list the events; , if left empty, the events will be listed from the default Calendar. The StartTime and EndTime parameters define the time range for the events to be retrieved and should be in the format yyyy-MM-ddTHH:mm:ss. If you do not want to specify the start and end times, you can use the ListEvents method, which retrieves events without time range constraints.

GetEvent Method (CloudCalendars_Office365Calendars Class)

Retrieves the event by Id.

Object Oriented Interface

public function doGetEvent($id);

Procedural Interface

cloudcalendars_office365calendars_do_getevent($res, $id);

Remarks

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

Example (Get an Event)

// Retrieve an event by its ID office365.GetEvent(eventId); // Access the retrieved event OCalEvent event = office365.Events[0]; event.Subject; //event subject/title event.StartTime; event.EndTime; for(int i = 0; i < event.AttendeesCount; i++){ event.AttendeeIndex = i; event.AttendeeEmail; // the email of the attendee event.AttendeeStatusResponse; // the response of the attendee event.Body; // the body of the event }

GetEventField Method (CloudCalendars_Office365Calendars Class)

Retrieves the event property value by JSONPath.

Object Oriented Interface

public function doGetEventField($index, $jsonpath);

Procedural Interface

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

Remarks

This method retrieves a specific field within the event's JSON field. The first parameter, index, represents the index of the event in the Events 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. For a full list of the fields an event has/can have, please refer to the official documentation of the Office365 Calendars API documentation.

Example (Access Fields of an Event)

office365.GetEvent(eventId); office365.GetEventField(0, "/json/hasAttachments"); // Set to true if the event has attachments. office365.GetEventField(0, "/json/end/dateTime"); // The date and time that the event ends. office365.GetEventField(0, "/json/location/displayName"); // The name associated with the location. office365.GetEventField(0, "/json/location/address/city"); // The city associated with the location.

Interrupt Method (CloudCalendars_Office365Calendars Class)

Interrupt the current method.

Object Oriented Interface

public function doInterrupt();

Procedural Interface

cloudcalendars_office365calendars_do_interrupt($res);

Remarks

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

ListAttachments Method (CloudCalendars_Office365Calendars Class)

Lists all of a event's attachments.

Object Oriented Interface

public function doListAttachments($id);

Procedural Interface

cloudcalendars_office365calendars_do_listattachments($res, $id);

Remarks

This method lists all of a event's attachments. This method clears and populates the Attachments properties. No content data returns in this case

Lists all attachments of the specified event identified by the id parameter, clearing and updating the Attachments properties with the retrieved attachments. For each attachment found, the AttachmentList event is fired. Content data of the attachments is not included in the response; to access the actual content of an attachment, use the RetrieveAttachment method.

Example(List Attachments of an Event) office365.ListAttachments(eventId); foreach(OCalAttachment attachment in office365.Attachments){ attachment.Id; attachment.FileName; attachment.Name; attachment.ContentType; attachment.Data; // Data is NOT accessible only by calling ListAttachments. }

ListCalendars Method (CloudCalendars_Office365Calendars Class)

Lists the calendars.

Object Oriented Interface

public function doListCalendars();

Procedural Interface

cloudcalendars_office365calendars_do_listcalendars($res);

Remarks

Lists all calendars associated with the current user. The retrieved calendars are added to the Calendars properties, which is cleared before being repopulated with the latest data. For each calendar retrieved, the CalendarList event is fired.

ListEvents Method (CloudCalendars_Office365Calendars Class)

Lists the events.

Object Oriented Interface

public function doListEvents($calendarid);

Procedural Interface

cloudcalendars_office365calendars_do_listevents($res, $calendarid);

Remarks

Retrieves a list of events from the specified calendar identified by the calendarId parameter, if this parameter is left empty, the events will be retrieved from the default calendar. The retrieved events are added to the Events properties, which is cleared before being repopulated with the latest events data. For each event retrieved, the EventList event is fired.

Reset Method (CloudCalendars_Office365Calendars Class)

This method will reset the class.

Object Oriented Interface

public function doReset();

Procedural Interface

cloudcalendars_office365calendars_do_reset($res);

Remarks

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

RetrieveAttachment Method (CloudCalendars_Office365Calendars Class)

Retrieves an event attachment.

Object Oriented Interface

public function doRetrieveAttachment($id, $attachmentid);

Procedural Interface

cloudcalendars_office365calendars_do_retrieveattachment($res, $id, $attachmentid);

Remarks

Retrieves the data of a specific attachment from an event. The id parameter identifies the event, and the attachmentId specifies the attachment to be fetched. Upon retrieval, the attachment's content data is returned, making it accessible for further use.

The fetched attachment can be accessed through the Attachment* properties, which holds the details of all retrieved attachments.

Example(Retrieve an Attachment of an Event) office365.RetrieveAttachment(id); office365.Attachments[0].Id; office365.Attachments[0].FileName; office365.Attachments[0].Name; office365.Attachments[0].ContentType; office365.Attachments[0].Data; }

SendCustomRequest Method (CloudCalendars_Office365Calendars Class)

Send a custom HTTP request.

Object Oriented Interface

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

Procedural Interface

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

Remarks

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

Example (Send a custom request):

String data = @"{ ""name"": ""My Calendar"", ""color"": ""auto"", ""isDefaultCalendar"": false, ""canShare"": true, ""canEdit"": true, ""isRemovable"": true, }"; String url = "https://graph.microsoft.com/v1.0/me/calendars"; office365.SendCustomRequest("POST", url, data);

SetEventField Method (CloudCalendars_Office365Calendars Class)

Sets the event field value by JSONPath.

Object Oriented Interface

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

Procedural Interface

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

Remarks

This method is used to update a specific field within the event's JSON representation. Once the method is used, UpdateEvent needs to be called for the update to take effect. The parameters for this method are as follows: the first parameter, index, represents the index of the event in the Events 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 an Event before Updating): // Create an event. office365.CreateEvent("Subject", "yyyy-MM-ddTHH:mm:ss", "yyyy-MM-ddTHH:mm:ss", calendarId); office365.SetEventField(0, "/json/categories", "[\"category1\", \"category2\"]", 1); office365.SetEventField(0, "/json/end", "{\"dateTime\": \"yyyy-MM-ddTHH:mm:ss\", \"timeZone\": \"UTC\"}", 0); // Update the event office365.UpdateEvent(0);

For a full list of the fields an event has/can have, please refer to the official documentation of the Office365 Calendars API documentation.

UpdateCalendar Method (CloudCalendars_Office365Calendars Class)

Updates a calendar.

Object Oriented Interface

public function doUpdateCalendar($index);

Procedural Interface

cloudcalendars_office365calendars_do_updatecalendar($res, $index);

Remarks

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

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

The OCalCalendar type used in the Calendars collection includes the fields of a calendar. Refer to the OCalCalendar type for a complete list of fields.

Example: office365.CreateCalendar(name); // Fields to update office365.Calendars[0].Name = newName; office365.Calendars[0].Color = color; // Update the calendar office365.UpdateCalendar(0);

UpdateEvent Method (CloudCalendars_Office365Calendars Class)

Updates an event.

Object Oriented Interface

public function doUpdateEvent($index);

Procedural Interface

cloudcalendars_office365calendars_do_updateevent($res, $index);

Remarks

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

To update an event, edit the desired event fields within the Events collection. Then, call the UpdateEvent method with the index of the event. Note that changing the JSON data will overwrite the entire event, ignoring other field edits made before setting the JSON.

The OCalEvent type used in the Events collection includes the fields of an event. Refer to the OCalEvent type for a complete list of fields. If you need to add other fields, you can use the SetEventField method. For a complete list of fields an event can have, please refer to the Microsoft Graph API documentation.

Example: office365.ListCalendars(); // Create the event office365.CreateEvent("TestSub", "yyyy-MM-ddTHH:mm:ss", "yyyy-MM-ddTHH:mm:ss", office365.Calendars[index].Id); office365.Events[0].Subject = "New Test Subject"; office365.Events[0].Importance = TOCImportances.ociHigh; office365.Events[0].AttendeesCount = 2; office365.Events[0].AttendeeIndex = 0; office365.Events[0].AttendeeEmail = email1; office365.Events[0].AttendeeType = TOCAttendeeTypes.ocatRequired; office365.Events[0].AttendeeIndex = 1; office365.Events[0].AttendeeEmail = email2; office365.Events[0].AttendeeType = TOCAttendeeTypes.ocatOptional; office365.Events[0].Body = "weekly meeting"; //update the event office365.UpdateEvent(0);

AttachmentList Event (CloudCalendars_Office365Calendars Class)

Fired when an attachment is retrieved from the server.

Object Oriented Interface

public function fireAttachmentList($param);

Procedural Interface

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

Parameter List

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

Remarks

The AttachmentList event is fired for each attachment retrieved from the server when ListAttachments is called.

CalendarList Event (CloudCalendars_Office365Calendars Class)

Fired when a calendar is retrieved from the server.

Object Oriented Interface

public function fireCalendarList($param);

Procedural Interface

cloudcalendars_office365calendars_register_callback($res, 2, array($this, 'fireCalendarList'));

Parameter List

 'id'
 'name'

Remarks

The CalendarList event is fired for each calendar retrieved from the server when ListCalendars is called.

Error Event (CloudCalendars_Office365Calendars Class)

Fired when information is available about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

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

Parameter List

 'errorcode'
 'description'

Remarks

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

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

EventList Event (CloudCalendars_Office365Calendars Class)

Fired when an event is retrieved from the server.

Object Oriented Interface

public function fireEventList($param);

Procedural Interface

cloudcalendars_office365calendars_register_callback($res, 4, array($this, 'fireEventList'));

Parameter List

 'id'
 'calendarid'
 'subject'
 'starttime'
 'endtime'

Remarks

The EventList event is fired for each event retrieved from the server when ListEvents is called. This event provides details about each event, including its Id, the CalendarId it belongs to, the Subject (title or description), and the StartTime and EndTime times.

Log Event (CloudCalendars_Office365Calendars Class)

Fired once for each log message.

Object Oriented Interface

public function fireLog($param);

Procedural Interface

cloudcalendars_office365calendars_register_callback($res, 5, array($this, 'fireLog'));

Parameter List

 'loglevel'
 'message'
 'logtype'

Remarks

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

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

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

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

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

Message is the log entry.

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

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

SSLServerAuthentication Event (CloudCalendars_Office365Calendars Class)

Fired after the server presents its certificate to the client.

Object Oriented Interface

public function fireSSLServerAuthentication($param);

Procedural Interface

cloudcalendars_office365calendars_register_callback($res, 6, array($this, 'fireSSLServerAuthentication'));

Parameter List

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

Remarks

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

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

SSLStatus Event (CloudCalendars_Office365Calendars Class)

Fired when secure connection progress messages are available.

Object Oriented Interface

public function fireSSLStatus($param);

Procedural Interface

cloudcalendars_office365calendars_register_callback($res, 7, array($this, 'fireSSLStatus'));

Parameter List

 'message'

Remarks

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

Transfer Event (CloudCalendars_Office365Calendars Class)

Fired while a document transfers (delivers document).

Object Oriented Interface

public function fireTransfer($param);

Procedural Interface

cloudcalendars_office365calendars_register_callback($res, 8, array($this, 'fireTransfer'));

Parameter List

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

Remarks

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

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

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

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

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

Config Settings (Office365Calendars Class)

Office365Calendars Config Settings

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

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

OAuth Config Settings