SharePoint Class

Properties   Methods   Events   Config Settings   Errors  

The SharePoint class makes it easy to upload, download, and manage files and folder within SharePoint sites and document libraries.

Class Name

CloudStorage_SharePoint

Procedural Interface

 cloudstorage_sharepoint_open();
 cloudstorage_sharepoint_close($res);
 cloudstorage_sharepoint_register_callback($res, $id, $function);
 cloudstorage_sharepoint_get_last_error($res);
 cloudstorage_sharepoint_get_last_error_code($res);
 cloudstorage_sharepoint_set($res, $id, $index, $value);
 cloudstorage_sharepoint_get($res, $id, $index);
 cloudstorage_sharepoint_do_abortupload($res);
 cloudstorage_sharepoint_do_addqueryparam($res, $name, $value);
 cloudstorage_sharepoint_do_authorize($res);
 cloudstorage_sharepoint_do_calcauthorization($res);
 cloudstorage_sharepoint_do_config($res, $configurationstring);
 cloudstorage_sharepoint_do_copyresource($res, $parentid, $newname);
 cloudstorage_sharepoint_do_createfolder($res, $foldername);
 cloudstorage_sharepoint_do_createlink($res, $readonly);
 cloudstorage_sharepoint_do_deleteresource($res);
 cloudstorage_sharepoint_do_downloadfile($res);
 cloudstorage_sharepoint_do_getcurrentchangemarker($res);
 cloudstorage_sharepoint_do_getdocumentlibraryinfo($res);
 cloudstorage_sharepoint_do_getresourceinfo($res);
 cloudstorage_sharepoint_do_interrupt($res);
 cloudstorage_sharepoint_do_listchanges($res);
 cloudstorage_sharepoint_do_listdocumentlibraries($res);
 cloudstorage_sharepoint_do_listresources($res);
 cloudstorage_sharepoint_do_listsites($res);
 cloudstorage_sharepoint_do_moveresource($res, $parentid);
 cloudstorage_sharepoint_do_pollcopystatus($res);
 cloudstorage_sharepoint_do_polluploadstatus($res);
 cloudstorage_sharepoint_do_reset($res);
 cloudstorage_sharepoint_do_search($res, $query);
 cloudstorage_sharepoint_do_sendcustomrequest($res, $httpmethod, $requestpath, $requestbody);
 cloudstorage_sharepoint_do_updateresource($res);
 cloudstorage_sharepoint_do_uploadfile($res, $filename);

Remarks

The SharePoint class provides a simple interface to working with a SharePoint site document libraries. Capabilities include uploading and downloading files, strong encryption support, creating folders, moving and copying resources, listing SharePoint sites, and more.

To begin, first create an account and register your application with the Microsoft Graph API. Consult the Microsoft Graph API documentation for instructions on this process.

Authentication

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 default OAuthServerAuthURL and OAuthServerTokenURL properties. Additionally, below is a common scope for the class:

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: Sharepoint sharepoint = new Sharepoint(); sharepoint.OAuth.ClientProfile = CloudOAuthClientProfiles.cocpApplication; sharepoint.OAuth.GrantType = OAuthSettingsGrantTypes.cogtAuthorizationCode; sharepoint.OAuth.ClientId = CLIENT_ID; sharepoint.OAuth.ClientSecret = CLIENT_SECRET; sharepoint.OAuth.AuthorizationScope = "offline_access files.readwrite files.readwrite.all"; sharepoint.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

This profile is similar to setting the class to the Application profile and Authorization Code grant type except the class will not launch the browser. It is typically used in situations where there is a back-end that is supporting some front end. This profile expects that OAuthClientId, OAuthClientSecret, OAuthServerAuthURL, OAuthServerTokenURL, and the OAuthReturnURL properties to be set. Before calling the Authorize method, the OAuthWebAuthURL property should be queried to get a URL. This URL should be used to redirect the user to the authorization page for the service provider. The redirect_uri parameter of this URL is mapped to the OAuthReturnURL property. The OAuthReturnURL property should be set to some web server that will parse the authorization code out of the query parameter from the redirect. Once the authorization code is parsed, it should be passed back to the server where it is then set to the OAuthAuthorizationCode property. Once that is set, the Authorize method can be called to exchange the authorization code for an access token and refresh token if provided. The class will then cache these values like normal and use them to make requests. If the OAuthRefreshToken field is set, or a refresh token is cached, then the Authorize method can immediately be called to make a request to the token server to get a new access token.

External OAuth Support

For complex profiles or grant types, or for more control of the flow, it is possible to perform OAuth authentication using the OAuth class or a separate process. Once complete you should have an authorization string which looks like:

Bearer ACCESS_TOKEN_VALUE

Assign this value to the Authorization property before attempting any operations. Setting the Authorization property will cause the 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 files.readwrite files.readwrite.all sites.readwrite.all"; oauth.GrantType = OauthGrantTypes.ogtAuthorizationCode; sharepoint.Authorization = oauth.GetAuthorization(); Consult the documentation for the service for more information about supported scope values and more details on OAuth authentication.

Note: There are a couple of extra factors to consider when doing OAuth for SharePoint; please refer to the Authorization property documentation for more information.

Listing Resources

ListResources lists resources within the folder resource currently selected by RemoteId or RemotePath. Calling this method will fire the ResourceList event once for each resource, and will also populate the Resources properties.

If there are still more resources available to list when this method returns, the ResourceMarker property will be populated. Continue to call this method until ResourceMarker is empty to accumulate all pages of results in the Resources properties. Alternatively, the AccumulatePages configuration setting can be disabled to clear the Resources properties every time a page of results is returned. // ResourceList event handler. sharepoint.OnResourceList += (s, e) => { Console.WriteLine(e.Name); }; // (Assume that the RemoteId property isn't set; it takes precedence if it is.) sharepoint.RemotePath = "/work_files/serious_business/cats"; do { sharepoint.ListResources(); for (int i = 0; i < sharepoint.Resources.Count; i++) { // Process resources here. } } while (!string.IsNullOrEmpty(sharepoint.ResourceMarker));

Downloading Files

The DownloadFile method downloads the file resource currently selected by RemoteId or RemotePath.

If LocalFile is set, the file will be saved to the specified location; otherwise, the file data will be held by ResourceData.

To download and decrypt an encrypted file, set EncryptionAlgorithm and EncryptionPassword before calling this method.

Download Notes

In the simplest use-case, downloading a file looks like this: sharepoint.LocalFile = "../MyFile.zip"; sharepoint.RemoteId = sharepoint.Resources[0].Id; sharepoint.DownloadFile();

Resuming Downloads

The class also supports resuming failed downloads by using the StartByte property. If a download is interrupted, set StartByte to the appropriate offset before calling this method to resume the download. string downloadFile = "../MyFile.zip"; sharepoint.LocalFile = downloadFile; sharepoint.RemoteId = sharepoint.Resources[0].Id; sharepoint.DownloadFile(); //The transfer is interrupted and DownloadFile() above fails. Later, resume the download: //Get the size of the partially downloaded file sharepoint.StartByte = new FileInfo(downloadFile).Length; sharepoint.DownloadFile();

Resuming Encrypted File Downloads

Resuming encrypted file downloads is only supported when LocalFile was set in the initial download attempt.

If LocalFile is set when beginning an encrypted download, the class creates a temporary file in TempPath to hold the encrypted data until the download is complete. If the download is interrupted, DownloadTempFile will be populated with the path of the temporary file that holds the partial data.

To resume, DownloadTempFile must be populated, along with StartByte, to allow the remainder of the encrypted data to be downloaded. Once the encrypted data is downloaded it will be decrypted and written to LocalFile. sharepoint.LocalFile = "../MyFile.zip"; sharepoint.EncryptionPassword = "password"; sharepoint.RemoteId = sharepoint.Resources[0].Id; sharepoint.DownloadFile(); //The transfer is interrupted and DownloadFile() above fails. Later, resume the download: //Get the size of the partially download temp file sharepoint.StartByte = new FileInfo(sharepoint.Config("DownloadTempFile")).Length; sharepoint.DownloadFile();

Uploading Files

The UploadFile method uploads new file resources to the folder resource currently selected by RemoteId or RemotePath.

If LocalFile is set the file will be uploaded from the specified path. If LocalFile is not set the data in ResourceData will be used.

To encrypt the file before uploading it, set EncryptionAlgorithm and EncryptionPassword.

Upload Notes

SharePoint offers two ways to upload a file. For smaller files a simple upload option is provided to upload data in one request. This is the default option. For larger files, uploads can be fragmented into multiple pieces, allowing resuming of uploads that may be interrupted.

Simple

By default the class uses the simple upload mechanism. sharepoint.LocalFile = "../MyFile.zip"; sharepoint.UploadFile("MyFile.zip");

Resumable

To enable resumable uploads set UseResumableUpload to true. This is recommended for large files. The class will automatically fragment the specified file into smaller pieces and upload each individually. FragmentSize may be set to specify the size of the fragment if desired. The default fragment size is 10 MB.

When UseResumableUpload is set to true and UploadFile is called, a resumable upload session is started by the class. ResumeURL is populated with a URL identifying the session (this value may be needed for additional operations if the upload does not complete normally).

During a resumable upload, the FragmentComplete event fires after each fragment is uploaded to indicate overall progress. The class also updates StartByte as necessary to indicate the current offset in the file.

If the upload is interrupted for any reason, resuming it is easy. First, verify that ResumeURL and StartByte are populated (if the same instance of the class is used, they should already be populated, and no special action should be needed). Then call UploadFile again to resume the upload at the specified StartByte offset.

Note that if the upload is not resumed after some time the upload session will expire. PollUploadStatus may be used to check the status of a resumable upload, including when it will expire (which is stored in the UploadExpDate configuration setting). An interrupted upload can be aborted explicitly using the AbortUpload method. sharepoint.LocalFile = "../MyFile.zip"; sharepoint.UploadFile("MyFile.zip"); //The transfer is interrupted and UploadFile() above fails. Later, resume the download. //Using the same instance StartByte and ResumeURL are already populated from the previous //upload attempt. sharepoint.UploadFile("MyFile.zip");

Additional Functionality

The SharePoint class offers advanced functionality beyond simple uploads and downloads. For instance:

• Encrypt and decrypt files using the EncryptionAlgorithm and EncryptionPassword properties.
• Basic file and folder manipulation and organization using methods such as CopyResource, CreateFolder, DeleteResource, MoveResource, and UpdateResource.
• Creation of resource sharing links using CreateLink.
• Change tracking with ListChanges.
• Advanced resource listing using the Search method.
• Listing, getting, and selecting a document libraries using the ListDocumentLibraries and GetDocumentLibraryInfo methods and the DocumentLibrary property.
• Listing the current SharePoint sites available to the authenticated entity with the ListSites method.
• And more!

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.

Authorization Property (CloudStorage_SharePoint Class)

OAuth 2.0 Authorization Token.

Object Oriented Interface

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

Procedural Interface

cloudstorage_sharepoint_get($res, 1 );
cloudstorage_sharepoint_set($res, 1, $value );

Default Value

''

Remarks

This class supports authentication via OAuth 2.0. First, perform OAuth authentication using the OAuth property, using the OAuth class or a separate process. If using the OAuth property, then the Authorization property will not be used. Once complete you should have an authorization string which looks like:

Bearer ACCESS_TOKEN

Assign this value to the Authorization property before attempting any operations.

Authorization Notes

Microsoft's OAuth system is heavily integrated into Azure Active Directory, which has undergone a number of restructurings in recent years. The task of registering an application for use with Microsoft Graph (or any other Microsoft service that supports OAuth authentication) is a common point of confusion, especially given the continued availability of old documentation about Azure AD.

At this time, the most straightforward instructions available for registering an application for use with Microsoft Graph can be found on Register your app page of the Microsoft Graph API documentation. One of the steps on that page is selecting the application's supported account types. In most cases, the "Accounts in any organizational directory and personal Microsoft accounts" option is the most appropriate.

Once the application is registered, refer to the instructions on the Get access on behalf of a user page of the Microsoft Graph API documentation for information about what endpoints to use with the OAuth class for authentication. Pay special attention to the description of the possible value for the {tenent} segment of the OAuth endpoints.

Refer to the Microsoft Graph API's permissions documentation for more information about the OAuth scopes that Microsoft Graph supports.

Data Type

String

ChangeMarker Property (CloudStorage_SharePoint Class)

A marker indicating what page of changes to return next.

Object Oriented Interface

public function getChangeMarker();
public function setChangeMarker($value);

Procedural Interface

cloudstorage_sharepoint_get($res, 2 );
cloudstorage_sharepoint_set($res, 2, $value );

Default Value

''

Remarks

This property will be populated when ListChanges is called if the results are paged and there are more pages. To list all changes, continue to call ListChanges until this property returns empty string.

Setting ChangeMarker will cause NextChangeMarker to be set to empty string.

Refer to ListChanges for more information.

This property is not available at design time.

Data Type

String

CopiedResourceId Property (CloudStorage_SharePoint Class)

The Id of a newly-copied resource.

Object Oriented Interface

public function getCopiedResourceId();

Procedural Interface

cloudstorage_sharepoint_get($res, 3 );

Default Value

''

Remarks

This property reflects the Id of a newly-copied resource. It is populated after the PollCopyStatus method is called if the copy operation has completed successfully (or cleared if the copy operation is still in progress, or has failed).

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

Data Type

String

CopyPercentDone Property (CloudStorage_SharePoint Class)

Progress percentage of a copy operation.

Object Oriented Interface

public function getCopyPercentDone();

Procedural Interface

cloudstorage_sharepoint_get($res, 4 );

Default Value

''

Remarks

This property reflects the progress of a copy operation, as a percentage (e.g., 87.3). It is populated after the PollCopyStatus method is called.

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

Data Type

String

CopyStatus Property (CloudStorage_SharePoint Class)

Status of a copy operation.

Object Oriented Interface

public function getCopyStatus();

Procedural Interface

cloudstorage_sharepoint_get($res, 5 );

Default Value

''

Remarks

This property reflects the status of a copy operation. It is populated after the PollCopyStatus method is called. Possible values strings are:

• notStarted
• inProgress
• completed
• updating
• failed
• waiting

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

Data Type

String

DocumentLibraryCount Property (CloudStorage_SharePoint Class)

The number of records in the DocumentLibrary arrays.

Object Oriented Interface

public function getDocumentLibraryCount();

Procedural Interface

cloudstorage_sharepoint_get($res, 6 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• DocumentLibraryDeletedSpace
• DocumentLibraryDescription
• DocumentLibraryId
• DocumentLibraryName
• DocumentLibraryOwnerId
• DocumentLibraryOwnerName
• DocumentLibraryRemainingSpace
• DocumentLibraryState
• DocumentLibraryTotalSpace
• DocumentLibraryUsedSpace

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

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

Data Type

Integer

DocumentLibraryDeletedSpace Property (CloudStorage_SharePoint Class)

The amount of document library space consumed by deleted resources.

Object Oriented Interface

public function getDocumentLibraryDeletedSpace($documentlibraryindex);

Procedural Interface

cloudstorage_sharepoint_get($res, 7 , $documentlibraryindex);

Default Value

0

Remarks

The amount of document library space consumed by deleted resources.

This property reflects the amount of document library space, in bytes, consumed by deleted resources.

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

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

Data Type

Long64

DocumentLibraryDescription Property (CloudStorage_SharePoint Class)

A description of the document library.

Object Oriented Interface

public function getDocumentLibraryDescription($documentlibraryindex);

Procedural Interface

cloudstorage_sharepoint_get($res, 8 , $documentlibraryindex);

Default Value

''

Remarks

A description of the document library.

This property holds a description of the document library.

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

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

Data Type

String

DocumentLibraryId Property (CloudStorage_SharePoint Class)

The Id of the document library.

Object Oriented Interface

public function getDocumentLibraryId($documentlibraryindex);

Procedural Interface

cloudstorage_sharepoint_get($res, 9 , $documentlibraryindex);

Default Value

''

Remarks

The Id of the document library.

This property holds the Id of the document library.

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

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

Data Type

String

DocumentLibraryName Property (CloudStorage_SharePoint Class)

The name of the document library.

Object Oriented Interface

public function getDocumentLibraryName($documentlibraryindex);

Procedural Interface

cloudstorage_sharepoint_get($res, 10 , $documentlibraryindex);

Default Value

''

Remarks

The name of the document library.

This property holds the name of the document library.

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

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

Data Type

String

DocumentLibraryOwnerId Property (CloudStorage_SharePoint Class)

The Id of the document library's owner.

Object Oriented Interface

public function getDocumentLibraryOwnerId($documentlibraryindex);

Procedural Interface

cloudstorage_sharepoint_get($res, 11 , $documentlibraryindex);

Default Value

''

Remarks

The Id of the document library's owner.

This property holds the Id of the document library's owner.

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

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

Data Type

String

DocumentLibraryOwnerName Property (CloudStorage_SharePoint Class)

The name of the document library's owner.

Object Oriented Interface

public function getDocumentLibraryOwnerName($documentlibraryindex);

Procedural Interface

cloudstorage_sharepoint_get($res, 12 , $documentlibraryindex);

Default Value

''

Remarks

The name of the document library's owner.

This property holds the name of the document library's owner.

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

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

Data Type

String

DocumentLibraryRemainingSpace Property (CloudStorage_SharePoint Class)

The amount of document library space currently available.

Object Oriented Interface

public function getDocumentLibraryRemainingSpace($documentlibraryindex);

Procedural Interface

cloudstorage_sharepoint_get($res, 13 , $documentlibraryindex);

Default Value

0

Remarks

The amount of document library space currently available.

This property reflects the amount of document library space, in bytes, that is currently available.

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

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

Data Type

Long64

DocumentLibraryState Property (CloudStorage_SharePoint Class)

The document library's storage quota state.

Object Oriented Interface

public function getDocumentLibraryState($documentlibraryindex);

Procedural Interface

cloudstorage_sharepoint_get($res, 14 , $documentlibraryindex);

Default Value

0

Remarks

The document library's storage quota state.

This property reflects the document library's current storage quota state. Possible values are:

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

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

Data Type

Integer

DocumentLibraryTotalSpace Property (CloudStorage_SharePoint Class)

The total capacity of the document library.

Object Oriented Interface

public function getDocumentLibraryTotalSpace($documentlibraryindex);

Procedural Interface

cloudstorage_sharepoint_get($res, 15 , $documentlibraryindex);

Default Value

0

Remarks

The total capacity of the document library.

This property reflects the total capacity, in bytes, of the document library.

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

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

Data Type

Long64

DocumentLibraryUsedSpace Property (CloudStorage_SharePoint Class)

The amount of document library space that has been consumed.

Object Oriented Interface

public function getDocumentLibraryUsedSpace($documentlibraryindex);

Procedural Interface

cloudstorage_sharepoint_get($res, 16 , $documentlibraryindex);

Default Value

0

Remarks

The amount of document library space that has been consumed.

This property reflects the amount of document library space, in bytes, that has been consumed.

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

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

Data Type

Long64

DocumentLibrary Property (CloudStorage_SharePoint Class)

Selects a document library.

Object Oriented Interface

public function getDocumentLibrary();
public function setDocumentLibrary($value);

Procedural Interface

cloudstorage_sharepoint_get($res, 17 );
cloudstorage_sharepoint_set($res, 17, $value );

Default Value

''

Remarks

This property can be set to the Id of a specific document library to select it for use.

When this property is empty (default), the class uses the site's, defined by the SiteId, default document library.

This property is not available at design time.

Data Type

String

DocumentLibraryMarker Property (CloudStorage_SharePoint Class)

A marker indicating what page of document libraries to return next.

Object Oriented Interface

public function getDocumentLibraryMarker();
public function setDocumentLibraryMarker($value);

Procedural Interface

cloudstorage_sharepoint_get($res, 18 );
cloudstorage_sharepoint_set($res, 18, $value );

Default Value

''

Remarks

This property will be populated when ListDocumentLibraries is called if the results are paged and there are more pages. To list all document libraries, continue to call ListDocumentLibraries until this property returns empty string.

Refer to ListDocumentLibraries for more information

This property is not available at design time.

Data Type

String

EncryptionAlgorithm Property (CloudStorage_SharePoint Class)

The encryption algorithm.

Object Oriented Interface

public function getEncryptionAlgorithm();
public function setEncryptionAlgorithm($value);

Procedural Interface

cloudstorage_sharepoint_get($res, 19 );
cloudstorage_sharepoint_set($res, 19, $value );

Default Value

0

Remarks

This property specifies the encryption algorithm to be used. The maximum allowable key size is automatically used for the selected algorithm. Possible values are:

Data Type

Integer

EncryptionPassword Property (CloudStorage_SharePoint Class)

The encryption password.

Object Oriented Interface

public function getEncryptionPassword();
public function setEncryptionPassword($value);

Procedural Interface

cloudstorage_sharepoint_get($res, 20 );
cloudstorage_sharepoint_set($res, 20, $value );

Default Value

''

Remarks

If this property is populated when UploadFile or DownloadFile is called, the class will attempt to encrypt or decrypt the data before uploading or after downloading it.

The class uses the value specified here to generate the necessary encryption Key and IV values using the PKCS5 password digest algorithm. This provides a simpler alternative to creating and managing Key and IV values directly.

However, it is also possible to explicitly specify the Key and IV values to use by setting the EncryptionKey and EncryptionIV configuration settings. This may be necessary if, e.g., the data needs to be encrypted/decrypted by another utility which generates Key and IV values differently.

This property is not available at design time.

Data Type

String

FirewallAutoDetect Property (CloudStorage_SharePoint Class)

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

Object Oriented Interface

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

Procedural Interface

cloudstorage_sharepoint_get($res, 21 );
cloudstorage_sharepoint_set($res, 21, $value );

Default Value

false

Remarks

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

Data Type

Boolean

FirewallType Property (CloudStorage_SharePoint Class)

The type of firewall to connect through.

Object Oriented Interface

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

Procedural Interface

cloudstorage_sharepoint_get($res, 22 );
cloudstorage_sharepoint_set($res, 22, $value );

Default Value

0

Remarks

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

Data Type

Integer

FirewallHost Property (CloudStorage_SharePoint Class)

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

Object Oriented Interface

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

Procedural Interface

cloudstorage_sharepoint_get($res, 23 );
cloudstorage_sharepoint_set($res, 23, $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 (CloudStorage_SharePoint 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

cloudstorage_sharepoint_get($res, 24 );
cloudstorage_sharepoint_set($res, 24, $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 (CloudStorage_SharePoint Class)

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

Object Oriented Interface

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

Procedural Interface

cloudstorage_sharepoint_get($res, 25 );
cloudstorage_sharepoint_set($res, 25, $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 (CloudStorage_SharePoint 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

cloudstorage_sharepoint_get($res, 26 );
cloudstorage_sharepoint_set($res, 26, $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

Idle Property (CloudStorage_SharePoint Class)

The current status of the class.

Object Oriented Interface

public function getIdle();

Procedural Interface

cloudstorage_sharepoint_get($res, 27 );

Default Value

true

Remarks

This property will be False if the component is currently busy (communicating or waiting for an answer), and True at all other times.

This property is read-only.

Data Type

Boolean

LocalFile Property (CloudStorage_SharePoint Class)

The location of the local file.

Object Oriented Interface

public function getLocalFile();
public function setLocalFile($value);

Procedural Interface

cloudstorage_sharepoint_get($res, 28 );
cloudstorage_sharepoint_set($res, 28, $value );

Default Value

''

Remarks

This property specifies the location of a file on disk. This is used as the source file when calling UploadFile or UpdateResource, and as the destination file when calling DownloadFile.

Data Type

String

LocalHost Property (CloudStorage_SharePoint Class)

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

Object Oriented Interface

public function getLocalHost();
public function setLocalHost($value);

Procedural Interface

cloudstorage_sharepoint_get($res, 29 );
cloudstorage_sharepoint_set($res, 29, $value );

Default Value

''

Remarks

This property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used.

If the class is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).

Note: LocalHost is not persistent. You must always set it in code, and never in the property window.

Data Type

String

NextChangeMarker Property (CloudStorage_SharePoint Class)

A marker indicating what page of changes to return in the future.

Object Oriented Interface

public function getNextChangeMarker();
public function setNextChangeMarker($value);

Procedural Interface

cloudstorage_sharepoint_get($res, 30 );
cloudstorage_sharepoint_set($res, 30, $value );

Default Value

''

Remarks

This property will be populated when ListChanges is called if there are no more changes to list.

This property will be populated with the most current change marker if GetCurrentChangeMarker is called.

Setting NextChangeMarker will cause ChangeMarker to be set to empty string.

Refer to ListChanges for more information.

This property is not available at design time.

Data Type

String

OAuthAccessToken Property (CloudStorage_SharePoint Class)

The access token returned by the authorization server.

Object Oriented Interface

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

Procedural Interface

cloudstorage_sharepoint_get($res, 31 );
cloudstorage_sharepoint_set($res, 31, $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 (CloudStorage_SharePoint Class)

The authorization code that is exchanged for an access token.

Object Oriented Interface

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

Procedural Interface

cloudstorage_sharepoint_get($res, 32 );
cloudstorage_sharepoint_set($res, 32, $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 (CloudStorage_SharePoint Class)

The scope request or response parameter used during authorization.

Object Oriented Interface

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

Procedural Interface

cloudstorage_sharepoint_get($res, 33 );
cloudstorage_sharepoint_set($res, 33, $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 (CloudStorage_SharePoint Class)

The id of the client assigned when registering the application.

Object Oriented Interface

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

Procedural Interface

cloudstorage_sharepoint_get($res, 34 );
cloudstorage_sharepoint_set($res, 34, $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 (CloudStorage_SharePoint Class)

The type of client that is requesting authorization.

Object Oriented Interface

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

Procedural Interface

cloudstorage_sharepoint_get($res, 35 );
cloudstorage_sharepoint_set($res, 35, $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 (CloudStorage_SharePoint Class)

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

Object Oriented Interface

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

Procedural Interface

cloudstorage_sharepoint_get($res, 36 );
cloudstorage_sharepoint_set($res, 36, $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 (CloudStorage_SharePoint Class)

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

Object Oriented Interface

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

Procedural Interface

cloudstorage_sharepoint_get($res, 37 );
cloudstorage_sharepoint_set($res, 37, $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 (CloudStorage_SharePoint 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

cloudstorage_sharepoint_get($res, 38 );
cloudstorage_sharepoint_set($res, 38, $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 (CloudStorage_SharePoint Class)

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

Object Oriented Interface

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

Procedural Interface

cloudstorage_sharepoint_get($res, 39 );
cloudstorage_sharepoint_set($res, 39, $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 (CloudStorage_SharePoint Class)

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

Object Oriented Interface

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

Procedural Interface

cloudstorage_sharepoint_get($res, 40 );
cloudstorage_sharepoint_set($res, 40, $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 (CloudStorage_SharePoint Class)

The URL of the authorization server.

Object Oriented Interface

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

Procedural Interface

cloudstorage_sharepoint_get($res, 41 );
cloudstorage_sharepoint_set($res, 41, $value );

Default Value

''

Remarks

The URL of the authorization server.

This property is not available at design time.

Data Type

String

OAuthServerTokenURL Property (CloudStorage_SharePoint 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

cloudstorage_sharepoint_get($res, 42 );
cloudstorage_sharepoint_set($res, 42, $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 (CloudStorage_SharePoint Class)

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

Object Oriented Interface

public function getOAuthWebAuthURL();

Procedural Interface

cloudstorage_sharepoint_get($res, 43 );

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

OtherHeaders Property (CloudStorage_SharePoint Class)

Other headers as determined by the user (optional).

Object Oriented Interface

public function getOtherHeaders();
public function setOtherHeaders($value);

Procedural Interface

cloudstorage_sharepoint_get($res, 44 );
cloudstorage_sharepoint_set($res, 44, $value );

Default Value

''

Remarks

This property can be set to a string of headers to be appended to the HTTP request headers created from other properties like ContentType and From.

The headers must follow the format Header: Value as described in the HTTP specifications. Header lines should be separated by CRLF ("\r\n") .

Use this property with caution. If this property contains invalid headers, HTTP requests may fail.

This property is useful for extending the functionality of the class beyond what is provided.

This property is not available at design time.

Data Type

String

Overwrite Property (CloudStorage_SharePoint Class)

Whether to overwrite the local or remote file.

Object Oriented Interface

public function getOverwrite();
public function setOverwrite($value);

Procedural Interface

cloudstorage_sharepoint_get($res, 45 );
cloudstorage_sharepoint_set($res, 45, $value );

Default Value

false

Remarks

When calling DownloadFile, this property determines if LocalFile should be overwritten if it already exists.

When calling UploadFile, this property determines if the remote file should be overwritten if it already exists. If the RenameIfExists configuration setting is enabled, this property is ignored and the server will renamed the newly-uploaded file instead (if necessary).

Data Type

Boolean

ParsedHeaderCount Property (CloudStorage_SharePoint Class)

The number of records in the ParsedHeader arrays.

Object Oriented Interface

public function getParsedHeaderCount();

Procedural Interface

cloudstorage_sharepoint_get($res, 46 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• ParsedHeaderField
• ParsedHeaderValue

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

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

Data Type

Integer

ParsedHeaderField Property (CloudStorage_SharePoint Class)

This property contains the name of the HTTP header (this is the same case as it is delivered).

Object Oriented Interface

public function getParsedHeaderField($parsedheaderindex);

Procedural Interface

cloudstorage_sharepoint_get($res, 47 , $parsedheaderindex);

Default Value

''

Remarks

This property contains the name of the HTTP Header (this is the same case as it is delivered).

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

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

Data Type

String

ParsedHeaderValue Property (CloudStorage_SharePoint Class)

This property contains the header contents.

Object Oriented Interface

public function getParsedHeaderValue($parsedheaderindex);

Procedural Interface

cloudstorage_sharepoint_get($res, 48 , $parsedheaderindex);

Default Value

''

Remarks

This property contains the Header contents.

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

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

Data Type

String

ProxyAuthScheme Property (CloudStorage_SharePoint Class)

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

Object Oriented Interface

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

Procedural Interface

cloudstorage_sharepoint_get($res, 49 );
cloudstorage_sharepoint_set($res, 49, $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 (CloudStorage_SharePoint Class)

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

Object Oriented Interface

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

Procedural Interface

cloudstorage_sharepoint_get($res, 50 );
cloudstorage_sharepoint_set($res, 50, $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 (CloudStorage_SharePoint Class)

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

Object Oriented Interface

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

Procedural Interface

cloudstorage_sharepoint_get($res, 51 );
cloudstorage_sharepoint_set($res, 51, $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 (CloudStorage_SharePoint 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

cloudstorage_sharepoint_get($res, 52 );
cloudstorage_sharepoint_set($res, 52, $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 (CloudStorage_SharePoint 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

cloudstorage_sharepoint_get($res, 53 );
cloudstorage_sharepoint_set($res, 53, $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 (CloudStorage_SharePoint 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

cloudstorage_sharepoint_get($res, 54 );
cloudstorage_sharepoint_set($res, 54, $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 (CloudStorage_SharePoint Class)

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

Object Oriented Interface

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

Procedural Interface

cloudstorage_sharepoint_get($res, 55 );
cloudstorage_sharepoint_set($res, 55, $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

QueryParamCount Property (CloudStorage_SharePoint Class)

The number of records in the QueryParam arrays.

Object Oriented Interface

public function getQueryParamCount();
public function setQueryParamCount($value);

Procedural Interface

cloudstorage_sharepoint_get($res, 56 );
cloudstorage_sharepoint_set($res, 56, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• QueryParamName
• QueryParamValue

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

This property is not available at design time.

Data Type

Integer

QueryParamName Property (CloudStorage_SharePoint Class)

The name of the query parameter.

Object Oriented Interface

public function getQueryParamName($queryparamindex);
public function setQueryParamName($queryparamindex, $value);

Procedural Interface

cloudstorage_sharepoint_get($res, 57 , $queryparamindex);
cloudstorage_sharepoint_set($res, 57, $value , $queryparamindex);

Default Value

''

Remarks

The name of the query parameter.

This property specifies the name of the query parameter.

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

This property is not available at design time.

Data Type

String

QueryParamValue Property (CloudStorage_SharePoint Class)

The value of the query parameter.

Object Oriented Interface

public function getQueryParamValue($queryparamindex);
public function setQueryParamValue($queryparamindex, $value);

Procedural Interface

cloudstorage_sharepoint_get($res, 58 , $queryparamindex);
cloudstorage_sharepoint_set($res, 58, $value , $queryparamindex);

Default Value

''

Remarks

The value of the query parameter.

This property specifies the value of the query parameter. The class will automatically URL-encode this value when sending the request.

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

This property is not available at design time.

Data Type

String

Range Property (CloudStorage_SharePoint Class)

The range of bytes to request.

Object Oriented Interface

public function getRange();
public function setRange($value);

Procedural Interface

cloudstorage_sharepoint_get($res, 59 );
cloudstorage_sharepoint_set($res, 59, $value );

Default Value

''

Remarks

This property specifies the range of bytes to request from the server. If this property is non-empty when a DownloadFile request is being constructed, a header like Range: bytes=Range will be added to the request, with Range substituted with the specified value.

There are two valid formats for this property's value:

• StartByte-
• StartByte-EndByte

Note: If the StartByte property is greater than zero when DownloadFile is called (i.e., when a download is being resumed), and this property is non-empty, the class will automatically advance the StartByte value in the specified range by StartByte bytes when sending the Range header to the server. This ensures that the previously-downloaded data at the start of the specified range is not downloaded again when the download is resumed.

This property is not available at design time.

Data Type

String

RemoteId Property (CloudStorage_SharePoint Class)

Selects a remote resource by Id.

Object Oriented Interface

public function getRemoteId();
public function setRemoteId($value);

Procedural Interface

cloudstorage_sharepoint_get($res, 60 );
cloudstorage_sharepoint_set($res, 60, $value );

Default Value

''

Remarks

This property selects a remote file or folder resource to operate against using its resource Id.

Remote Id and Path Notes

Keep the following things in mind when setting the RemoteId and/or RemotePath properties:

• If both RemoteId and RemotePath are set, RemoteId is used.
• The Id or path provided must always be for a resource that resides in the document library currently selected by DocumentLibrary.
• Some methods operate against only file or only folder resources; while others can operate against either one. Calling a method while RemoteId/RemotePath is set to the Id/path of a resource whose type is unsupported will cause the server to return an error; use the table below to determine which resource types each method supports.

  Method Name	Files	Folders
  CopyResource	X	X
  CreateFolder	-	X
  CreateLink	X	X
  DeleteResource	X	X
  DownloadFile	X	-
  GetResourceInfo	X	X
  ListResources	-	X
  MoveResource	X	X
  Search	-	X
  UpdateResource	X	X
  UploadFile	-	X

  Key: X = Supported; - = Not supported.

• Methods that support only folder resources can also operate against the root of the currently selected document library, just clear both RemoteId and RemotePath.
• Some methods may have other restrictions, refer to each one for more information.

Note: The rules regarding acceptable resource types still apply if using the RelativePath configuration setting in tandem with this property. That is, ensure that the resource that the relative path resolves to is of an acceptable type.

This property is not available at design time.

Data Type

String

RemotePath Property (CloudStorage_SharePoint Class)

Selects a remote resource by path.

Object Oriented Interface

public function getRemotePath();
public function setRemotePath($value);

Procedural Interface

cloudstorage_sharepoint_get($res, 61 );
cloudstorage_sharepoint_set($res, 61, $value );

Default Value

''

Remarks

This property selects a remote file or folder resource to operate against using its path. The path provided must be absolute (that is, relative to the root of the currently selected document library).

Remote Id and Path Notes

Keep the following things in mind when setting the RemoteId and/or RemotePath properties:

• If both RemoteId and RemotePath are set, RemoteId is used.
• The Id or path provided must always be for a resource that resides in the document library currently selected by DocumentLibrary.
• Some methods operate against only file or only folder resources; while others can operate against either one. Calling a method while RemoteId/RemotePath is set to the Id/path of a resource whose type is unsupported will cause the server to return an error; use the table below to determine which resource types each method supports.

  Method Name	Files	Folders
  CopyResource	X	X
  CreateFolder	-	X
  CreateLink	X	X
  DeleteResource	X	X
  DownloadFile	X	-
  GetResourceInfo	X	X
  ListResources	-	X
  MoveResource	X	X
  Search	-	X
  UpdateResource	X	X
  UploadFile	-	X

  Key: X = Supported; - = Not supported.

• Methods that support only folder resources can also operate against the root of the currently selected document library, just clear both RemoteId and RemotePath.
• Some methods may have other restrictions, refer to each one for more information.

This property is not available at design time.

Data Type

String

ResourceData Property (CloudStorage_SharePoint Class)

The data that was downloaded, or that should be uploaded.

Object Oriented Interface

public function getResourceData();
public function setResourceData($value);

Procedural Interface

cloudstorage_sharepoint_get($res, 62 );
cloudstorage_sharepoint_set($res, 62, $value );

Default Value

''

Remarks

This property is populated with file data after calling DownloadFile if LocalFile is not set.

This property can also be set before calling UploadFile; its data will be uploaded if LocalFile is not set.

This property is not available at design time.

Data Type

Binary String

ResourceMarker Property (CloudStorage_SharePoint Class)

A marker indicating what page of resources to return next.

Object Oriented Interface

public function getResourceMarker();
public function setResourceMarker($value);

Procedural Interface

cloudstorage_sharepoint_get($res, 63 );
cloudstorage_sharepoint_set($res, 63, $value );

Default Value

''

Remarks

This property will be populated when ListResources is called if the results are paged and there are more pages. To list all resources, continue to call ListResources until this property returns empty string.

Refer to ListResources for more information.

This property is not available at design time.

Data Type

String

ResourceCount Property (CloudStorage_SharePoint Class)

The number of records in the Resource arrays.

Object Oriented Interface

public function getResourceCount();
public function setResourceCount($value);

Procedural Interface

cloudstorage_sharepoint_get($res, 64 );
cloudstorage_sharepoint_set($res, 64, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• ResourceChildCount
• ResourceCreatedTime
• ResourceDeleted
• ResourceDocumentLibraryId
• ResourceETag
• ResourceHash
• ResourceHashAlgorithm
• ResourceId
• ResourceMIMEType
• ResourceModifiedTime
• ResourceName
• ResourceParentId
• ResourceParentPath
• ResourcePath
• ResourceSize
• ResourceType
• ResourceWebURL

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

This property is not available at design time.

Data Type

Integer

ResourceChildCount Property (CloudStorage_SharePoint Class)

How many children the resource has.

Object Oriented Interface

public function getResourceChildCount($resourceindex);

Procedural Interface

cloudstorage_sharepoint_get($res, 65 , $resourceindex);

Default Value

0

Remarks

How many children the resource has.

This property reflects how many child resources the resource has. For file resources, this property will always be 0.

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

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

Data Type

Integer

ResourceCreatedTime Property (CloudStorage_SharePoint Class)

The creation timestamp of the resource.

Object Oriented Interface

public function getResourceCreatedTime($resourceindex);

Procedural Interface

cloudstorage_sharepoint_get($res, 66 , $resourceindex);

Default Value

''

Remarks

The creation timestamp of the resource.

This property holds the creation timestamp of the resource. Timestamps are formatted according to ISO 8601 and are always in UTC time.

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

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

Data Type

String

ResourceDeleted Property (CloudStorage_SharePoint Class)

Whether this resource has been deleted.

Object Oriented Interface

public function getResourceDeleted($resourceindex);

Procedural Interface

cloudstorage_sharepoint_get($res, 67 , $resourceindex);

Default Value

false

Remarks

Whether this resource has been deleted.

This property reflects whether the resource has been deleted.

Note that this property is only applicable when populated by a call to ListChanges; otherwise, it is always false.

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

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

Data Type

Boolean

ResourceDocumentLibraryId Property (CloudStorage_SharePoint Class)

The Id of the library that contains the resource.

Object Oriented Interface

public function getResourceDocumentLibraryId($resourceindex);

Procedural Interface

cloudstorage_sharepoint_get($res, 68 , $resourceindex);

Default Value

''

Remarks

The Id of the library that contains the resource.

This property holds the Id of the library that contains the resource.

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

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

Data Type

String

ResourceETag Property (CloudStorage_SharePoint Class)

The ETag of the resource.

Object Oriented Interface

public function getResourceETag($resourceindex);

Procedural Interface

cloudstorage_sharepoint_get($res, 69 , $resourceindex);

Default Value

''

Remarks

The ETag of the resource.

This property holds the ETag of the resource.

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

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

Data Type

String

ResourceHash Property (CloudStorage_SharePoint Class)

A hash of the resource's content.

Object Oriented Interface

public function getResourceHash($resourceindex);

Procedural Interface

cloudstorage_sharepoint_get($res, 70 , $resourceindex);

Default Value

''

Remarks

A hash of the resource's content.

The property holds a hash of the resource's content. Only applicable for file resources.

The ResourceHashAlgorithm property determines which hash this property is populated with; this property will be empty if the server didn't return a hash for the currently selected ResourceHashAlgorithm.

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

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

Data Type

String

ResourceHashAlgorithm Property (CloudStorage_SharePoint Class)

The hash's algorithm.

Object Oriented Interface

public function getResourceHashAlgorithm($resourceindex);
public function setResourceHashAlgorithm($resourceindex, $value);

Procedural Interface

cloudstorage_sharepoint_get($res, 71 , $resourceindex);
cloudstorage_sharepoint_set($res, 71, $value , $resourceindex);

Default Value

0

Remarks

The hash's algorithm.

This property specifies which hash the ResourceHash property is populated with. Changing the value of this property will re-populate the ResourceHash property accordingly. Possible values are:

• 0 - QuickXOR hash
• 1 - CRC32 hash
• 2 - SHA1 hash

Note: Hashes are generated by the server, not the class; and it makes no guarantees as to when hashes are generated (it may not do so immediately).

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

This property is not available at design time.

Data Type

Integer

ResourceId Property (CloudStorage_SharePoint Class)

The Id of the resource.

Object Oriented Interface

public function getResourceId($resourceindex);
public function setResourceId($resourceindex, $value);

Procedural Interface

cloudstorage_sharepoint_get($res, 72 , $resourceindex);
cloudstorage_sharepoint_set($res, 72, $value , $resourceindex);

Default Value

''

Remarks

The Id of the resource.

This property holds the Id of the resource.

Either this property or ResourcePath must be set before calling UpdateResource.

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

This property is not available at design time.

Data Type

String

ResourceMIMEType Property (CloudStorage_SharePoint Class)

The MIME type of the resource.

Object Oriented Interface

public function getResourceMIMEType($resourceindex);

Procedural Interface

cloudstorage_sharepoint_get($res, 73 , $resourceindex);

Default Value

''

Remarks

The MIME type of the resource.

This property holds the MIME type of the resource.

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

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

Data Type

String

ResourceModifiedTime Property (CloudStorage_SharePoint Class)

The last modified timestamp of the resource.

Object Oriented Interface

public function getResourceModifiedTime($resourceindex);

Procedural Interface

cloudstorage_sharepoint_get($res, 74 , $resourceindex);

Default Value

''

Remarks

The last modified timestamp of the resource.

This property holds the last modified timestamp of the resource. Timestamps are formatted according to ISO 8601 and are always in UTC time.

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

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

Data Type

String

ResourceName Property (CloudStorage_SharePoint Class)

The name of the resource.

Object Oriented Interface

public function getResourceName($resourceindex);
public function setResourceName($resourceindex, $value);

Procedural Interface

cloudstorage_sharepoint_get($res, 75 , $resourceindex);
cloudstorage_sharepoint_set($res, 75, $value , $resourceindex);

Default Value

''

Remarks

The name of the resource.

This property specifies the name of the resource.

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

This property is not available at design time.

Data Type

String

ResourceParentId Property (CloudStorage_SharePoint Class)

The Id of the resource's parent.

Object Oriented Interface

public function getResourceParentId($resourceindex);
public function setResourceParentId($resourceindex, $value);

Procedural Interface

cloudstorage_sharepoint_get($res, 76 , $resourceindex);
cloudstorage_sharepoint_set($res, 76, $value , $resourceindex);

Default Value

''

Remarks

The Id of the resource's parent.

This property holds the Id of the resource's parent.

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

This property is not available at design time.

Data Type

String

ResourceParentPath Property (CloudStorage_SharePoint Class)

The path of the resource's parent.

Object Oriented Interface

public function getResourceParentPath($resourceindex);
public function setResourceParentPath($resourceindex, $value);

Procedural Interface

cloudstorage_sharepoint_get($res, 77 , $resourceindex);
cloudstorage_sharepoint_set($res, 77, $value , $resourceindex);

Default Value

''

Remarks

The path of the resource's parent.

This property holds the path of the resource's parent.

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

This property is not available at design time.

Data Type

String

ResourcePath Property (CloudStorage_SharePoint Class)

The path of the resource.

Object Oriented Interface

public function getResourcePath($resourceindex);
public function setResourcePath($resourceindex, $value);

Procedural Interface

cloudstorage_sharepoint_get($res, 78 , $resourceindex);
cloudstorage_sharepoint_set($res, 78, $value , $resourceindex);

Default Value

''

Remarks

The path of the resource.

This property holds the path of the resource.

Either this property or ResourceId must be set before calling UpdateResource.

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

This property is not available at design time.

Data Type

String

ResourceSize Property (CloudStorage_SharePoint Class)

The size of the resource in bytes.

Object Oriented Interface

public function getResourceSize($resourceindex);

Procedural Interface

cloudstorage_sharepoint_get($res, 79 , $resourceindex);

Default Value

0

Remarks

The size of the resource in bytes.

For file resources, this property holds the size of the file in bytes.

For folder resources, this property holds the total size (in bytes) of all of its children (recursively).

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

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

Data Type

Long64

ResourceType Property (CloudStorage_SharePoint Class)

The resource's type.

Object Oriented Interface

public function getResourceType($resourceindex);

Procedural Interface

cloudstorage_sharepoint_get($res, 80 , $resourceindex);

Default Value

0

Remarks

The resource's type.

This property indicates whether the resource is a folder or a file. Possible values are:

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

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

Data Type

Integer

ResourceWebURL Property (CloudStorage_SharePoint Class)

The resource's web URL.

Object Oriented Interface

public function getResourceWebURL($resourceindex);

Procedural Interface

cloudstorage_sharepoint_get($res, 81 , $resourceindex);

Default Value

''

Remarks

The resource's web URL.

This property holds the resource's web URL, which can be used to view the resource online.

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

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

Data Type

String

ResumeURL Property (CloudStorage_SharePoint Class)

The resumable upload URL.

Object Oriented Interface

public function getResumeURL();
public function setResumeURL($value);

Procedural Interface

cloudstorage_sharepoint_get($res, 82 );
cloudstorage_sharepoint_set($res, 82, $value );

Default Value

''

Remarks

This property holds the URL of the resumable upload session. This is populated by the class automatically when UseResumableUpload is set to true and UploadFile is called to initiate a new upload.

This must be set in order to resume an interrupted upload. See UploadFile for details.

This property is not available at design time.

Data Type

String

SearchMarker Property (CloudStorage_SharePoint Class)

A marker indicating what page of search results to return next.

Object Oriented Interface

public function getSearchMarker();
public function setSearchMarker($value);

Procedural Interface

cloudstorage_sharepoint_get($res, 83 );
cloudstorage_sharepoint_set($res, 83, $value );

Default Value

''

Remarks

This property will be populated when Search is called if the results are paged and there are more pages. To list all search results, continue to call Search until this property returns empty string.

Refer to Search for more information.

This property is not available at design time.

Data Type

String

SiteId Property (CloudStorage_SharePoint Class)

Selects a SharePoint site.

Object Oriented Interface

public function getSiteId();
public function setSiteId($value);

Procedural Interface

cloudstorage_sharepoint_get($res, 84 );
cloudstorage_sharepoint_set($res, 84, $value );

Default Value

''

Remarks

This property can be set to the Id of a specific SharePoint site to select it for use. When empty (default), the component will use the root site for the authenticated entity.

Data Type

String

SiteInfoCount Property (CloudStorage_SharePoint Class)

The number of records in the SiteInfo arrays.

Object Oriented Interface

public function getSiteInfoCount();

Procedural Interface

cloudstorage_sharepoint_get($res, 85 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• SiteInfoId
• SiteInfoName
• SiteInfoURL

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

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

Data Type

Integer

SiteInfoId Property (CloudStorage_SharePoint Class)

The Id of the SharePoint site.

Object Oriented Interface

public function getSiteInfoId($siteinfoindex);

Procedural Interface

cloudstorage_sharepoint_get($res, 86 , $siteinfoindex);

Default Value

''

Remarks

The Id of the SharePoint site. In the format domain,siteId,webId.

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

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

Data Type

String

SiteInfoName Property (CloudStorage_SharePoint Class)

The name of the site.

Object Oriented Interface

public function getSiteInfoName($siteinfoindex);

Procedural Interface

cloudstorage_sharepoint_get($res, 87 , $siteinfoindex);

Default Value

''

Remarks

The name of the site.

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

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

Data Type

String

SiteInfoURL Property (CloudStorage_SharePoint Class)

The site's web URL which can be used to view the site online.

Object Oriented Interface

public function getSiteInfoURL($siteinfoindex);

Procedural Interface

cloudstorage_sharepoint_get($res, 88 , $siteinfoindex);

Default Value

''

Remarks

The site's web URL which can be used to view the site online

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

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

Data Type

String

SSLAcceptServerCertEffectiveDate Property (CloudStorage_SharePoint Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLAcceptServerCertEffectiveDate();

Procedural Interface

cloudstorage_sharepoint_get($res, 89 );

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

The date on which the certificate expires.

Object Oriented Interface

public function getSSLAcceptServerCertExpirationDate();

Procedural Interface

cloudstorage_sharepoint_get($res, 90 );

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

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLAcceptServerCertExtendedKeyUsage();

Procedural Interface

cloudstorage_sharepoint_get($res, 91 );

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

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

Object Oriented Interface

public function getSSLAcceptServerCertFingerprint();

Procedural Interface

cloudstorage_sharepoint_get($res, 92 );

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

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

Object Oriented Interface

public function getSSLAcceptServerCertFingerprintSHA1();

Procedural Interface

cloudstorage_sharepoint_get($res, 93 );

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

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

Object Oriented Interface

public function getSSLAcceptServerCertFingerprintSHA256();

Procedural Interface

cloudstorage_sharepoint_get($res, 94 );

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

The issuer of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertIssuer();

Procedural Interface

cloudstorage_sharepoint_get($res, 95 );

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

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKey();

Procedural Interface

cloudstorage_sharepoint_get($res, 96 );

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

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKeyAvailable();

Procedural Interface

cloudstorage_sharepoint_get($res, 97 );

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

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

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKeyContainer();

Procedural Interface

cloudstorage_sharepoint_get($res, 98 );

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

The public key of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertPublicKey();

Procedural Interface

cloudstorage_sharepoint_get($res, 99 );

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

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

Object Oriented Interface

public function getSSLAcceptServerCertPublicKeyAlgorithm();

Procedural Interface

cloudstorage_sharepoint_get($res, 100 );

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

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

Object Oriented Interface

public function getSSLAcceptServerCertPublicKeyLength();

Procedural Interface

cloudstorage_sharepoint_get($res, 101 );

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

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLAcceptServerCertSerialNumber();

Procedural Interface

cloudstorage_sharepoint_get($res, 102 );

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

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLAcceptServerCertSignatureAlgorithm();

Procedural Interface

cloudstorage_sharepoint_get($res, 103 );

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

The name of the certificate store for the client certificate.

Object Oriented Interface

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

Procedural Interface

cloudstorage_sharepoint_get($res, 104 );
cloudstorage_sharepoint_set($res, 104, $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 (CloudStorage_SharePoint 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

cloudstorage_sharepoint_get($res, 105 );
cloudstorage_sharepoint_set($res, 105, $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 (CloudStorage_SharePoint Class)

The type of certificate store for this certificate.

Object Oriented Interface

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

Procedural Interface

cloudstorage_sharepoint_get($res, 106 );
cloudstorage_sharepoint_set($res, 106, $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 (CloudStorage_SharePoint Class)

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

Object Oriented Interface

public function getSSLAcceptServerCertSubjectAltNames();

Procedural Interface

cloudstorage_sharepoint_get($res, 107 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintMD5 Property (CloudStorage_SharePoint Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintMD5();

Procedural Interface

cloudstorage_sharepoint_get($res, 108 );

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

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintSHA1();

Procedural Interface

cloudstorage_sharepoint_get($res, 109 );

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

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintSHA256();

Procedural Interface

cloudstorage_sharepoint_get($res, 110 );

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

The text description of UsageFlags .

Object Oriented Interface

public function getSSLAcceptServerCertUsage();

Procedural Interface

cloudstorage_sharepoint_get($res, 111 );

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

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertUsageFlags();

Procedural Interface

cloudstorage_sharepoint_get($res, 112 );

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

The certificate's version number.

Object Oriented Interface

public function getSSLAcceptServerCertVersion();

Procedural Interface

cloudstorage_sharepoint_get($res, 113 );

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

The subject of the certificate used for client authentication.

Object Oriented Interface

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

Procedural Interface

cloudstorage_sharepoint_get($res, 114 );
cloudstorage_sharepoint_set($res, 114, $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 (CloudStorage_SharePoint Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

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

Procedural Interface

cloudstorage_sharepoint_get($res, 115 );
cloudstorage_sharepoint_set($res, 115, $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 (CloudStorage_SharePoint Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLCertEffectiveDate();

Procedural Interface

cloudstorage_sharepoint_get($res, 116 );

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

The date on which the certificate expires.

Object Oriented Interface

public function getSSLCertExpirationDate();

Procedural Interface

cloudstorage_sharepoint_get($res, 117 );

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

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLCertExtendedKeyUsage();

Procedural Interface

cloudstorage_sharepoint_get($res, 118 );

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

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

Object Oriented Interface

public function getSSLCertFingerprint();

Procedural Interface

cloudstorage_sharepoint_get($res, 119 );

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

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

Object Oriented Interface

public function getSSLCertFingerprintSHA1();

Procedural Interface

cloudstorage_sharepoint_get($res, 120 );

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

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

Object Oriented Interface

public function getSSLCertFingerprintSHA256();

Procedural Interface

cloudstorage_sharepoint_get($res, 121 );

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

The issuer of the certificate.

Object Oriented Interface

public function getSSLCertIssuer();

Procedural Interface

cloudstorage_sharepoint_get($res, 122 );

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

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLCertPrivateKey();

Procedural Interface

cloudstorage_sharepoint_get($res, 123 );

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

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLCertPrivateKeyAvailable();

Procedural Interface

cloudstorage_sharepoint_get($res, 124 );

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

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

Object Oriented Interface

public function getSSLCertPrivateKeyContainer();

Procedural Interface

cloudstorage_sharepoint_get($res, 125 );

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

The public key of the certificate.

Object Oriented Interface

public function getSSLCertPublicKey();

Procedural Interface

cloudstorage_sharepoint_get($res, 126 );

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

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

Object Oriented Interface

public function getSSLCertPublicKeyAlgorithm();

Procedural Interface

cloudstorage_sharepoint_get($res, 127 );

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

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

Object Oriented Interface

public function getSSLCertPublicKeyLength();

Procedural Interface

cloudstorage_sharepoint_get($res, 128 );

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

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLCertSerialNumber();

Procedural Interface

cloudstorage_sharepoint_get($res, 129 );

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

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLCertSignatureAlgorithm();

Procedural Interface

cloudstorage_sharepoint_get($res, 130 );

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

The name of the certificate store for the client certificate.

Object Oriented Interface

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

Procedural Interface

cloudstorage_sharepoint_get($res, 131 );
cloudstorage_sharepoint_set($res, 131, $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 (CloudStorage_SharePoint 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

cloudstorage_sharepoint_get($res, 132 );
cloudstorage_sharepoint_set($res, 132, $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 (CloudStorage_SharePoint Class)

The type of certificate store for this certificate.

Object Oriented Interface

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

Procedural Interface

cloudstorage_sharepoint_get($res, 133 );
cloudstorage_sharepoint_set($res, 133, $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 (CloudStorage_SharePoint Class)

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

Object Oriented Interface

public function getSSLCertSubjectAltNames();

Procedural Interface

cloudstorage_sharepoint_get($res, 134 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLCertThumbprintMD5 Property (CloudStorage_SharePoint Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintMD5();

Procedural Interface

cloudstorage_sharepoint_get($res, 135 );

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

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintSHA1();

Procedural Interface

cloudstorage_sharepoint_get($res, 136 );

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

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintSHA256();

Procedural Interface

cloudstorage_sharepoint_get($res, 137 );

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

The text description of UsageFlags .

Object Oriented Interface

public function getSSLCertUsage();

Procedural Interface

cloudstorage_sharepoint_get($res, 138 );

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

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLCertUsageFlags();

Procedural Interface

cloudstorage_sharepoint_get($res, 139 );

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

The certificate's version number.

Object Oriented Interface

public function getSSLCertVersion();

Procedural Interface

cloudstorage_sharepoint_get($res, 140 );

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

The subject of the certificate used for client authentication.

Object Oriented Interface

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

Procedural Interface

cloudstorage_sharepoint_get($res, 141 );
cloudstorage_sharepoint_set($res, 141, $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 (CloudStorage_SharePoint Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

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

Procedural Interface

cloudstorage_sharepoint_get($res, 142 );
cloudstorage_sharepoint_set($res, 142, $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 (CloudStorage_SharePoint 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

cloudstorage_sharepoint_get($res, 143 );
cloudstorage_sharepoint_set($res, 143, $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:

Additional Notes

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

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLServerCertEffectiveDate();

Procedural Interface

cloudstorage_sharepoint_get($res, 144 );

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

The date on which the certificate expires.

Object Oriented Interface

public function getSSLServerCertExpirationDate();

Procedural Interface

cloudstorage_sharepoint_get($res, 145 );

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

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLServerCertExtendedKeyUsage();

Procedural Interface

cloudstorage_sharepoint_get($res, 146 );

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

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

Object Oriented Interface

public function getSSLServerCertFingerprint();

Procedural Interface

cloudstorage_sharepoint_get($res, 147 );

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

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

Object Oriented Interface

public function getSSLServerCertFingerprintSHA1();

Procedural Interface

cloudstorage_sharepoint_get($res, 148 );

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

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

Object Oriented Interface

public function getSSLServerCertFingerprintSHA256();

Procedural Interface

cloudstorage_sharepoint_get($res, 149 );

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

The issuer of the certificate.

Object Oriented Interface

public function getSSLServerCertIssuer();

Procedural Interface

cloudstorage_sharepoint_get($res, 150 );

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

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLServerCertPrivateKey();

Procedural Interface

cloudstorage_sharepoint_get($res, 151 );

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

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLServerCertPrivateKeyAvailable();

Procedural Interface

cloudstorage_sharepoint_get($res, 152 );

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

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

Object Oriented Interface

public function getSSLServerCertPrivateKeyContainer();

Procedural Interface

cloudstorage_sharepoint_get($res, 153 );

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

The public key of the certificate.

Object Oriented Interface

public function getSSLServerCertPublicKey();

Procedural Interface

cloudstorage_sharepoint_get($res, 154 );

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

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

Object Oriented Interface

public function getSSLServerCertPublicKeyAlgorithm();

Procedural Interface

cloudstorage_sharepoint_get($res, 155 );

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

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

Object Oriented Interface

public function getSSLServerCertPublicKeyLength();

Procedural Interface

cloudstorage_sharepoint_get($res, 156 );

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

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLServerCertSerialNumber();

Procedural Interface

cloudstorage_sharepoint_get($res, 157 );

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

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLServerCertSignatureAlgorithm();

Procedural Interface

cloudstorage_sharepoint_get($res, 158 );

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

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLServerCertStore();

Procedural Interface

cloudstorage_sharepoint_get($res, 159 );

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 (CloudStorage_SharePoint 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

cloudstorage_sharepoint_get($res, 160 );

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

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLServerCertStoreType();

Procedural Interface

cloudstorage_sharepoint_get($res, 161 );

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

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

Object Oriented Interface

public function getSSLServerCertSubjectAltNames();

Procedural Interface

cloudstorage_sharepoint_get($res, 162 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertThumbprintMD5 Property (CloudStorage_SharePoint Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintMD5();

Procedural Interface

cloudstorage_sharepoint_get($res, 163 );

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

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintSHA1();

Procedural Interface

cloudstorage_sharepoint_get($res, 164 );

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

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintSHA256();

Procedural Interface

cloudstorage_sharepoint_get($res, 165 );

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

The text description of UsageFlags .

Object Oriented Interface

public function getSSLServerCertUsage();

Procedural Interface

cloudstorage_sharepoint_get($res, 166 );

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

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLServerCertUsageFlags();

Procedural Interface

cloudstorage_sharepoint_get($res, 167 );

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

The certificate's version number.

Object Oriented Interface

public function getSSLServerCertVersion();

Procedural Interface

cloudstorage_sharepoint_get($res, 168 );

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

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLServerCertSubject();

Procedural Interface

cloudstorage_sharepoint_get($res, 169 );

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

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLServerCertEncoded();

Procedural Interface

cloudstorage_sharepoint_get($res, 170 );

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

StartByte Property (CloudStorage_SharePoint Class)

The byte offset from which to start the upload or download.

Object Oriented Interface

public function getStartByte();
public function setStartByte($value);

Procedural Interface

cloudstorage_sharepoint_get($res, 171 );
cloudstorage_sharepoint_set($res, 171, $value );

Default Value

0

Remarks

This property may be set to resume an upload or download; it specifies the offset in the file from which to resume. See UploadFile and DownloadFile for details about resuming uploads and downloads.

This property is not available at design time.

Data Type

Long64

Timeout Property (CloudStorage_SharePoint Class)

The timeout for the class.

Object Oriented Interface

public function getTimeout();
public function setTimeout($value);

Procedural Interface

cloudstorage_sharepoint_get($res, 172 );
cloudstorage_sharepoint_set($res, 172, $value );

Default Value

60

Remarks

If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If Timeout is set to a positive value, the class will wait for the operation to complete before returning control.

The class will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not freeze and remains responsive.

If Timeout expires, and the operation is not yet complete, the class fails with an error.

Note: By default, all timeouts are inactivity timeouts, that is, the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the Timeout property is 60 seconds.

Data Type

Integer

UseResumableUpload Property (CloudStorage_SharePoint Class)

Whether to use resumable uploads.

Object Oriented Interface

public function getUseResumableUpload();
public function setUseResumableUpload($value);

Procedural Interface

cloudstorage_sharepoint_get($res, 173 );
cloudstorage_sharepoint_set($res, 173, $value );

Default Value

false

Remarks

This property controls whether simple or resumable uploads are used when UploadFile is called. The default value is false (simple uploads are used).

Refer to UploadFile for more information.

This property is not available at design time.

Data Type

Boolean

AbortUpload Method (CloudStorage_SharePoint Class)

Aborts the current resumable upload session.

Object Oriented Interface

public function doAbortUpload();

Procedural Interface

cloudstorage_sharepoint_do_abortupload($res);

Remarks

This method aborts the current resumable upload session specified by ResumeURL. It may be called if the current resumable upload has been interrupted and will not be resumed.

AddQueryParam Method (CloudStorage_SharePoint Class)

Adds a query parameter to the QueryParams properties.

Object Oriented Interface

public function doAddQueryParam($name, $value);

Procedural Interface

cloudstorage_sharepoint_do_addqueryparam($res, $name, $value);

Remarks

This method is used to add a query parameter to the QueryParams properties. Name specifies the name of the parameter, and Value specifies the value of the parameter.

All specified Values will be URL encoded by the class automatically. Consult the service documentation for details on the available parameters.

Authorize Method (CloudStorage_SharePoint Class)

Get the authorization string required to access the protected resource.

Object Oriented Interface

public function doAuthorize();

Procedural Interface

cloudstorage_sharepoint_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.

CalcAuthorization Method (CloudStorage_SharePoint Class)

Calculates the Authorization header based on provided credentials.

Object Oriented Interface

public function doCalcAuthorization();

Procedural Interface

cloudstorage_sharepoint_do_calcauthorization($res);

Remarks

This method calculates the Authorization value using the values provided in AuthScheme, User and Password.

In most cases this method does not need to be called. The class will automatically calculate any required authorization values when a method is called such as Get or Post.

This method may be useful in cases where the Authorization value needs to be calculated prior to sending a request.

Config Method (CloudStorage_SharePoint Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

cloudstorage_sharepoint_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.

CopyResource Method (CloudStorage_SharePoint Class)

Copies the currently selected resource.

Object Oriented Interface

public function doCopyResource($parentid, $newname);

Procedural Interface

cloudstorage_sharepoint_do_copyresource($res, $parentid, $newname);

Remarks

This method copies the resource currently selected by RemoteId or RemotePath. The following outcomes are possible depending on which of NewName and ParentId are provided:

ParentId, if provided, must either be the Id of a folder resource that already exists in the document library currently selected by DocumentLibrary, or root (an alias for the root of the document library).

Monitoring Copy Operations

All copy operations are asynchronous. After calling CopyResource, the CopyStatusURL configuration setting will be populated with a copy operation monitor URL.

The PollCopyStatus method can be used to retrieve the latest status of the copy operation specified by the CopyStatusURL configuration setting. Calling PollCopyStatus will populate the CopyPercentDone, CopyStatus, and (if applicable) CopiedResourceId properties.

CreateFolder Method (CloudStorage_SharePoint Class)

Creates a new folder resource.

Object Oriented Interface

public function doCreateFolder($foldername);

Procedural Interface

cloudstorage_sharepoint_do_createfolder($res, $foldername);

Remarks

This method creates a new folder resource, with the given FolderName, within the folder resource currently selected by RemoteId or RemotePath. The Id of the newly-created folder resource is returned.

If the ClientCreatedTime and/or ClientModifiedTime configuration settings are non-empty when this method is called, the corresponding timestamps will be submitted with the folder creation request.

Name Conflict Resolution

If the RenameIfExists configuration setting is enabled when this method is called, and the desired FolderName is already in use, the server will modify the name of the new folder resource to be unique. Refer to the RenameIfExists configuration setting for more information.

CreateLink Method (CloudStorage_SharePoint Class)

Creates a resource sharing link.

Object Oriented Interface

public function doCreateLink($readonly);

Procedural Interface

cloudstorage_sharepoint_do_createlink($res, $readonly);

Remarks

This method creates and returns a sharing link for the resource currently selected by RemoteId or RemotePath. The ReadOnly parameter controls whether the link provides view-only or editing access to the resource in question.

The CreateLinkScope configuration setting can also be used to control the access scope used to create the link. // Create a read-only shared link for the given file. sharepoint.RemotePath = "/work_stuff/serious_business/best_cat_pictures.zip"; string sharingUrl = sharepoint.CreateLink(true);

DeleteResource Method (CloudStorage_SharePoint Class)

Deletes the currently selected resource.

Object Oriented Interface

public function doDeleteResource();

Procedural Interface

cloudstorage_sharepoint_do_deleteresource($res);

Remarks

This method deletes the resource currently selected by RemoteId or RemotePath. When deleting a folder resource, all of its contents are also deleted.

Important: Resources are deleted permanently!

DownloadFile Method (CloudStorage_SharePoint Class)

Downloads the currently selected file resource.

Object Oriented Interface

public function doDownloadFile();

Procedural Interface

cloudstorage_sharepoint_do_downloadfile($res);

Remarks

This method downloads the file resource currently selected by RemoteId or RemotePath.

If LocalFile is set, the file will be saved to the specified location; otherwise, the file data will be held by ResourceData.

To download and decrypt an encrypted file, set EncryptionAlgorithm and EncryptionPassword before calling this method.

Download Notes

In the simplest use-case, downloading a file looks like this: sharepoint.LocalFile = "../MyFile.zip"; sharepoint.RemoteId = sharepoint.Resources[0].Id; sharepoint.DownloadFile();

Resuming Downloads

The class also supports resuming failed downloads by using the StartByte property. If a download is interrupted, set StartByte to the appropriate offset before calling this method to resume the download. string downloadFile = "../MyFile.zip"; sharepoint.LocalFile = downloadFile; sharepoint.RemoteId = sharepoint.Resources[0].Id; sharepoint.DownloadFile(); //The transfer is interrupted and DownloadFile() above fails. Later, resume the download: //Get the size of the partially downloaded file sharepoint.StartByte = new FileInfo(downloadFile).Length; sharepoint.DownloadFile();

Resuming Encrypted File Downloads

Resuming encrypted file downloads is only supported when LocalFile was set in the initial download attempt.

If LocalFile is set when beginning an encrypted download, the class creates a temporary file in TempPath to hold the encrypted data until the download is complete. If the download is interrupted, DownloadTempFile will be populated with the path of the temporary file that holds the partial data.

To resume, DownloadTempFile must be populated, along with StartByte, to allow the remainder of the encrypted data to be downloaded. Once the encrypted data is downloaded it will be decrypted and written to LocalFile. sharepoint.LocalFile = "../MyFile.zip"; sharepoint.EncryptionPassword = "password"; sharepoint.RemoteId = sharepoint.Resources[0].Id; sharepoint.DownloadFile(); //The transfer is interrupted and DownloadFile() above fails. Later, resume the download: //Get the size of the partially download temp file sharepoint.StartByte = new FileInfo(sharepoint.Config("DownloadTempFile")).Length; sharepoint.DownloadFile();

GetCurrentChangeMarker Method (CloudStorage_SharePoint Class)

Gets the most current change marker.

Object Oriented Interface

public function doGetCurrentChangeMarker();

Procedural Interface

cloudstorage_sharepoint_do_getcurrentchangemarker($res);

Remarks

This method populates NextChangeMarker with the most current change marker available.

Refer to ListChanges for more information.

GetDocumentLibraryInfo Method (CloudStorage_SharePoint Class)

Gets information about the currently selected document library.

Object Oriented Interface

public function doGetDocumentLibraryInfo();

Procedural Interface

cloudstorage_sharepoint_do_getdocumentlibraryinfo($res);

Remarks

This method retrieves information about the document library currently selected by DocumentLibrary.

Calling this method will fire the DocumentLibraryList event, and will populate the DocumentLibraries properties with a single item (clearing any previously-held items in the process).

GetResourceInfo Method (CloudStorage_SharePoint Class)

Gets information about the currently selected resource.

Object Oriented Interface

public function doGetResourceInfo();

Procedural Interface

cloudstorage_sharepoint_do_getresourceinfo($res);

Remarks

This method retrieves information about the resource currently selected by RemoteId or RemotePath.

Calling this method will fire the ResourceList event, and will populate the Resources properties with a single item (clearing any previously-held items in the process).

Interrupt Method (CloudStorage_SharePoint Class)

This method interrupts the current method.

Object Oriented Interface

public function doInterrupt();

Procedural Interface

cloudstorage_sharepoint_do_interrupt($res);

Remarks

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

ListChanges Method (CloudStorage_SharePoint Class)

Lists changes to resources in the currently selected document library.

Object Oriented Interface

public function doListChanges();

Procedural Interface

cloudstorage_sharepoint_do_listchanges($res);

Remarks

This method lists changes to resources in the document library currently selected by DocumentLibrary.

Starting from a Baseline State

For most use-cases, it is necessary to obtain a baseline of the full document library hierarchy in order to have a context onto which later changes can be applied.

To obtain a full document library hierarchy baseline, ensure that both ChangeMarker and NextChangeMarker are empty, and then call ListChanges. Then follow the process described in the "General Usage" section (below) until ChangeMarker is empty, keeping in mind that the results being returned are not necessarily* changes, but rather the current state of all resources in the document library.

*If any resources in the document library are changed before all result pages of the baseline have been returned, SharePoint may append those change items to the end of the baseline's results. Refer to the "Usage Considerations" section (below) for more information.

Starting from the Latest State

For use-cases that don't require a baseline (e.g., perhaps an application just displays a "ticker" with change information), call GetCurrentChangeMarker. This will populate NextChangeMarker immediately.

General Usage

When this method is called, it will use the change marker stored in either ChangeMarker or NextChangeMarker (only one can be populated at a time) to request the next page of changes. This method causes the ResourceList event to fire once for each change, and will also populate the Resources properties.

If there are still more changes available to list when this method returns, the ChangeMarker property will be populated. Continue to call this method until ChangeMarker is empty to accumulate all pages of results in the Resources properties. (Once there aren't any more changes available to list, the NextChangeMarker property will be populated instead.) Alternatively, the AccumulatePages configuration setting can be disabled to clear the Resources properties every time a page of results is returned.

When NextChangeMarker is populated, it is always populated with a value that (at the time of population) points to the most current state. (Since "the most current state" implies that there are no further changes to list, calling ListChanges immediately after NextChangeMarker is populated will not return any further changes.)

Example of Getting a Baseline and then Listing Changes // Get a full document library hierarchy baseline first. Sharepoint sharepoint = new Sharepoint(); sharepoint.ListChanges(); do { // Continue to call ListChanges() until ChangeMarker is the empty string (indicating there // are no more changes to list). sharepoint.ListChanges(); } while (sharepoint.ChangeMarker.Length > 0); for (int i = 0; i < sharepoint.Resources.Count; i++) { // Apply the baseline document library state. } // Now NextChangeMarker will be populated. If we were to call ListChanges() again right now, // nothing would be listed and NextChangeMarker would still be populated. // Wait 2 minutes and then try to list changes again. Assume something changes while we wait. Thread.Sleep(120000); sharepoint.ListChanges(); do { sharepoint.ListChanges(); } while (sharepoint.ChangeMarker.Length > 0); for (int i = 0; i < sharepoint.Resources.Count; i++) { // Apply the changes. }

Usage Considerations

Keep the following things in mind when working with SharePoint changes:

• When listing changes, certain resource properties are not included. For example, resource paths are not returned; always use resource Ids when tracking changes.
• It is possible for a resource, uniquely identified by its Id, to appear more than once in a change set. (This can happen if changes are being listed, and then a change occurs before all result pages in the change set are returned; SharePoint will then typically append the new change to the end of the current change set.) Since a SharePoint change always reflects the latest state of a resource, just use the latest one.
• SharePoint will report a change when a resource is created, renamed, modified, or deleted; but it only explicitly specifies deletions. However, it is easy to differentiate between the other change events by keeping track of resource Ids, names, and last modified times; and then comparing old and new values when changes arrive.

ListDocumentLibraries Method (CloudStorage_SharePoint Class)

Lists the document libraries in the current site.

Object Oriented Interface

public function doListDocumentLibraries();

Procedural Interface

cloudstorage_sharepoint_do_listdocumentlibraries($res);

Remarks

This method lists the document libraries contained in the current site that is set by the SiteId property.

Calling this method will fire the DocumentLibraryList event once for each document library, and will also populate the DocumentLibraries properties.

If there are still more document libraries available to list when this method returns, the DocumentLibraryMarker property will be populated. Continue to call this method until DocumentLibraryMarker is empty to accumulate all pages of results in the DocumentLibraries properties. Alternatively, the AccumulatePages configuration setting can be disabled to clear the DocumentLibraries properties every time a page of results is returned.

ListResources Method (CloudStorage_SharePoint Class)

Lists resources in the currently selected folder.

Object Oriented Interface

public function doListResources();

Procedural Interface

cloudstorage_sharepoint_do_listresources($res);

Remarks

This method lists resources in the folder resource currently selected by RemoteId or RemotePath.

Calling this method will fire the ResourceList event once for each resource, and will also populate the Resources properties.

If there are still more resources available to list when this method returns, the ResourceMarker property will be populated. Continue to call this method until ResourceMarker is empty to accumulate all pages of results in the Resources properties. Alternatively, the AccumulatePages configuration setting can be disabled to clear the Resources properties every time a page of results is returned.

For more complex queries, use the Search method. // ResourceList event handler. sharepoint.OnResourceList += (s, e) => { Console.WriteLine(e.Name); }; // (Assume that the RemoteId property isn't set; it takes precedence if it is.) sharepoint.RemotePath = "/work_files/serious_business/cats"; do { sharepoint.ListResources(); for (int i = 0; i < sharepoint.Resources.Count; i++) { // Process resources here. } } while (!string.IsNullOrEmpty(sharepoint.ResourceMarker));

ListSites Method (CloudStorage_SharePoint Class)

List the sites currently accessible by the authenticated entity.

Object Oriented Interface

public function doListSites();

Procedural Interface

cloudstorage_sharepoint_do_listsites($res);

Remarks

This method lists the sites of the currently authenticated entity. Calling this method will fire the SiteList event once for each site, and will also clear and populate the Sites properties.

The exact endpoint that is requested (and the parameters for the request) can be modified by the ListSitesParams configuration setting. For example, this setting can be changed to make a search or list the subsites of a specified site. See the ListSitesParams entry for more information.

Basic List sharepoint.ListSites(); string siteId = sharepoint.Sites[0].Id; Subsite List sharepoint.Config($"ListSitesParams=/{parantSiteId}/sites"); sharepoint.ListSites(); string childSiteId = sharepoint.Sites[0].Id;

MoveResource Method (CloudStorage_SharePoint Class)

Moves the currently selected resource.

Object Oriented Interface

public function doMoveResource($parentid);

Procedural Interface

cloudstorage_sharepoint_do_moveresource($res, $parentid);

Remarks

This method moves the resource currently selected by RemoteId or RemotePath to the folder specified by ParentId.

ParentId must either be the Id of a folder resource that already exists in the document library currently selected by DocumentLibrary, or root (an alias for the root of the document library).

PollCopyStatus Method (CloudStorage_SharePoint Class)

Gets the status of a copy operation.

Object Oriented Interface

public function doPollCopyStatus();

Procedural Interface

cloudstorage_sharepoint_do_pollcopystatus($res);

Remarks

This method retrieves the latest status information for the copy operation specified by the CopyStatusURL configuration setting.

After calling this method, the CopyPercentDone, CopyStatus, and (if applicable) CopiedResourceId properties will be populated.

Refer to CopyResource, as well as the properties mentioned above, for more information.

PollUploadStatus Method (CloudStorage_SharePoint Class)

Gets the status of the current resumable upload session.

Object Oriented Interface

public function doPollUploadStatus();

Procedural Interface

cloudstorage_sharepoint_do_polluploadstatus($res);

Remarks

This method retrieves the status of the resumable upload session specified by ResumeURL.

After calling this method, the StartByte property and UploadExpDate configuration setting will be populated.

Reset Method (CloudStorage_SharePoint Class)

Resets the class to its initial state.

Object Oriented Interface

public function doReset();

Procedural Interface

cloudstorage_sharepoint_do_reset($res);

Remarks

This method resets the class to its initial state.

Search Method (CloudStorage_SharePoint Class)

Searches for resources that match the specified query.

Object Oriented Interface

public function doSearch($query);

Procedural Interface

cloudstorage_sharepoint_do_search($res, $query);

Remarks

This method searches for resources that match the given Query within the folder resource currently selected by RemoteId or RemotePath. The value provided for Query will automatically be URL-encoded.

Calling this method will fire the ResourceList event once for each search result, and will also populate the Resources properties.

If there are still more search results available to list when this method returns, the SearchMarker property will be populated. Continue to call this method until SearchMarker is empty to accumulate all pages of results in the Resources properties.

SendCustomRequest Method (CloudStorage_SharePoint Class)

Sends a custom request to the Microsoft Graph API.

Object Oriented Interface

public function doSendCustomRequest($httpmethod, $requestpath, $requestbody);

Procedural Interface

cloudstorage_sharepoint_do_sendcustomrequest($res, $httpmethod, $requestpath, $requestbody);

Remarks

This method can be used to send arbitrary requests to the Microsoft Graph API.

Valid values for HttpMethod are:

• GET (default if empty)
• HEAD
• POST
• PUT
• PATCH
• DELETE

The value passed for RequestPath must already be URL-encoded in a manner acceptable to the Microsoft Graph API. The RequestBody parameter may be empty if not needed.

Usage

When this method is called, the class does the following:

1. Builds a request URL, including query parameters, as follows:
   • The specified RequestPath is appended to the Microsoft Graph API's "stable" endpoint, https://graph.microsoft.com/v1.0 (however, see note below).
   • All query parameters in the QueryParams properties are added to the request URL.
2. Sends the request using the specified HttpMethod, the request URL build in step 1, the header information held by Authorization and OtherHeaders, and the given RequestBody (if non-empty).
3. Stores the response headers in the ParsedHeaders properties, and the response body in the specified LocalFile, or ResourceData (using the same logic as DownloadFile).

If the response body is JSON data, the XPath, XText, and other X* configuration settings can then be used to navigate and extract information from it.

Note: Some responses returned by the Graph API include fully-qualified Graph API URLs for clients to use to obtain additional information (the next page of results in a listing, details about a long-running operation, etc.). As a convenience, any fully-qualified URL that begins with https://graph.microsoft.com/ can be passed for RequestPath to have the class make a request against it.

UpdateResource Method (CloudStorage_SharePoint Class)

Updates the currently selected resource.

Object Oriented Interface

public function doUpdateResource();

Procedural Interface

cloudstorage_sharepoint_do_updateresource($res);

Remarks

This method updates the metadata for the file or folder resource currently selected by RemoteId or RemotePath. For file resources, the file data can optionally be updated as well.

Usage

There must be a SharePointResource properties whose ResourceId or ResourcePath property matches RemoteId or RemotePath before this method is called.

1. If necessary, call GetResourceInfo or ListResources to ensure an item with the resource's latest information is present in the Resources properties.
2. Modify the item's Resource* properties as desired; the following properties are supported:
   • ResourceDescription (only updated if not empty)
   • ResourceName
   • ResourceParentId (only updated if not empty)
   • ResourceParentPath (only updated if not empty and ResourceParentId is empty)
   If the ClientCreatedTime and/or ClientModifiedTime configuration settings is non-empty, the corresponding timestamps will be sent as well.
3. For file resources, you may set LocalFile or ResourceData if you wish to update the file data on the server. (Refer to UploadFile for more information about simple vs. resumable uploads and encrypting the file data before uploading.)
4. Finally, call this method to update the resource.

// Load the latest information about the resource into the Resources collection. sharepoint.RemotePath = "/folder/CoolStuff1.txt"; sharepoint.GetResourceInfo(); // We'll update the file resource's name, description, and content. sharepoint.ResourceData = "new file content"; sharepoint.Resources[0].Name = "CoolStuff2.txt"; sharepoint.Resources[0].Description = "This is a text file with cool stuff in it"; sharepoint.UpdateResource();

Name Conflict Resolution

When updating a resource's name and/or parent, keep in mind that the server's name conflict resolution behavior will follow these steps:

1. If the RenameIfExists configuration setting is enabled, the server will modify the new name of the resource to be unique, if necessary. Refer to the RenameIfExists configuration setting for more information.
2. Otherwise, if the Overwrite property is enabled, the server will replace the existing (other) resource with the one being updated.
3. Otherwise, the server will return an error.

UploadFile Method (CloudStorage_SharePoint Class)

Uploads a new file resource.

Object Oriented Interface

public function doUploadFile($filename);

Procedural Interface

cloudstorage_sharepoint_do_uploadfile($res, $filename);

Remarks

This method uploads a new file resource, with the given FileName (which should include a file extension), to the folder resource currently selected by RemoteId or RemotePath. The Id of the newly-created file resource is returned.

If the ClientCreatedTime and/or ClientModifiedTime configuration settings are non-empty when this method is called, the corresponding timestamps will be submitted with the file upload request.

If LocalFile is set the file will be uploaded from the specified path. If LocalFile is not set the data in ResourceData will be used.

To encrypt the file before uploading it, set EncryptionAlgorithm and EncryptionPassword.

Upload Notes

SharePoint offers two ways to upload a file. For smaller files a simple upload option is provided to upload data in one request. This is the default option. For larger files, uploads can be fragmented into multiple pieces, allowing resuming of uploads that may be interrupted.

Simple

By default the class uses the simple upload mechanism. sharepoint.LocalFile = "../MyFile.zip"; sharepoint.UploadFile("MyFile.zip");

Resumable

To enable resumable uploads set UseResumableUpload to true. This is recommended for large files. The class will automatically fragment the specified file into smaller pieces and upload each individually. FragmentSize may be set to specify the size of the fragment if desired. The default fragment size is 10 MB.

When UseResumableUpload is set to true and UploadFile is called, a resumable upload session is started by the class. ResumeURL is populated with a URL identifying the session (this value may be needed for additional operations if the upload does not complete normally).

During a resumable upload, the FragmentComplete event fires after each fragment is uploaded to indicate overall progress. The class also updates StartByte as necessary to indicate the current offset in the file.

If the upload is interrupted for any reason, resuming it is easy. First, verify that ResumeURL and StartByte are populated (if the same instance of the class is used, they should already be populated, and no special action should be needed). Then call UploadFile again to resume the upload at the specified StartByte offset.

Note that if the upload is not resumed after some time the upload session will expire. PollUploadStatus may be used to check the status of a resumable upload, including when it will expire (which is stored in the UploadExpDate configuration setting). An interrupted upload can be aborted explicitly using the AbortUpload method. sharepoint.LocalFile = "../MyFile.zip"; sharepoint.UploadFile("MyFile.zip"); //The transfer is interrupted and UploadFile() above fails. Later, resume the download. //Using the same instance StartByte and ResumeURL are already populated from the previous //upload attempt. sharepoint.UploadFile("MyFile.zip");

Name Conflict Resolution

If the desired FileName is already in use, the server's name conflict resolution behavior will follow these steps:

1. If the RenameIfExists configuration setting is enabled, the server will modify the name of the new file resource to be unique. Refer to the RenameIfExists configuration setting for more information.
2. Otherwise, if the Overwrite property is enabled, the server will replace the existing file resource with the newly-uploaded one.
3. Otherwise, the server will return an error.

DocumentLibraryList Event (CloudStorage_SharePoint Class)

Fires once for each document library returned when listing document libraries.

Object Oriented Interface

public function fireDocumentLibraryList($param);

Procedural Interface

cloudstorage_sharepoint_register_callback($res, 1, array($this, 'fireDocumentLibraryList'));

Parameter List

 'id'
 'name'
 'description'
 'ownerid'
 'ownername'

Remarks

This event fires once for each document libraries returned when ListDocumentLibraries or GetDocumentLibraryInfo is called.

Id is the Id of the document library.

Name is the name of the document library.

Description holds the description of the document library.

OwnerId is the Id of the document library's owner.

OwnerName is the name of the document library's owner.

EndTransfer Event (CloudStorage_SharePoint Class)

This event fires when a document finishes transferring.

Object Oriented Interface

public function fireEndTransfer($param);

Procedural Interface

cloudstorage_sharepoint_register_callback($res, 2, array($this, 'fireEndTransfer'));

Parameter List

 'direction'

Remarks

The EndTransfer event is fired when the document text finishes transferring from the server to the local host.

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

Error Event (CloudStorage_SharePoint Class)

Fired when information is available about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

cloudstorage_sharepoint_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.

FragmentComplete Event (CloudStorage_SharePoint Class)

Fires after each fragment of a resumable upload is completed.

Object Oriented Interface

public function fireFragmentComplete($param);

Procedural Interface

cloudstorage_sharepoint_register_callback($res, 4, array($this, 'fireFragmentComplete'));

Parameter List

 'fragmentnumber'
 'fragmentcount'
 'interrupt'

Remarks

When UseResumableUpload is true and UploadFile is called, this event will fire after each fragment is uploaded, providing an indication of overall upload progress.

FragmentNumber is the number of the current fragment that has completed. This value starts at 1.

FragmentCount is the total number of fragments that will be uploaded.

Interrupt can be set to true to interrupt the upload. The upload may be resumed later.

Header Event (CloudStorage_SharePoint Class)

Fired every time a header line comes in.

Object Oriented Interface

public function fireHeader($param);

Procedural Interface

cloudstorage_sharepoint_register_callback($res, 5, array($this, 'fireHeader'));

Parameter List

 'field'
 'value'

Remarks

The Field parameter contains the name of the HTTP header (which is the same as it is delivered). The Value parameter contains the header contents.

If the header line being retrieved is a continuation header line, then the Field parameter contains "" (empty string).

Log Event (CloudStorage_SharePoint Class)

Fired once for each log message.

Object Oriented Interface

public function fireLog($param);

Procedural Interface

cloudstorage_sharepoint_register_callback($res, 6, 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"

Progress Event (CloudStorage_SharePoint Class)

Fires during an upload or download to indicate transfer progress.

Object Oriented Interface

public function fireProgress($param);

Procedural Interface

cloudstorage_sharepoint_register_callback($res, 7, array($this, 'fireProgress'));

Parameter List

 'direction'
 'bytestransferred'
 'totalbytes'
 'percentdone'

Remarks

This event fires during an upload or download to indicate the progress of the transfer of the entire request. By default, this event will fire each time PercentDone increases by one percent; the ProgressStep configuration setting can be used to alter this behavior.

Direction indicates whether the transfer is an upload (0) or a download (1).

BytesTransferred reflects the number of bytes that have been transferred so far, or 0 if the transfer is starting (however, see note below).

TotalBytes reflects the total number of bytes that are to be transferred, or -1 if the total is unknown. This amount includes the size of everything in the request like HTTP headers.

PercentDone reflects the overall progress of the transfer, or -1 if the progress cannot be calculated.

Note: By default, the class tracks transfer progress absolutely. If a transfer is interrupted and later resumed, the values reported by this event upon and after resumption will account for the data that was transferred before the interruption.

For example, if 10MB of data was successfully transferred before the interruption, then this event will fire with a BytesTransferred value of 10485760 (10MB) when the transfer is first resumed, and then continue to fire with successively greater values as usual.

This behavior can be changed by disabling the ProgressAbsolute configuration setting, in which case the class will treat resumed transfers as "new" transfers. In this case, the BytesTransferred parameter will always be 0 the first time this event fires, regardless of whether the transfer is new or being resumed.

ResourceList Event (CloudStorage_SharePoint Class)

Fires once for each resource returned when listing resources or changes.

Object Oriented Interface

public function fireResourceList($param);

Procedural Interface

cloudstorage_sharepoint_register_callback($res, 8, array($this, 'fireResourceList'));

Parameter List

 'id'
 'name'
 'path'
 'resourcetype'
 'createdtime'
 'modifiedtime'
 'size'
 'etag'
 'deleted'

Remarks

This event fires once for each resource returned when ListResources, GetResourceInfo, Search, or ListChanges is called.

Id is the Id of the resource.

Name is the name of the resource.

Path is the path to the resource on the server. This parameter will always be empty for ListChanges.

ResourceType reflects the resource's type. Possible values are:

CreatedTime and ModifiedTime reflect the resource's creation and last modified timestamps. Timestamps are formatted according to ISO 8601 and are always in UTC time.

Size is the size of the resource (for folders, their contents' total size), in bytes. This parameter will always be -1 for ListChanges.

ETag is the ETag of the resource.

Deleted indicates whether the resource has been deleted. This parameter is only applicable for ListChanges, it will always be false otherwise.

SiteList Event (CloudStorage_SharePoint Class)

Fires once for each site returned when listing sites.

Object Oriented Interface

public function fireSiteList($param);

Procedural Interface

cloudstorage_sharepoint_register_callback($res, 9, array($this, 'fireSiteList'));

Parameter List

 'id'
 'name'
 'url'

Remarks

This event fires once for each site returned when ListSites is called.

Id is the Id of the site.

Name is the name of the site.

URL is the site's web URL which can be used to view the site online.

SSLServerAuthentication Event (CloudStorage_SharePoint Class)

Fired after the server presents its certificate to the client.

Object Oriented Interface

public function fireSSLServerAuthentication($param);

Procedural Interface

cloudstorage_sharepoint_register_callback($res, 10, 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 (CloudStorage_SharePoint Class)

Fired when secure connection progress messages are available.

Object Oriented Interface

public function fireSSLStatus($param);

Procedural Interface

cloudstorage_sharepoint_register_callback($res, 11, 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.

StartTransfer Event (CloudStorage_SharePoint Class)

This event fires when a document starts transferring (after the headers).

Object Oriented Interface

public function fireStartTransfer($param);

Procedural Interface

cloudstorage_sharepoint_register_callback($res, 12, array($this, 'fireStartTransfer'));

Parameter List

 'direction'

Remarks

The StartTransfer event is fired when the document text starts transferring from the server to the local host.

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

Transfer Event (CloudStorage_SharePoint Class)

Fired while a document transfers (delivers document).

Object Oriented Interface

public function fireTransfer($param);

Procedural Interface

cloudstorage_sharepoint_register_callback($res, 13, 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 (SharePoint Class)

The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

SharePoint Config Settings

OAuth Config Settings

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

Socket Config Settings

Base Config Settings

Trappable Errors (SharePoint Class)

Common Errors

The class may also return one of the following error codes, which are inherited from other classes.

HTTP Errors

The class may also return one of the following error codes, which are inherited from other classes.

TCPClient Errors

SSL Errors

TCP/IP Errors