SharePoint API

Overview

These public interfaces are used in SharePoint components. They are provided for implementing advanced functionality in your scripts. In order for you to use these interfaces in your project, you have to reference CozyRoc.SSISPlus.dll and CozyRoc.SharePoint.dll libraries. Also include CozyRoc.SharePoint, CozyRoc.SharePoint.Lists and CozyRoc.SharePoint.Views namespaces.

IConnection / ISharePointConnection

When you call SharePoint Connection Manager AcquireConnection method, it returns object implementing IConnection interface. This is the interface used for interaction with SharePoint service.

Connect method

Connects to SharePoint service.

Close method

Closes the connection to SharePoint service. Use always after you finish working with the service.

IsConnected method

Returns true if connected to the service.

GetService method

Get specific SharePoint web service. You have to connect first before use. The method has one parameter, which can be one of the options listed in the following table.

Value Result Service
0 Lists Service
1 Views Service
GetTokenCookie method (1.6 SR-2)

Returns SharePoint Online token cookie.

DeploymentType property (int)

Specify deployment type. This property has the options listed in the following table.

Value Description
0 Connect to on-premise SharePoint server.
1 Connect to SharePoint Online service.
ServerHost property (string)

Specify the name or IP address of the SharePoint server.

ServerUser property (string)

Specify user name to access the SharePoint service.

ServerPassword property (string)

Specify user password to access the SharePoint service.

ServerTimeout property (int)

Specify the number of seconds before timing out session connect. The default value of this property is 100 seconds.

RetainSameConnection property (bool)

Specify if all clients should use the same connection. This property has the options listed in the following table.

Value Description
True All clients use same connection (default).
False Every client uses different connection.
ProxyHost property (string)

Specify the name or IP address of the proxy server.

ProxyPort property (int)

Specify the port number on the proxy server to use for the connection.

ProxyUser property (string)

Specify user name to access the proxy server.

ProxyPassword property (string)

Specify password to access the proxy server.