SharePoint Component

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

nsoftware.CloudStorage.Sharepoint

Remarks

The SharePoint component 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 component requires authentication via OAuth 2.0. First, perform OAuth authentication using the OAuth property to set the appropriate fields for the chosen ClientProfile and GrantType.

The component has the following default ServerAuthURL and ServerTokenURL fields. Additionally, below is a common scope for the component:

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

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

Application Profile

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

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

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

Authorization Code

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

Example: Sharepoint sharepoint = new Sharepoint(); sharepoint.OAuth.ClientProfile = OAuthClientProfiles.cocpApplication; sharepoint.OAuth.GrantType = OAuthGrantTypes.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 component will act as a service instead of authorizing and authenticating as a user. This allows for the component to avoid user interaction. This is typically used when running in an application that can not have user access. This grant type requires additional set up to be done in the service providers portal before it can be used. For this GrantType the component expects a ClientId, ClientSecret, and ServerTokenURL to be set. When the Authorize method is called, the component will make a request to the token server for an access token. The token server will return an access token if the application has the authorization to do so. When this access token is expired, the component will automatically (see above for detailed description) make a new request to get a fresh one.

Implicit

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

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

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

Password

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

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

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

Web Profile

External OAuth Support

Bearer ACCESS_TOKEN_VALUE

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

For Example: Oauth oauth = new Oauth(); oauth.ClientId = "CLIENT_ID"; oauth.ClientSecret = "CLIENT_SECRET; oauth.ServerAuthURL = "https://login.microsoftonline.com/common/oauth2/v2.0/authorize"; oauth.ServerTokenURL = "https://login.microsoftonline.com/common/oauth2/v2.0/token"; oauth.AuthorizationScope = "offline_access 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 collection.

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 collection. // 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 a stream has been specified using SetDownloadStream, the file data will be sent through it. If a stream is not specified, and 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 component 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 component 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 SetUploadStream has been used to set an upload stream, it will take priority as the file data source. 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 component 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 component 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 component. 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 component 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 component is used, they should already be populated, and no special action should be needed). If uploading from a stream, be sure to reset its position to where it was the first time the upload was started (typically the beginning). 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"); MemoryStream uploadStream = new MemoryStream(File.ReadAllBytes("../MyFile.zip")); sharepoint.SetUploadStream(uploadStream); 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. //You MUST reset the stream's position to where it was when you first started the upload! uploadStream.Position = 0; sharepoint.UploadFile("MyFile.zip");

Additional Functionality

The SharePoint component 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 component with short descriptions. Click on the links for further details.

Method List

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

Event List

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

Config Settings

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

Authorization Property (SharePoint Component)

OAuth 2.0 Authorization Token

Syntax

• C#
• VB.NET

public string Authorization { get; set; }

Public Property Authorization As String

Default Value

""

Remarks

This component supports authentication via OAuth 2.0. First, perform OAuth authentication using the OAuth property, using the OAuth component 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

Authorization Notes

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

ChangeMarker Property (SharePoint Component)

A marker indicating what page of changes to return next.

Syntax

• C#
• VB.NET

public string ChangeMarker { get; set; }

Public Property ChangeMarker As String

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.

CopiedResourceId Property (SharePoint Component)

The Id of a newly-copied resource.

Syntax

• C#
• VB.NET

public string CopiedResourceId { get; }

Public ReadOnly Property CopiedResourceId As String

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.

CopyPercentDone Property (SharePoint Component)

Progress percentage of a copy operation.

Syntax

• C#
• VB.NET

public string CopyPercentDone { get; }

Public ReadOnly Property CopyPercentDone As String

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.

CopyStatus Property (SharePoint Component)

Status of a copy operation.

Syntax

• C#
• VB.NET

public string CopyStatus { get; }

Public ReadOnly Property CopyStatus As String

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.

DocumentLibraries Property (SharePoint Component)

A collection of document libraries.

Syntax

• C#
• VB.NET

public SharePointDocumentLibraryList DocumentLibraries { get; }

Public ReadOnly Property DocumentLibraries As SharePointDocumentLibraryList

Remarks

This collection holds a list of SharePoint document libraries.

Calling ListDocumentLibraries or GetDocumentLibraryInfo will populate this collection.

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

DocumentLibrary Property (SharePoint Component)

Selects a document library.

Syntax

• C#
• VB.NET

public string DocumentLibrary { get; set; }

Public Property DocumentLibrary As String

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 component uses the site's, defined by the SiteId, default document library.

This property is not available at design time.

DocumentLibraryMarker Property (SharePoint Component)

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

Syntax

• C#
• VB.NET

public string DocumentLibraryMarker { get; set; }

Public Property DocumentLibraryMarker As String

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.

EncryptionAlgorithm Property (SharePoint Component)

The encryption algorithm.

Syntax

• C#
• VB.NET

public SharepointEncryptionAlgorithms EncryptionAlgorithm { get; set; }

enum SharepointEncryptionAlgorithms {
  eaAES,
  eaBlowfish,
  eaCAST,
  eaDES,
  eaIDEA,
  eaRC2,
  eaRC4,
  eaTEA,
  eaTripleDES,
  eaTwofish,
  eaRijndael,
  eaChaCha,
  eaXSalsa20
}

Public Property EncryptionAlgorithm As SharepointEncryptionAlgorithms

Enum SharepointEncryptionAlgorithms
  eaAES
  eaBlowfish
  eaCAST
  eaDES
  eaIDEA
  eaRC2
  eaRC4
  eaTEA
  eaTripleDES
  eaTwofish
  eaRijndael
  eaChaCha
  eaXSalsa20
End Enum

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:

EncryptionPassword Property (SharePoint Component)

The encryption password.

Syntax

• C#
• VB.NET

public string EncryptionPassword { get; set; }

Public Property EncryptionPassword As String

Default Value

""

Remarks

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

The component 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.

Firewall Property (SharePoint Component)

A set of properties related to firewall access.

Syntax

• C#
• VB.NET

public Firewall Firewall { get; set; }

Public Property Firewall As Firewall

Remarks

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

Idle Property (SharePoint Component)

The current status of the component.

Syntax

• C#
• VB.NET

public bool Idle { get; }

Public ReadOnly Property Idle As Boolean

Default Value

True

Remarks

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

This property is read-only.

LocalFile Property (SharePoint Component)

The location of the local file.

Syntax

• C#
• VB.NET

public string LocalFile { get; set; }

Public Property LocalFile As String

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.

Note: Setting this property to a non-empty value will discard any streams set using SetDownloadStream and SetUploadStream. Similarly, passing a non-null value to either of the aforementioned methods will clear this property.

LocalHost Property (SharePoint Component)

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

Syntax

• C#
• VB.NET

public string LocalHost { get; set; }

Public Property LocalHost As String

Default Value

""

Remarks

The LocalHost 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 multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the component initiate connections (or accept in the case of server components) only through that interface.

If the component is connected, the LocalHost 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 multi-homed 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.

NextChangeMarker Property (SharePoint Component)

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

Syntax

• C#
• VB.NET

public string NextChangeMarker { get; set; }

Public Property NextChangeMarker As String

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.

OAuth Property (SharePoint Component)

This property holds the OAuth Settings.

Syntax

• C#
• VB.NET

public OAuthSettings OAuth { get; }

Public ReadOnly Property OAuth As OAuthSettings

Remarks

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

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

OtherHeaders Property (SharePoint Component)

This property includes other headers as determined by the user (optional).

Syntax

• C#
• VB.NET

public string OtherHeaders { get; set; }

Public Property OtherHeaders As String

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 component beyond what is provided.

This property is not available at design time.

Overwrite Property (SharePoint Component)

Whether to overwrite the local or remote file.

Syntax

• C#
• VB.NET

public bool Overwrite { get; set; }

Public Property Overwrite As Boolean

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

ParsedHeaders Property (SharePoint Component)

This property includes a collection of headers returned from the last request.

Syntax

• C#
• VB.NET

public HeaderList ParsedHeaders { get; }

Public ReadOnly Property ParsedHeaders As HeaderList

Remarks

This property contains a collection of headers returned from the last request. Whenever headers are returned from the server, the headers are parsed into a collection of headers. Each Header in this collection contains information describing that header.

MaxHeaders can be used to control the maximum number of headers saved.

This collection is indexed from 0 to count -1.

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

Proxy Property (SharePoint Component)

A set of properties related to proxy access.

Syntax

• C#
• VB.NET

public Proxy Proxy { get; set; }

Public Property Proxy As Proxy

Remarks

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

QueryParams Property (SharePoint Component)

Additional query parameters to be included in the request.

Syntax

• C#
• VB.NET

public QueryParamList QueryParams { get; }

Public Property QueryParams As QueryParamList

Remarks

This is a collection of query parameters that will be added to the request. Parameters can be added via the AddQueryParam method.

Range Property (SharePoint Component)

The range of bytes to request.

Syntax

• C#
• VB.NET

public string Range { get; set; }

Public Property Range As String

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

RemoteId Property (SharePoint Component)

Selects a remote resource by Id.

Syntax

• C#
• VB.NET

public string RemoteId { get; set; }

Public Property RemoteId As String

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.

RemotePath Property (SharePoint Component)

Selects a remote resource by path.

Syntax

• C#
• VB.NET

public string RemotePath { get; set; }

Public Property RemotePath As String

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.

ResourceData Property (SharePoint Component)

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

Syntax

• C#
• VB.NET

public string ResourceData { get; set; }
public byte[] ResourceDataB { get; set; }

Public Property ResourceData As String
Public Property ResourceDataB As Byte()

Default Value

""

Remarks

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

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

This property is not available at design time.

ResourceMarker Property (SharePoint Component)

A marker indicating what page of resources to return next.

Syntax

• C#
• VB.NET

public string ResourceMarker { get; set; }

Public Property ResourceMarker As String

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.

Resources Property (SharePoint Component)

A collection of resources.

Syntax

• C#
• VB.NET

public SharePointResourceList Resources { get; }

Public Property Resources As SharePointResourceList

Remarks

This collection holds a list of file and folder resources.

Calling ListResources, GetResourceInfo, Search, or ListChanges will populate this collection.

Also see the UpdateResource method for information on how it uses this collection.

This property is not available at design time.

ResumeURL Property (SharePoint Component)

The resumable upload URL.

Syntax

• C#
• VB.NET

public string ResumeURL { get; set; }

Public Property ResumeURL As String

Default Value

""

Remarks

This property holds the URL of the resumable upload session. This is populated by the component 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.

SearchMarker Property (SharePoint Component)

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

Syntax

• C#
• VB.NET

public string SearchMarker { get; set; }

Public Property SearchMarker As String

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.

SiteId Property (SharePoint Component)

Selects a SharePoint site.

Syntax

• C#
• VB.NET

public string SiteId { get; set; }

Public Property SiteId As String

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.

Sites Property (SharePoint Component)

A collection of sites.

Syntax

• C#
• VB.NET

public SharePointSiteList Sites { get; }

Public ReadOnly Property Sites As SharePointSiteList

Remarks

This collection holds a list of sites (or subsites) for the currently authenticated user or application. Calling ListSites will populate this collection.

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

SSLAcceptServerCert Property (SharePoint Component)

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

Syntax

• C#
• VB.NET

public Certificate SSLAcceptServerCert { get; set; }

Public Property SSLAcceptServerCert As Certificate

Remarks

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

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

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

SSLCert Property (SharePoint Component)

The certificate to be used during SSL negotiation.

Syntax

• C#
• VB.NET

public Certificate SSLCert { get; set; }

Public Property SSLCert As Certificate

Remarks

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

SSLProvider Property (SharePoint Component)

This specifies the SSL/TLS implementation to use.

Syntax

• C#
• VB.NET

public SharepointSSLProviders SSLProvider { get; set; }

enum SharepointSSLProviders {
  sslpAutomatic,
  sslpPlatform,
  sslpInternal
}

Public Property SSLProvider As SharepointSSLProviders

Enum SharepointSSLProviders
  sslpAutomatic
  sslpPlatform
  sslpInternal
End Enum

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 component will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are:

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

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

The .NET Standard library will always use the internal implementation on all platforms.

SSLServerCert Property (SharePoint Component)

The server certificate for the last established connection.

Syntax

• C#
• VB.NET

public Certificate SSLServerCert { get; }

Public ReadOnly Property SSLServerCert As Certificate

Remarks

SSLServerCert contains the server certificate for the last established connection.

SSLServerCert is reset every time a new connection is attempted.

This property is read-only.

StartByte Property (SharePoint Component)

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

Syntax

• C#
• VB.NET

public long StartByte { get; set; }

Public Property StartByte As Long

Default Value

0

Remarks

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

When uploading from a stream, the component will always seek forward in the stream if the value of StartByte is greater than 0 when UploadFile is called. Keep this in mind when resuming interrupted uploads.

This property is not available at design time.

Timeout Property (SharePoint Component)

A timeout for the component.

Syntax

• C#
• VB.NET

public int Timeout { get; set; }

Public Property Timeout As Integer

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 component will wait for the operation to complete before returning control.

The component 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 component throws an exception.

Please note that by default, all timeouts are inactivity timeouts, i.e. 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.

UseResumableUpload Property (SharePoint Component)

Whether to use resumable uploads.

Syntax

• C#
• VB.NET

public bool UseResumableUpload { get; set; }

Public Property UseResumableUpload As Boolean

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.

AbortUpload Method (SharePoint Component)

Aborts the current resumable upload session.

Syntax

• C#
• VB.NET

public void AbortUpload();

Async Version
public async Task AbortUpload();
public async Task AbortUpload(CancellationToken cancellationToken);

Public Sub AbortUpload()

Async Version
Public Sub AbortUpload() As Task
Public Sub AbortUpload(cancellationToken As CancellationToken) As Task

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 (SharePoint Component)

Adds a query parameter to the QueryParams properties.

Syntax

• C#
• VB.NET

public void AddQueryParam(string name, string value);

Async Version
public async Task AddQueryParam(string name, string value);
public async Task AddQueryParam(string name, string value, CancellationToken cancellationToken);

Public Sub AddQueryParam(ByVal Name As String, ByVal Value As String)

Async Version
Public Sub AddQueryParam(ByVal Name As String, ByVal Value As String) As Task
Public Sub AddQueryParam(ByVal Name As String, ByVal Value As String, cancellationToken As CancellationToken) As Task

Remarks

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

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

Authorize Method (SharePoint Component)

Get the authorization string required to access the protected resource.

Syntax

• C#
• VB.NET

public void Authorize();

Async Version
public async Task Authorize();
public async Task Authorize(CancellationToken cancellationToken);

Public Sub Authorize()

Async Version
Public Sub Authorize() As Task
Public Sub Authorize(cancellationToken As CancellationToken) As Task

Remarks

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

For more information, see the introduction section.

CalcAuthorization Method (SharePoint Component)

Calculates the Authorization header based on provided credentials.

Syntax

• C#
• VB.NET

public void CalcAuthorization();

Async Version
public async Task CalcAuthorization();
public async Task CalcAuthorization(CancellationToken cancellationToken);

Public Sub CalcAuthorization()

Async Version
Public Sub CalcAuthorization() As Task
Public Sub CalcAuthorization(cancellationToken As CancellationToken) As Task

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 component 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 (SharePoint Component)

Sets or retrieves a configuration setting.

Syntax

• C#
• VB.NET

public string Config(string configurationString);

Async Version
public async Task<string> Config(string configurationString);
public async Task<string> Config(string configurationString, CancellationToken cancellationToken);

Public Function Config(ByVal ConfigurationString As String) As String

Async Version
Public Function Config(ByVal ConfigurationString As String) As Task(Of String)
Public Function Config(ByVal ConfigurationString As String, cancellationToken As CancellationToken) As Task(Of String)

Remarks

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

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

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

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

CopyResource Method (SharePoint Component)

Copies the currently selected resource.

Syntax

• C#
• VB.NET

public void CopyResource(string parentId, string newName);

Async Version
public async Task CopyResource(string parentId, string newName);
public async Task CopyResource(string parentId, string newName, CancellationToken cancellationToken);

Public Sub CopyResource(ByVal ParentId As String, ByVal NewName As String)

Async Version
Public Sub CopyResource(ByVal ParentId As String, ByVal NewName As String) As Task
Public Sub CopyResource(ByVal ParentId As String, ByVal NewName As String, cancellationToken As CancellationToken) As Task

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 (SharePoint Component)

Creates a new folder resource.

Syntax

• C#
• VB.NET

public string CreateFolder(string folderName);

Async Version
public async Task<string> CreateFolder(string folderName);
public async Task<string> CreateFolder(string folderName, CancellationToken cancellationToken);

Public Function CreateFolder(ByVal FolderName As String) As String

Async Version
Public Function CreateFolder(ByVal FolderName As String) As Task(Of String)
Public Function CreateFolder(ByVal FolderName As String, cancellationToken As CancellationToken) As Task(Of String)

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 (SharePoint Component)

Creates a resource sharing link.

Syntax

• C#
• VB.NET

public string CreateLink(bool readOnly);

Async Version
public async Task<string> CreateLink(bool readOnly);
public async Task<string> CreateLink(bool readOnly, CancellationToken cancellationToken);

Public Function CreateLink(ByVal ReadOnly As Boolean) As String

Async Version
Public Function CreateLink(ByVal ReadOnly As Boolean) As Task(Of String)
Public Function CreateLink(ByVal ReadOnly As Boolean, cancellationToken As CancellationToken) As Task(Of String)

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 (SharePoint Component)

Deletes the currently selected resource.

Syntax

• C#
• VB.NET

public void DeleteResource();

Async Version
public async Task DeleteResource();
public async Task DeleteResource(CancellationToken cancellationToken);

Public Sub DeleteResource()

Async Version
Public Sub DeleteResource() As Task
Public Sub DeleteResource(cancellationToken As CancellationToken) As Task

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 (SharePoint Component)

Downloads the currently selected file resource.

Syntax

• C#
• VB.NET

public void DownloadFile();

Async Version
public async Task DownloadFile();
public async Task DownloadFile(CancellationToken cancellationToken);

Public Sub DownloadFile()

Async Version
Public Sub DownloadFile() As Task
Public Sub DownloadFile(cancellationToken As CancellationToken) As Task

Remarks

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

If a stream has been specified using SetDownloadStream, the file data will be sent through it. If a stream is not specified, and 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 component 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 component 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 (SharePoint Component)

Gets the most current change marker.

Syntax

• C#
• VB.NET

public void GetCurrentChangeMarker();

Async Version
public async Task GetCurrentChangeMarker();
public async Task GetCurrentChangeMarker(CancellationToken cancellationToken);

Public Sub GetCurrentChangeMarker()

Async Version
Public Sub GetCurrentChangeMarker() As Task
Public Sub GetCurrentChangeMarker(cancellationToken As CancellationToken) As Task

Remarks

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

Refer to ListChanges for more information.

GetDocumentLibraryInfo Method (SharePoint Component)

Gets information about the currently selected document library.

Syntax

• C#
• VB.NET

public void GetDocumentLibraryInfo();

Async Version
public async Task GetDocumentLibraryInfo();
public async Task GetDocumentLibraryInfo(CancellationToken cancellationToken);

Public Sub GetDocumentLibraryInfo()

Async Version
Public Sub GetDocumentLibraryInfo() As Task
Public Sub GetDocumentLibraryInfo(cancellationToken As CancellationToken) As Task

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 collection with a single item (clearing any previously-held items in the process).

GetResourceInfo Method (SharePoint Component)

Gets information about the currently selected resource.

Syntax

• C#
• VB.NET

public void GetResourceInfo();

Async Version
public async Task GetResourceInfo();
public async Task GetResourceInfo(CancellationToken cancellationToken);

Public Sub GetResourceInfo()

Async Version
Public Sub GetResourceInfo() As Task
Public Sub GetResourceInfo(cancellationToken As CancellationToken) As Task

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 collection with a single item (clearing any previously-held items in the process).

Interrupt Method (SharePoint Component)

Interrupt the current method.

Syntax

• C#
• VB.NET

public void Interrupt();

Async Version
public async Task Interrupt();
public async Task Interrupt(CancellationToken cancellationToken);

Public Sub Interrupt()

Async Version
Public Sub Interrupt() As Task
Public Sub Interrupt(cancellationToken As CancellationToken) As Task

Remarks

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

ListChanges Method (SharePoint Component)

Lists changes to resources in the currently selected document library.

Syntax

• C#
• VB.NET

public void ListChanges();

Async Version
public async Task ListChanges();
public async Task ListChanges(CancellationToken cancellationToken);

Public Sub ListChanges()

Async Version
Public Sub ListChanges() As Task
Public Sub ListChanges(cancellationToken As CancellationToken) As Task

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

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 collection. (Once there aren't any more changes available to list, the NextChangeMarker property will be populated instead.)

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

• 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 (SharePoint Component)

Lists the document libraries in the current site.

Syntax

• C#
• VB.NET

public void ListDocumentLibraries();

Async Version
public async Task ListDocumentLibraries();
public async Task ListDocumentLibraries(CancellationToken cancellationToken);

Public Sub ListDocumentLibraries()

Async Version
Public Sub ListDocumentLibraries() As Task
Public Sub ListDocumentLibraries(cancellationToken As CancellationToken) As Task

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

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

ListResources Method (SharePoint Component)

Lists resources in the currently selected folder.

Syntax

• C#
• VB.NET

public void ListResources();

Async Version
public async Task ListResources();
public async Task ListResources(CancellationToken cancellationToken);

Public Sub ListResources()

Async Version
Public Sub ListResources() As Task
Public Sub ListResources(cancellationToken As CancellationToken) As Task

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

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

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 (SharePoint Component)

List the sites currently accessible by the authenticated entity.

Syntax

• C#
• VB.NET

public void ListSites();

Async Version
public async Task ListSites();
public async Task ListSites(CancellationToken cancellationToken);

Public Sub ListSites()

Async Version
Public Sub ListSites() As Task
Public Sub ListSites(cancellationToken As CancellationToken) As Task

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

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 (SharePoint Component)

Moves the currently selected resource.

Syntax

• C#
• VB.NET

public void MoveResource(string parentId);

Async Version
public async Task MoveResource(string parentId);
public async Task MoveResource(string parentId, CancellationToken cancellationToken);

Public Sub MoveResource(ByVal ParentId As String)

Async Version
Public Sub MoveResource(ByVal ParentId As String) As Task
Public Sub MoveResource(ByVal ParentId As String, cancellationToken As CancellationToken) As Task

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 (SharePoint Component)

Gets the status of a copy operation.

Syntax

• C#
• VB.NET

public void PollCopyStatus();

Async Version
public async Task PollCopyStatus();
public async Task PollCopyStatus(CancellationToken cancellationToken);

Public Sub PollCopyStatus()

Async Version
Public Sub PollCopyStatus() As Task
Public Sub PollCopyStatus(cancellationToken As CancellationToken) As Task

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 (SharePoint Component)

Gets the status of the current resumable upload session.

Syntax

• C#
• VB.NET

public void PollUploadStatus();

Async Version
public async Task PollUploadStatus();
public async Task PollUploadStatus(CancellationToken cancellationToken);

Public Sub PollUploadStatus()

Async Version
Public Sub PollUploadStatus() As Task
Public Sub PollUploadStatus(cancellationToken As CancellationToken) As Task

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 (SharePoint Component)

Resets the component to its initial state.

Syntax

• C#
• VB.NET

public void Reset();

Async Version
public async Task Reset();
public async Task Reset(CancellationToken cancellationToken);

Public Sub Reset()

Async Version
Public Sub Reset() As Task
Public Sub Reset(cancellationToken As CancellationToken) As Task

Remarks

This method resets the component to its initial state.

Search Method (SharePoint Component)

Searches for resources that match the specified query.

Syntax

• C#
• VB.NET

public void Search(string query);

Async Version
public async Task Search(string query);
public async Task Search(string query, CancellationToken cancellationToken);

Public Sub Search(ByVal Query As String)

Async Version
Public Sub Search(ByVal Query As String) As Task
Public Sub Search(ByVal Query As String, cancellationToken As CancellationToken) As Task

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

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

SendCustomRequest Method (SharePoint Component)

Sends a custom request to the Microsoft Graph API.

Syntax

• C#
• VB.NET

public void SendCustomRequest(string httpMethod, string requestPath, string requestBody);

Async Version
public async Task SendCustomRequest(string httpMethod, string requestPath, string requestBody);
public async Task SendCustomRequest(string httpMethod, string requestPath, string requestBody, CancellationToken cancellationToken);

Public Sub SendCustomRequest(ByVal HttpMethod As String, ByVal RequestPath As String, ByVal RequestBody As String)

Async Version
Public Sub SendCustomRequest(ByVal HttpMethod As String, ByVal RequestPath As String, ByVal RequestBody As String) As Task
Public Sub SendCustomRequest(ByVal HttpMethod As String, ByVal RequestPath As String, ByVal RequestBody As String, cancellationToken As CancellationToken) As Task

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 component 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 collection 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 collection, and the response body in the stream specified using SetDownloadStream, 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 component make a request against it.

SetDownloadStream Method (SharePoint Component)

Sets the stream to which downloaded data will be written.

Syntax

• C#
• VB.NET

public void SetDownloadStream(System.IO.Stream downloadStream);

Async Version
public async Task SetDownloadStream(System.IO.Stream downloadStream);
public async Task SetDownloadStream(System.IO.Stream downloadStream, CancellationToken cancellationToken);

Public Sub SetDownloadStream(ByVal DownloadStream As System.IO.Stream)

Async Version
Public Sub SetDownloadStream(ByVal DownloadStream As System.IO.Stream) As Task
Public Sub SetDownloadStream(ByVal DownloadStream As System.IO.Stream, cancellationToken As CancellationToken) As Task

Remarks

If a download stream is set before data is downloaded, the downloaded data will be written to the stream. The stream should be open and normally set to position 0.

Note: Passing a non-null value for DownloadStream will cause LocalFile to be cleared. Similarly, setting LocalFile to a non-empty value will discard any stream set using this method.

SetUploadStream Method (SharePoint Component)

Sets the stream from which data is read when uploading.

Syntax

• C#
• VB.NET

public void SetUploadStream(System.IO.Stream uploadStream);

Async Version
public async Task SetUploadStream(System.IO.Stream uploadStream);
public async Task SetUploadStream(System.IO.Stream uploadStream, CancellationToken cancellationToken);

Public Sub SetUploadStream(ByVal UploadStream As System.IO.Stream)

Async Version
Public Sub SetUploadStream(ByVal UploadStream As System.IO.Stream) As Task
Public Sub SetUploadStream(ByVal UploadStream As System.IO.Stream, cancellationToken As CancellationToken) As Task

Remarks

If an upload stream is set before data is uploaded, the content of the stream will be read by the component and uploaded to the server. The stream should be open and normally set to position 0.

Note: Passing a non-null value for UploadStream will cause LocalFile to be cleared. Similarly, setting LocalFile to a non-empty value will discard any stream set using this method.

UpdateResource Method (SharePoint Component)

Updates the currently selected resource.

Syntax

• C#
• VB.NET

public void UpdateResource();

Async Version
public async Task UpdateResource();
public async Task UpdateResource(CancellationToken cancellationToken);

Public Sub UpdateResource()

Async Version
Public Sub UpdateResource() As Task
Public Sub UpdateResource(cancellationToken As CancellationToken) As Task

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

1. If necessary, call GetResourceInfo or ListResources to ensure an item with the resource's latest information is present in the Resources collection.
2. Modify the SharePointResource item's fields as desired; the following fields are supported:
   • Description (only updated if not empty)
   • Name
   • ParentId (only updated if not empty)
   • ParentPath (only updated if not empty and ParentId 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 call SetUploadStream or 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.

Name Conflict Resolution

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 (SharePoint Component)

Uploads a new file resource.

Syntax

• C#
• VB.NET

public string UploadFile(string fileName);

Async Version
public async Task<string> UploadFile(string fileName);
public async Task<string> UploadFile(string fileName, CancellationToken cancellationToken);

Public Function UploadFile(ByVal FileName As String) As String

Async Version
Public Function UploadFile(ByVal FileName As String) As Task(Of String)
Public Function UploadFile(ByVal FileName As String, cancellationToken As CancellationToken) As Task(Of String)

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 SetUploadStream has been used to set an upload stream, it will take priority as the file data source. 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 component 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 component 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 component. 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 component 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 component is used, they should already be populated, and no special action should be needed). If uploading from a stream, be sure to reset its position to where it was the first time the upload was started (typically the beginning). 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"); MemoryStream uploadStream = new MemoryStream(File.ReadAllBytes("../MyFile.zip")); sharepoint.SetUploadStream(uploadStream); 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. //You MUST reset the stream's position to where it was when you first started the upload! uploadStream.Position = 0; sharepoint.UploadFile("MyFile.zip");

Name Conflict Resolution

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 (SharePoint Component)

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

Syntax

• C#
• VB.NET

public event OnDocumentLibraryListHandler OnDocumentLibraryList;

public delegate void OnDocumentLibraryListHandler(object sender, SharepointDocumentLibraryListEventArgs e);

public class SharepointDocumentLibraryListEventArgs : EventArgs {
  public string Id { get; }
  public string Name { get; }
  public string Description { get; }
  public string OwnerId { get; }
  public string OwnerName { get; }
}

Public Event OnDocumentLibraryList As OnDocumentLibraryListHandler

Public Delegate Sub OnDocumentLibraryListHandler(sender As Object, e As SharepointDocumentLibraryListEventArgs)

Public Class SharepointDocumentLibraryListEventArgs Inherits EventArgs
  Public ReadOnly Property Id As String
  Public ReadOnly Property Name As String
  Public ReadOnly Property Description As String
  Public ReadOnly Property OwnerId As String
  Public ReadOnly Property OwnerName As String
End Class

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 (SharePoint Component)

This event fires when a document finishes transferring.

Syntax

• C#
• VB.NET

public event OnEndTransferHandler OnEndTransfer;

public delegate void OnEndTransferHandler(object sender, SharepointEndTransferEventArgs e);

public class SharepointEndTransferEventArgs : EventArgs {
  public int Direction { get; }
}

Public Event OnEndTransfer As OnEndTransferHandler

Public Delegate Sub OnEndTransferHandler(sender As Object, e As SharepointEndTransferEventArgs)

Public Class SharepointEndTransferEventArgs Inherits EventArgs
  Public ReadOnly Property Direction As Integer
End Class

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 (SharePoint Component)

Fired when information is available about errors during data delivery.

Syntax

• C#
• VB.NET

public event OnErrorHandler OnError;

public delegate void OnErrorHandler(object sender, SharepointErrorEventArgs e);

public class SharepointErrorEventArgs : EventArgs {
  public int ErrorCode { get; }
  public string Description { get; }
}

Public Event OnError As OnErrorHandler

Public Delegate Sub OnErrorHandler(sender As Object, e As SharepointErrorEventArgs)

Public Class SharepointErrorEventArgs Inherits EventArgs
  Public ReadOnly Property ErrorCode As Integer
  Public ReadOnly Property Description As String
End Class

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the component throws an exception.

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

FragmentComplete Event (SharePoint Component)

Fires after each fragment of a resumable upload is completed.

Syntax

• C#
• VB.NET

public event OnFragmentCompleteHandler OnFragmentComplete;

public delegate void OnFragmentCompleteHandler(object sender, SharepointFragmentCompleteEventArgs e);

public class SharepointFragmentCompleteEventArgs : EventArgs {
  public int FragmentNumber { get; }
  public int FragmentCount { get; }
  public bool Interrupt { get; set; }
}

Public Event OnFragmentComplete As OnFragmentCompleteHandler

Public Delegate Sub OnFragmentCompleteHandler(sender As Object, e As SharepointFragmentCompleteEventArgs)

Public Class SharepointFragmentCompleteEventArgs Inherits EventArgs
  Public ReadOnly Property FragmentNumber As Integer
  Public ReadOnly Property FragmentCount As Integer
  Public Property Interrupt As Boolean
End Class

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 (SharePoint Component)

This event is fired every time a header line comes in.

Syntax

• C#
• VB.NET

public event OnHeaderHandler OnHeader;

public delegate void OnHeaderHandler(object sender, SharepointHeaderEventArgs e);

public class SharepointHeaderEventArgs : EventArgs {
  public string Field { get; }
  public string Value { get; }
}

Public Event OnHeader As OnHeaderHandler

Public Delegate Sub OnHeaderHandler(sender As Object, e As SharepointHeaderEventArgs)

Public Class SharepointHeaderEventArgs Inherits EventArgs
  Public ReadOnly Property Field As String
  Public ReadOnly Property Value As String
End Class

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 (SharePoint Component)

This event fires once for each log message.

Syntax

• C#
• VB.NET

public event OnLogHandler OnLog;

public delegate void OnLogHandler(object sender, SharepointLogEventArgs e);

public class SharepointLogEventArgs : EventArgs {
  public int LogLevel { get; }
  public string Message { get; }
  public string LogType { get; }
}

Public Event OnLog As OnLogHandler

Public Delegate Sub OnLogHandler(sender As Object, e As SharepointLogEventArgs)

Public Class SharepointLogEventArgs Inherits EventArgs
  Public ReadOnly Property LogLevel As Integer
  Public ReadOnly Property Message As String
  Public ReadOnly Property LogType As String
End Class

Remarks

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

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

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 (SharePoint Component)

Fires during an upload or download to indicate transfer progress.

Syntax

• C#
• VB.NET

public event OnProgressHandler OnProgress;

public delegate void OnProgressHandler(object sender, SharepointProgressEventArgs e);

public class SharepointProgressEventArgs : EventArgs {
  public int Direction { get; }
  public long BytesTransferred { get; }
  public long TotalBytes { get; }
  public int PercentDone { get; }
}

Public Event OnProgress As OnProgressHandler

Public Delegate Sub OnProgressHandler(sender As Object, e As SharepointProgressEventArgs)

Public Class SharepointProgressEventArgs Inherits EventArgs
  Public ReadOnly Property Direction As Integer
  Public ReadOnly Property BytesTransferred As Long
  Public ReadOnly Property TotalBytes As Long
  Public ReadOnly Property PercentDone As Integer
End Class

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 component 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 component 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 (SharePoint Component)

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

Syntax

• C#
• VB.NET

public event OnResourceListHandler OnResourceList;

public delegate void OnResourceListHandler(object sender, SharepointResourceListEventArgs e);

public class SharepointResourceListEventArgs : EventArgs {
  public string Id { get; }
  public string Name { get; }
  public string Path { get; }
  public int ResourceType { get; }
  public string CreatedTime { get; }
  public string ModifiedTime { get; }
  public long Size { get; }
  public string ETag { get; }
  public bool Deleted { get; }
}

Public Event OnResourceList As OnResourceListHandler

Public Delegate Sub OnResourceListHandler(sender As Object, e As SharepointResourceListEventArgs)

Public Class SharepointResourceListEventArgs Inherits EventArgs
  Public ReadOnly Property Id As String
  Public ReadOnly Property Name As String
  Public ReadOnly Property Path As String
  Public ReadOnly Property ResourceType As Integer
  Public ReadOnly Property CreatedTime As String
  Public ReadOnly Property ModifiedTime As String
  Public ReadOnly Property Size As Long
  Public ReadOnly Property ETag As String
  Public ReadOnly Property Deleted As Boolean
End Class

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 (SharePoint Component)

Fires once for each site returned when listing sites.

Syntax

• C#
• VB.NET

public event OnSiteListHandler OnSiteList;

public delegate void OnSiteListHandler(object sender, SharepointSiteListEventArgs e);

public class SharepointSiteListEventArgs : EventArgs {
  public string Id { get; }
  public string Name { get; }
  public string URL { get; }
}

Public Event OnSiteList As OnSiteListHandler

Public Delegate Sub OnSiteListHandler(sender As Object, e As SharepointSiteListEventArgs)

Public Class SharepointSiteListEventArgs Inherits EventArgs
  Public ReadOnly Property Id As String
  Public ReadOnly Property Name As String
  Public ReadOnly Property URL As String
End Class

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 (SharePoint Component)

Fired after the server presents its certificate to the client.

Syntax

• C#
• VB.NET

public event OnSSLServerAuthenticationHandler OnSSLServerAuthentication;

public delegate void OnSSLServerAuthenticationHandler(object sender, SharepointSSLServerAuthenticationEventArgs e);

public class SharepointSSLServerAuthenticationEventArgs : EventArgs {
  public string CertEncoded { get; }
  public byte[] CertEncodedB { get; }
  public string CertSubject { get; }
  public string CertIssuer { get; }
  public string Status { get; }
  public bool Accept { get; set; }
}

Public Event OnSSLServerAuthentication As OnSSLServerAuthenticationHandler

Public Delegate Sub OnSSLServerAuthenticationHandler(sender As Object, e As SharepointSSLServerAuthenticationEventArgs)

Public Class SharepointSSLServerAuthenticationEventArgs Inherits EventArgs
  Public ReadOnly Property CertEncoded As String
  Public ReadOnly Property CertEncodedB As Byte()
  Public ReadOnly Property CertSubject As String
  Public ReadOnly Property CertIssuer As String
  Public ReadOnly Property Status As String
  Public Property Accept As Boolean
End Class

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 (SharePoint Component)

Fired when secure connection progress messages are available.

Syntax

• C#
• VB.NET

public event OnSSLStatusHandler OnSSLStatus;

public delegate void OnSSLStatusHandler(object sender, SharepointSSLStatusEventArgs e);

public class SharepointSSLStatusEventArgs : EventArgs {
  public string Message { get; }
}

Public Event OnSSLStatus As OnSSLStatusHandler

Public Delegate Sub OnSSLStatusHandler(sender As Object, e As SharepointSSLStatusEventArgs)

Public Class SharepointSSLStatusEventArgs Inherits EventArgs
  Public ReadOnly Property Message As String
End Class

Remarks

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

StartTransfer Event (SharePoint Component)

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

Syntax

• C#
• VB.NET

public event OnStartTransferHandler OnStartTransfer;

public delegate void OnStartTransferHandler(object sender, SharepointStartTransferEventArgs e);

public class SharepointStartTransferEventArgs : EventArgs {
  public int Direction { get; }
}

Public Event OnStartTransfer As OnStartTransferHandler

Public Delegate Sub OnStartTransferHandler(sender As Object, e As SharepointStartTransferEventArgs)

Public Class SharepointStartTransferEventArgs Inherits EventArgs
  Public ReadOnly Property Direction As Integer
End Class

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 (SharePoint Component)

This event is fired while a document transfers (delivers document).

Syntax

• C#
• VB.NET

public event OnTransferHandler OnTransfer;

public delegate void OnTransferHandler(object sender, SharepointTransferEventArgs e);

public class SharepointTransferEventArgs : EventArgs {
  public int Direction { get; }
  public long BytesTransferred { get; }
  public int PercentDone { get; }
  public string Text { get; }
  public byte[] TextB { get; }
}

Public Event OnTransfer As OnTransferHandler

Public Delegate Sub OnTransferHandler(sender As Object, e As SharepointTransferEventArgs)

Public Class SharepointTransferEventArgs Inherits EventArgs
  Public ReadOnly Property Direction As Integer
  Public ReadOnly Property BytesTransferred As Long
  Public ReadOnly Property PercentDone As Integer
  Public ReadOnly Property Text As String
  Public ReadOnly Property TextB As Byte()
End Class

Remarks

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

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

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

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

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

Certificate Type

This is the digital certificate being used.

Remarks

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

Fields

Constructors

• C#
• VB.NET

public Certificate();

Public Certificate()

Creates a Certificate instance whose properties can be set. This is useful for use with CERTMGR when generating new certificates.

• C#
• VB.NET

public Certificate(string certificateFile);

Public Certificate(ByVal CertificateFile As String)

Opens CertificateFile and reads out the contents as an X.509 public key.

• C#
• VB.NET

public Certificate(byte[] certificateData);

Public Certificate(ByVal CertificateData As Byte())

Parses CertificateData as an X.509 public key.

• C#
• VB.NET

public Certificate(CertStoreTypes certStoreType, string store, string storePassword, string subject);

Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Subject As String)

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN).

• C#
• VB.NET

public Certificate(CertStoreTypes certStoreType, string store, string storePassword, string subject, string configurationString);

Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Subject As String, ByVal ConfigurationString As String)

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. ConfigurationString is a newline separated list of name-value pairs that may be used to modify the default behavior. Possible values include "PersistPFXKey", which shows whether or not the PFX key is persisted after performing operations with the private key. This correlates to the PKCS12_NO_PERSIST_KEY CryptoAPI option. The default value is True (the key is persisted). "Thumbprint" - an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load. When specified, this value is used to select the certificate in the store. This is applicable to cstUser, cstMachine, cstPublicKeyFile, and cstPFXFile store types. "UseInternalSecurityAPI" shows whether the platform (default) or the internal security API is used when performing certificate-related operations. After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN).

• C#
• VB.NET

public Certificate(CertStoreTypes certStoreType, string store, string storePassword, byte[] encoded);

Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Encoded As Byte())

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will load Encoded as an X.509 certificate and search the opened store for a corresponding private key.

• C#
• VB.NET

public Certificate(CertStoreTypes certStoreType, byte[] storeBlob, string storePassword, string subject);

Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal StoreBlob As Byte(), ByVal StorePassword As String, ByVal Subject As String)

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. StoreBlob is a string (binary- or Base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN).

• C#
• VB.NET

public Certificate(CertStoreTypes certStoreType, byte[] storeBlob, string storePassword, string subject, string configurationString);

Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal StoreBlob As Byte(), ByVal StorePassword As String, ByVal Subject As String, ByVal ConfigurationString As String)

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. StoreBlob is a string (binary- or Base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN).

• C#
• VB.NET

public Certificate(CertStoreTypes certStoreType, byte[] storeBlob, string storePassword, byte[] encoded);

Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal StoreBlob As Byte(), ByVal StorePassword As String, ByVal Encoded As Byte())

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a string (binary- or Base64-encoded) containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will load Encoded as an X.509 certificate and search the opened store for a corresponding private key.

Firewall Type

The firewall the component will connect through.

Remarks

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

Fields

Constructors

• C#
• VB.NET

public Firewall();

Public Firewall()

Header Type

This is an HTTP header as it is received from the server.

Remarks

When a header is received through a Header event, it is parsed into a Header type. This type contains a Field, and its corresponding Value.

Fields

Constructors

• C#
• VB.NET

public Header();

Public Header()

• C#
• VB.NET

public Header(string field, string value);

Public Header(ByVal Field As String, ByVal Value As String)

OAuthSettings Type

The settings to use to authenticate with the service provider.

Remarks

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

Fields

Constructors

• C#
• VB.NET

public OAuthSettings();

Public OAuthSettings()

Proxy Type

The proxy the component will connect to.

Remarks

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

Fields

Constructors

• C#
• VB.NET

public Proxy();

Public Proxy()

• C#
• VB.NET

public Proxy(string server, int port);

Public Proxy(ByVal Server As String, ByVal Port As Integer)

• C#
• VB.NET

public Proxy(string server, int port, string user, string password);

Public Proxy(ByVal Server As String, ByVal Port As Integer, ByVal User As String, ByVal Password As String)

QueryParam Type

A query parameter to send in the request.

Remarks

This type represents a query parameter to send in the request.

Fields

Constructors

• C#
• VB.NET

public QueryParam();

Public QueryParam()

• C#
• VB.NET

public QueryParam(string name, string value);

Public QueryParam(ByVal Name As String, ByVal Value As String)

SharePointDocumentLibrary Type

A SharePoint document library.

Remarks

This type represents a SharePoint document library.

Fields

Constructors

• C#
• VB.NET

public SharePointDocumentLibrary();

Public SharePointDocumentLibrary()

SharePointResource Type

A SharePoint resource.

Remarks

This type represents a SharePoint resource.

Fields

Constructors

• C#
• VB.NET

public SharePointResource();

Public SharePointResource()

SharePointSite Type

A SharePoint site.

Remarks

This type represents a SharePoint site.

Fields

Constructors

• C#
• VB.NET

public SharePointSite();

Public SharePointSite()

Config Settings (SharePoint Component)

SharePoint Config Settings