SharePoint Module

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

CloudStorage.SharePoint

Remarks

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

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

Authentication

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

The class has the following default OAuthServerAuthURL and OAuthServerTokenURL properties. Additionally, below is a common scope for the class:

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

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

Application Profile

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

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

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

Authorization Code

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

Example: Sharepoint sharepoint = new Sharepoint(); sharepoint.OAuth.ClientProfile = CloudOAuthClientProfiles.cocpApplication; sharepoint.OAuth.GrantType = OAuthSettingsGrantTypes.cogtAuthorizationCode; sharepoint.OAuth.ClientId = CLIENT_ID; sharepoint.OAuth.ClientSecret = CLIENT_SECRET; sharepoint.OAuth.AuthorizationScope = "offline_access files.readwrite files.readwrite.all"; sharepoint.Authorize();

Client Credentials

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

Implicit

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

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

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

Password

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

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

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

Web Profile

External OAuth Support

Bearer ACCESS_TOKEN_VALUE

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

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

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

Listing Resources

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

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

Downloading Files

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

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

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

Download Notes

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

Resuming Downloads

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

Resuming Encrypted File Downloads

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

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

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

Uploading Files

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

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

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

Upload Notes

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

Simple

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

Resumable

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

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

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

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

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

Additional Functionality

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

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

Property List

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

Method List

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

Event List

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

Config Settings

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

Authorization Property (SharePoint Module)

OAuth 2.0 Authorization Token.

Syntax

• Swift
• Objective-C

public var authorization: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=authorization,setter=setAuthorization:) NSString* authorization;

- (NSString*)authorization;
- (void)setAuthorization :(NSString*)newAuthorization;

Default Value

""

Remarks

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

Bearer ACCESS_TOKEN

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 class for authentication. Pay special attention to the description of the possible value for the {tenent} segment of the OAuth endpoints.

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

ChangeMarker Property (SharePoint Module)

A marker indicating what page of changes to return next.

Syntax

• Swift
• Objective-C

public var changeMarker: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=changeMarker,setter=setChangeMarker:) NSString* changeMarker;

- (NSString*)changeMarker;
- (void)setChangeMarker :(NSString*)newChangeMarker;

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.

CopiedResourceId Property (SharePoint Module)

The Id of a newly-copied resource.

Syntax

• Swift
• Objective-C

public var copiedResourceId: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=copiedResourceId) NSString* copiedResourceId;

- (NSString*)copiedResourceId;

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.

CopyPercentDone Property (SharePoint Module)

Progress percentage of a copy operation.

Syntax

• Swift
• Objective-C

public var copyPercentDone: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=copyPercentDone) NSString* copyPercentDone;

- (NSString*)copyPercentDone;

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.

CopyStatus Property (SharePoint Module)

Status of a copy operation.

Syntax

• Swift
• Objective-C

public var copyStatus: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=copyStatus) NSString* copyStatus;

- (NSString*)copyStatus;

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.

DocumentLibraries Property (SharePoint Module)

A collection of document libraries.

Syntax

• Swift
• Objective-C

public var documentLibraries: Array<SharePointDocumentLibrary> {
  get {...}
}

@property (nonatomic,readonly,assign,getter=documentLibraryCount) int documentLibraryCount;

- (int)documentLibraryCount;

- (long long)documentLibraryDeletedSpace:(int)documentLibraryIndex;

- (NSString*)documentLibraryDescription:(int)documentLibraryIndex;

- (NSString*)documentLibraryId:(int)documentLibraryIndex;

- (NSString*)documentLibraryName:(int)documentLibraryIndex;

- (NSString*)documentLibraryOwnerId:(int)documentLibraryIndex;

- (NSString*)documentLibraryOwnerName:(int)documentLibraryIndex;

- (long long)documentLibraryRemainingSpace:(int)documentLibraryIndex;

- (int)documentLibraryState:(int)documentLibraryIndex;

- (long long)documentLibraryTotalSpace:(int)documentLibraryIndex;

- (long long)documentLibraryUsedSpace:(int)documentLibraryIndex;

Default Value

False

Remarks

This collection holds a list of SharePoint document libraries.

Calling ListDocumentLibraries or GetDocumentLibraryInfo will populate this collection.

DocumentLibrary Property (SharePoint Module)

Selects a document library.

Syntax

• Swift
• Objective-C

public var documentLibrary: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=documentLibrary,setter=setDocumentLibrary:) NSString* documentLibrary;

- (NSString*)documentLibrary;
- (void)setDocumentLibrary :(NSString*)newDocumentLibrary;

Default Value

""

Remarks

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

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

DocumentLibraryMarker Property (SharePoint Module)

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

Syntax

• Swift
• Objective-C

public var documentLibraryMarker: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=documentLibraryMarker,setter=setDocumentLibraryMarker:) NSString* documentLibraryMarker;

- (NSString*)documentLibraryMarker;
- (void)setDocumentLibraryMarker :(NSString*)newDocumentLibraryMarker;

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

EncryptionAlgorithm Property (SharePoint Module)

The encryption algorithm.

Syntax

• Swift
• Objective-C

public var encryptionAlgorithm: SharePointEncryptionAlgorithms {
  get {...}
  set {...}
}

public enum SharePointEncryptionAlgorithms: Int32 {
  case eaAES = 0
  case eaBlowfish = 1
  case eaCAST = 2
  case eaDES = 3
  case eaIDEA = 4
  case eaRC2 = 5
  case eaRC4 = 6
  case eaTEA = 7
  case eaTripleDES = 8
  case eaTwofish = 9
  case eaRijndael = 10
  case eaChaCha = 11
  case eaXSalsa20 = 12
}

@property (nonatomic,readwrite,assign,getter=encryptionAlgorithm,setter=setEncryptionAlgorithm:) int encryptionAlgorithm;

- (int)encryptionAlgorithm;
- (void)setEncryptionAlgorithm :(int)newEncryptionAlgorithm;

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

The encryption password.

Syntax

• Swift
• Objective-C

public var encryptionPassword: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=encryptionPassword,setter=setEncryptionPassword:) NSString* encryptionPassword;

- (NSString*)encryptionPassword;
- (void)setEncryptionPassword :(NSString*)newEncryptionPassword;

Default Value

""

Remarks

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

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

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

Firewall Property (SharePoint Module)

A set of properties related to firewall access.

Syntax

• Swift
• Objective-C

public var firewall: Firewall {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=firewallAutoDetect,setter=setFirewallAutoDetect:) BOOL firewallAutoDetect;

- (BOOL)firewallAutoDetect;
- (void)setFirewallAutoDetect :(BOOL)newFirewallAutoDetect;

@property (nonatomic,readwrite,assign,getter=firewallType,setter=setFirewallType:) int firewallType;

- (int)firewallType;
- (void)setFirewallType :(int)newFirewallType;

@property (nonatomic,readwrite,assign,getter=firewallHost,setter=setFirewallHost:) NSString* firewallHost;

- (NSString*)firewallHost;
- (void)setFirewallHost :(NSString*)newFirewallHost;

@property (nonatomic,readwrite,assign,getter=firewallPassword,setter=setFirewallPassword:) NSString* firewallPassword;

- (NSString*)firewallPassword;
- (void)setFirewallPassword :(NSString*)newFirewallPassword;

@property (nonatomic,readwrite,assign,getter=firewallPort,setter=setFirewallPort:) int firewallPort;

- (int)firewallPort;
- (void)setFirewallPort :(int)newFirewallPort;

@property (nonatomic,readwrite,assign,getter=firewallUser,setter=setFirewallUser:) NSString* firewallUser;

- (NSString*)firewallUser;
- (void)setFirewallUser :(NSString*)newFirewallUser;

 

Default Value

False

Remarks

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

Idle Property (SharePoint Module)

The current status of the module.

Syntax

• Swift
• Objective-C

public var idle: Bool {
  get {...}
}

@property (nonatomic,readonly,assign,getter=idle) BOOL idle;

- (BOOL)idle;

Default Value

True

Remarks

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

This property is read-only.

LocalFile Property (SharePoint Module)

The location of the local file.

Syntax

• Swift
• Objective-C

public var localFile: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=localFile,setter=setLocalFile:) NSString* localFile;

- (NSString*)localFile;
- (void)setLocalFile :(NSString*)newLocalFile;

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.

LocalHost Property (SharePoint Module)

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

Syntax

• Swift
• Objective-C

public var localHost: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=localHost,setter=setLocalHost:) NSString* localHost;

- (NSString*)localHost;
- (void)setLocalHost :(NSString*)newLocalHost;

Default Value

""

Remarks

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

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

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

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

NextChangeMarker Property (SharePoint Module)

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

Syntax

• Swift
• Objective-C

public var nextChangeMarker: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=nextChangeMarker,setter=setNextChangeMarker:) NSString* nextChangeMarker;

- (NSString*)nextChangeMarker;
- (void)setNextChangeMarker :(NSString*)newNextChangeMarker;

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.

OAuth Property (SharePoint Module)

This property holds the OAuth Settings.

Syntax

• Swift
• Objective-C

public var oAuth: OAuthSettings {
  get {...}
}

@property (nonatomic,readwrite,assign,getter=OAuthAccessToken,setter=setOAuthAccessToken:) NSString* OAuthAccessToken;

- (NSString*)OAuthAccessToken;
- (void)setOAuthAccessToken :(NSString*)newOAuthAccessToken;

@property (nonatomic,readwrite,assign,getter=OAuthAuthorizationCode,setter=setOAuthAuthorizationCode:) NSString* OAuthAuthorizationCode;

- (NSString*)OAuthAuthorizationCode;
- (void)setOAuthAuthorizationCode :(NSString*)newOAuthAuthorizationCode;

@property (nonatomic,readwrite,assign,getter=OAuthAuthorizationScope,setter=setOAuthAuthorizationScope:) NSString* OAuthAuthorizationScope;

- (NSString*)OAuthAuthorizationScope;
- (void)setOAuthAuthorizationScope :(NSString*)newOAuthAuthorizationScope;

@property (nonatomic,readwrite,assign,getter=OAuthClientId,setter=setOAuthClientId:) NSString* OAuthClientId;

- (NSString*)OAuthClientId;
- (void)setOAuthClientId :(NSString*)newOAuthClientId;

@property (nonatomic,readwrite,assign,getter=OAuthClientProfile,setter=setOAuthClientProfile:) int OAuthClientProfile;

- (int)OAuthClientProfile;
- (void)setOAuthClientProfile :(int)newOAuthClientProfile;

@property (nonatomic,readwrite,assign,getter=OAuthClientSecret,setter=setOAuthClientSecret:) NSString* OAuthClientSecret;

- (NSString*)OAuthClientSecret;
- (void)setOAuthClientSecret :(NSString*)newOAuthClientSecret;

@property (nonatomic,readwrite,assign,getter=OAuthGrantType,setter=setOAuthGrantType:) int OAuthGrantType;

- (int)OAuthGrantType;
- (void)setOAuthGrantType :(int)newOAuthGrantType;

@property (nonatomic,readwrite,assign,getter=OAuthRefreshToken,setter=setOAuthRefreshToken:) NSString* OAuthRefreshToken;

- (NSString*)OAuthRefreshToken;
- (void)setOAuthRefreshToken :(NSString*)newOAuthRefreshToken;

@property (nonatomic,readwrite,assign,getter=OAuthRequestRefreshToken,setter=setOAuthRequestRefreshToken:) BOOL OAuthRequestRefreshToken;

- (BOOL)OAuthRequestRefreshToken;
- (void)setOAuthRequestRefreshToken :(BOOL)newOAuthRequestRefreshToken;

@property (nonatomic,readwrite,assign,getter=OAuthReturnURL,setter=setOAuthReturnURL:) NSString* OAuthReturnURL;

- (NSString*)OAuthReturnURL;
- (void)setOAuthReturnURL :(NSString*)newOAuthReturnURL;

@property (nonatomic,readwrite,assign,getter=OAuthServerAuthURL,setter=setOAuthServerAuthURL:) NSString* OAuthServerAuthURL;

- (NSString*)OAuthServerAuthURL;
- (void)setOAuthServerAuthURL :(NSString*)newOAuthServerAuthURL;

@property (nonatomic,readwrite,assign,getter=OAuthServerTokenURL,setter=setOAuthServerTokenURL:) NSString* OAuthServerTokenURL;

- (NSString*)OAuthServerTokenURL;
- (void)setOAuthServerTokenURL :(NSString*)newOAuthServerTokenURL;

@property (nonatomic,readonly,assign,getter=OAuthWebAuthURL) NSString* OAuthWebAuthURL;

- (NSString*)OAuthWebAuthURL;

 

Default Value

False

Remarks

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

OtherHeaders Property (SharePoint Module)

Other headers as determined by the user (optional).

Syntax

• Swift
• Objective-C

public var otherHeaders: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=otherHeaders,setter=setOtherHeaders:) NSString* otherHeaders;

- (NSString*)otherHeaders;
- (void)setOtherHeaders :(NSString*)newOtherHeaders;

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 .

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

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

Overwrite Property (SharePoint Module)

Whether to overwrite the local or remote file.

Syntax

• Swift
• Objective-C

public var overwrite: Bool {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=overwrite,setter=setOverwrite:) BOOL overwrite;

- (BOOL)overwrite;
- (void)setOverwrite :(BOOL)newOverwrite;

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

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

Syntax

• Swift
• Objective-C

public var parsedHeaders: Array<Header> {
  get {...}
}

@property (nonatomic,readonly,assign,getter=parsedHeaderCount) int parsedHeaderCount;

- (int)parsedHeaderCount;

- (NSString*)parsedHeaderField:(int)parsedHeaderIndex;

- (NSString*)parsedHeaderValue:(int)parsedHeaderIndex;

Default Value

False

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.

Proxy Property (SharePoint Module)

A set of properties related to proxy access.

Syntax

• Swift
• Objective-C

public var proxy: Proxy {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=proxyAuthScheme,setter=setProxyAuthScheme:) int proxyAuthScheme;

- (int)proxyAuthScheme;
- (void)setProxyAuthScheme :(int)newProxyAuthScheme;

@property (nonatomic,readwrite,assign,getter=proxyAutoDetect,setter=setProxyAutoDetect:) BOOL proxyAutoDetect;

- (BOOL)proxyAutoDetect;
- (void)setProxyAutoDetect :(BOOL)newProxyAutoDetect;

@property (nonatomic,readwrite,assign,getter=proxyPassword,setter=setProxyPassword:) NSString* proxyPassword;

- (NSString*)proxyPassword;
- (void)setProxyPassword :(NSString*)newProxyPassword;

@property (nonatomic,readwrite,assign,getter=proxyPort,setter=setProxyPort:) int proxyPort;

- (int)proxyPort;
- (void)setProxyPort :(int)newProxyPort;

@property (nonatomic,readwrite,assign,getter=proxyServer,setter=setProxyServer:) NSString* proxyServer;

- (NSString*)proxyServer;
- (void)setProxyServer :(NSString*)newProxyServer;

@property (nonatomic,readwrite,assign,getter=proxySSL,setter=setProxySSL:) int proxySSL;

- (int)proxySSL;
- (void)setProxySSL :(int)newProxySSL;

@property (nonatomic,readwrite,assign,getter=proxyUser,setter=setProxyUser:) NSString* proxyUser;

- (NSString*)proxyUser;
- (void)setProxyUser :(NSString*)newProxyUser;

 

Default Value

False

Remarks

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

QueryParams Property (SharePoint Module)

Additional query parameters to be included in the request.

Syntax

• Swift
• Objective-C

public var queryParams: Array<QueryParam> {
  get {...}
}

@property (nonatomic,readwrite,assign,getter=queryParamCount,setter=setQueryParamCount:) int queryParamCount;

- (int)queryParamCount;
- (void)setQueryParamCount :(int)newQueryParamCount;

- (NSString*)queryParamName:(int)queryParamIndex;
- (void)setQueryParamName:(int)queryParamIndex :(NSString*)newQueryParamName;

- (NSString*)queryParamValue:(int)queryParamIndex;
- (void)setQueryParamValue:(int)queryParamIndex :(NSString*)newQueryParamValue;

Default Value

False

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

The range of bytes to request.

Syntax

• Swift
• Objective-C

public var range: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=range,setter=setRange:) NSString* range;

- (NSString*)range;
- (void)setRange :(NSString*)newRange;

Default Value

""

Remarks

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

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

• StartByte-
• StartByte-EndByte

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

RemoteId Property (SharePoint Module)

Selects a remote resource by Id.

Syntax

• Swift
• Objective-C

public var remoteId: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=remoteId,setter=setRemoteId:) NSString* remoteId;

- (NSString*)remoteId;
- (void)setRemoteId :(NSString*)newRemoteId;

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.

RemotePath Property (SharePoint Module)

Selects a remote resource by path.

Syntax

• Swift
• Objective-C

public var remotePath: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=remotePath,setter=setRemotePath:) NSString* remotePath;

- (NSString*)remotePath;
- (void)setRemotePath :(NSString*)newRemotePath;

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.

ResourceData Property (SharePoint Module)

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

Syntax

• Swift
• Objective-C

public var resourceData: String {
  get {...}
  set {...}
}

public var resourceDataB: Data {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=resourceData,setter=setResourceData:) NSString* resourceData;

- (NSString*)resourceData;
- (void)setResourceData :(NSString*)newResourceData;

@property (nonatomic,readwrite,assign,getter=resourceDataB,setter=setResourceDataB:) NSData* resourceDataB;

- (NSData*)resourceDataB;
- (void)setResourceDataB :(NSData*)newResourceData;

Default Value

""

Remarks

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

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

ResourceMarker Property (SharePoint Module)

A marker indicating what page of resources to return next.

Syntax

• Swift
• Objective-C

public var resourceMarker: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=resourceMarker,setter=setResourceMarker:) NSString* resourceMarker;

- (NSString*)resourceMarker;
- (void)setResourceMarker :(NSString*)newResourceMarker;

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.

Resources Property (SharePoint Module)

A collection of resources.

Syntax

• Swift
• Objective-C

public var resources: Array<SharePointResource> {
  get {...}
}

@property (nonatomic,readwrite,assign,getter=resourceCount,setter=setResourceCount:) int resourceCount;

- (int)resourceCount;
- (void)setResourceCount :(int)newResourceCount;

- (int)resourceChildCount:(int)resourceIndex;

- (NSString*)resourceCreatedTime:(int)resourceIndex;

- (BOOL)resourceDeleted:(int)resourceIndex;

- (NSString*)resourceDocumentLibraryId:(int)resourceIndex;

- (NSString*)resourceETag:(int)resourceIndex;

- (NSString*)resourceHash:(int)resourceIndex;

- (int)resourceHashAlgorithm:(int)resourceIndex;
- (void)setResourceHashAlgorithm:(int)resourceIndex :(int)newResourceHashAlgorithm;

- (NSString*)resourceId:(int)resourceIndex;
- (void)setResourceId:(int)resourceIndex :(NSString*)newResourceId;

- (NSString*)resourceMIMEType:(int)resourceIndex;

- (NSString*)resourceModifiedTime:(int)resourceIndex;

- (NSString*)resourceName:(int)resourceIndex;
- (void)setResourceName:(int)resourceIndex :(NSString*)newResourceName;

- (NSString*)resourceParentId:(int)resourceIndex;
- (void)setResourceParentId:(int)resourceIndex :(NSString*)newResourceParentId;

- (NSString*)resourceParentPath:(int)resourceIndex;
- (void)setResourceParentPath:(int)resourceIndex :(NSString*)newResourceParentPath;

- (NSString*)resourcePath:(int)resourceIndex;
- (void)setResourcePath:(int)resourceIndex :(NSString*)newResourcePath;

- (long long)resourceSize:(int)resourceIndex;

- (int)resourceType:(int)resourceIndex;

- (NSString*)resourceWebURL:(int)resourceIndex;

Default Value

False

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.

ResumeURL Property (SharePoint Module)

The resumable upload URL.

Syntax

• Swift
• Objective-C

public var resumeURL: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=resumeURL,setter=setResumeURL:) NSString* resumeURL;

- (NSString*)resumeURL;
- (void)setResumeURL :(NSString*)newResumeURL;

Default Value

""

Remarks

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

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

SearchMarker Property (SharePoint Module)

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

Syntax

• Swift
• Objective-C

public var searchMarker: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=searchMarker,setter=setSearchMarker:) NSString* searchMarker;

- (NSString*)searchMarker;
- (void)setSearchMarker :(NSString*)newSearchMarker;

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.

SiteId Property (SharePoint Module)

Selects a SharePoint site.

Syntax

• Swift
• Objective-C

public var siteId: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=siteId,setter=setSiteId:) NSString* siteId;

- (NSString*)siteId;
- (void)setSiteId :(NSString*)newSiteId;

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

A collection of sites.

Syntax

• Swift
• Objective-C

public var sites: Array<SharePointSite> {
  get {...}
}

@property (nonatomic,readonly,assign,getter=siteInfoCount) int siteInfoCount;

- (int)siteInfoCount;

- (NSString*)siteInfoId:(int)siteInfoIndex;

- (NSString*)siteInfoName:(int)siteInfoIndex;

- (NSString*)siteInfoURL:(int)siteInfoIndex;

Default Value

False

Remarks

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

SSLAcceptServerCert Property (SharePoint Module)

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

Syntax

• Swift
• Objective-C

public var sslAcceptServerCert: Certificate {
  get {...}
  set {...}
}

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertEffectiveDate) NSString* SSLAcceptServerCertEffectiveDate;

- (NSString*)SSLAcceptServerCertEffectiveDate;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertExpirationDate) NSString* SSLAcceptServerCertExpirationDate;

- (NSString*)SSLAcceptServerCertExpirationDate;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertExtendedKeyUsage) NSString* SSLAcceptServerCertExtendedKeyUsage;

- (NSString*)SSLAcceptServerCertExtendedKeyUsage;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertFingerprint) NSString* SSLAcceptServerCertFingerprint;

- (NSString*)SSLAcceptServerCertFingerprint;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertFingerprintSHA1) NSString* SSLAcceptServerCertFingerprintSHA1;

- (NSString*)SSLAcceptServerCertFingerprintSHA1;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertFingerprintSHA256) NSString* SSLAcceptServerCertFingerprintSHA256;

- (NSString*)SSLAcceptServerCertFingerprintSHA256;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertIssuer) NSString* SSLAcceptServerCertIssuer;

- (NSString*)SSLAcceptServerCertIssuer;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertPrivateKey) NSString* SSLAcceptServerCertPrivateKey;

- (NSString*)SSLAcceptServerCertPrivateKey;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertPrivateKeyAvailable) BOOL SSLAcceptServerCertPrivateKeyAvailable;

- (BOOL)SSLAcceptServerCertPrivateKeyAvailable;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertPrivateKeyContainer) NSString* SSLAcceptServerCertPrivateKeyContainer;

- (NSString*)SSLAcceptServerCertPrivateKeyContainer;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertPublicKey) NSString* SSLAcceptServerCertPublicKey;

- (NSString*)SSLAcceptServerCertPublicKey;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertPublicKeyAlgorithm) NSString* SSLAcceptServerCertPublicKeyAlgorithm;

- (NSString*)SSLAcceptServerCertPublicKeyAlgorithm;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertPublicKeyLength) int SSLAcceptServerCertPublicKeyLength;

- (int)SSLAcceptServerCertPublicKeyLength;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertSerialNumber) NSString* SSLAcceptServerCertSerialNumber;

- (NSString*)SSLAcceptServerCertSerialNumber;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertSignatureAlgorithm) NSString* SSLAcceptServerCertSignatureAlgorithm;

- (NSString*)SSLAcceptServerCertSignatureAlgorithm;

@property (nonatomic,readwrite,assign,getter=SSLAcceptServerCertStore,setter=setSSLAcceptServerCertStore:) NSString* SSLAcceptServerCertStore;

- (NSString*)SSLAcceptServerCertStore;
- (void)setSSLAcceptServerCertStore :(NSString*)newSSLAcceptServerCertStore;

@property (nonatomic,readwrite,assign,getter=SSLAcceptServerCertStoreB,setter=setSSLAcceptServerCertStoreB:) NSData* SSLAcceptServerCertStoreB;

- (NSData*)SSLAcceptServerCertStoreB;
- (void)setSSLAcceptServerCertStoreB :(NSData*)newSSLAcceptServerCertStore;
@property (nonatomic,readwrite,assign,getter=SSLAcceptServerCertStorePassword,setter=setSSLAcceptServerCertStorePassword:) NSString* SSLAcceptServerCertStorePassword;

- (NSString*)SSLAcceptServerCertStorePassword;
- (void)setSSLAcceptServerCertStorePassword :(NSString*)newSSLAcceptServerCertStorePassword;

@property (nonatomic,readwrite,assign,getter=SSLAcceptServerCertStoreType,setter=setSSLAcceptServerCertStoreType:) int SSLAcceptServerCertStoreType;

- (int)SSLAcceptServerCertStoreType;
- (void)setSSLAcceptServerCertStoreType :(int)newSSLAcceptServerCertStoreType;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertSubjectAltNames) NSString* SSLAcceptServerCertSubjectAltNames;

- (NSString*)SSLAcceptServerCertSubjectAltNames;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertThumbprintMD5) NSString* SSLAcceptServerCertThumbprintMD5;

- (NSString*)SSLAcceptServerCertThumbprintMD5;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertThumbprintSHA1) NSString* SSLAcceptServerCertThumbprintSHA1;

- (NSString*)SSLAcceptServerCertThumbprintSHA1;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertThumbprintSHA256) NSString* SSLAcceptServerCertThumbprintSHA256;

- (NSString*)SSLAcceptServerCertThumbprintSHA256;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertUsage) NSString* SSLAcceptServerCertUsage;

- (NSString*)SSLAcceptServerCertUsage;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertUsageFlags) int SSLAcceptServerCertUsageFlags;

- (int)SSLAcceptServerCertUsageFlags;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertVersion) NSString* SSLAcceptServerCertVersion;

- (NSString*)SSLAcceptServerCertVersion;

@property (nonatomic,readwrite,assign,getter=SSLAcceptServerCertSubject,setter=setSSLAcceptServerCertSubject:) NSString* SSLAcceptServerCertSubject;

- (NSString*)SSLAcceptServerCertSubject;
- (void)setSSLAcceptServerCertSubject :(NSString*)newSSLAcceptServerCertSubject;

@property (nonatomic,readwrite,assign,getter=SSLAcceptServerCertEncoded,setter=setSSLAcceptServerCertEncoded:) NSString* SSLAcceptServerCertEncoded;

- (NSString*)SSLAcceptServerCertEncoded;
- (void)setSSLAcceptServerCertEncoded :(NSString*)newSSLAcceptServerCertEncoded;

@property (nonatomic,readwrite,assign,getter=SSLAcceptServerCertEncodedB,setter=setSSLAcceptServerCertEncodedB:) NSData* SSLAcceptServerCertEncodedB;

- (NSData*)SSLAcceptServerCertEncodedB;
- (void)setSSLAcceptServerCertEncodedB :(NSData*)newSSLAcceptServerCertEncoded;
 

Default Value

False

Remarks

If it finds any issues with the certificate presented by the server, the class 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.

Note: This functionality is provided only for cases in which 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 Module)

The certificate to be used during Secure Sockets Layer (SSL) negotiation.

Syntax

• Swift
• Objective-C

public var sslCert: Certificate {
  get {...}
  set {...}
}

@property (nonatomic,readonly,assign,getter=SSLCertEffectiveDate) NSString* SSLCertEffectiveDate;

- (NSString*)SSLCertEffectiveDate;

@property (nonatomic,readonly,assign,getter=SSLCertExpirationDate) NSString* SSLCertExpirationDate;

- (NSString*)SSLCertExpirationDate;

@property (nonatomic,readonly,assign,getter=SSLCertExtendedKeyUsage) NSString* SSLCertExtendedKeyUsage;

- (NSString*)SSLCertExtendedKeyUsage;

@property (nonatomic,readonly,assign,getter=SSLCertFingerprint) NSString* SSLCertFingerprint;

- (NSString*)SSLCertFingerprint;

@property (nonatomic,readonly,assign,getter=SSLCertFingerprintSHA1) NSString* SSLCertFingerprintSHA1;

- (NSString*)SSLCertFingerprintSHA1;

@property (nonatomic,readonly,assign,getter=SSLCertFingerprintSHA256) NSString* SSLCertFingerprintSHA256;

- (NSString*)SSLCertFingerprintSHA256;

@property (nonatomic,readonly,assign,getter=SSLCertIssuer) NSString* SSLCertIssuer;

- (NSString*)SSLCertIssuer;

@property (nonatomic,readonly,assign,getter=SSLCertPrivateKey) NSString* SSLCertPrivateKey;

- (NSString*)SSLCertPrivateKey;

@property (nonatomic,readonly,assign,getter=SSLCertPrivateKeyAvailable) BOOL SSLCertPrivateKeyAvailable;

- (BOOL)SSLCertPrivateKeyAvailable;

@property (nonatomic,readonly,assign,getter=SSLCertPrivateKeyContainer) NSString* SSLCertPrivateKeyContainer;

- (NSString*)SSLCertPrivateKeyContainer;

@property (nonatomic,readonly,assign,getter=SSLCertPublicKey) NSString* SSLCertPublicKey;

- (NSString*)SSLCertPublicKey;

@property (nonatomic,readonly,assign,getter=SSLCertPublicKeyAlgorithm) NSString* SSLCertPublicKeyAlgorithm;

- (NSString*)SSLCertPublicKeyAlgorithm;

@property (nonatomic,readonly,assign,getter=SSLCertPublicKeyLength) int SSLCertPublicKeyLength;

- (int)SSLCertPublicKeyLength;

@property (nonatomic,readonly,assign,getter=SSLCertSerialNumber) NSString* SSLCertSerialNumber;

- (NSString*)SSLCertSerialNumber;

@property (nonatomic,readonly,assign,getter=SSLCertSignatureAlgorithm) NSString* SSLCertSignatureAlgorithm;

- (NSString*)SSLCertSignatureAlgorithm;

@property (nonatomic,readwrite,assign,getter=SSLCertStore,setter=setSSLCertStore:) NSString* SSLCertStore;

- (NSString*)SSLCertStore;
- (void)setSSLCertStore :(NSString*)newSSLCertStore;

@property (nonatomic,readwrite,assign,getter=SSLCertStoreB,setter=setSSLCertStoreB:) NSData* SSLCertStoreB;

- (NSData*)SSLCertStoreB;
- (void)setSSLCertStoreB :(NSData*)newSSLCertStore;
@property (nonatomic,readwrite,assign,getter=SSLCertStorePassword,setter=setSSLCertStorePassword:) NSString* SSLCertStorePassword;

- (NSString*)SSLCertStorePassword;
- (void)setSSLCertStorePassword :(NSString*)newSSLCertStorePassword;

@property (nonatomic,readwrite,assign,getter=SSLCertStoreType,setter=setSSLCertStoreType:) int SSLCertStoreType;

- (int)SSLCertStoreType;
- (void)setSSLCertStoreType :(int)newSSLCertStoreType;

@property (nonatomic,readonly,assign,getter=SSLCertSubjectAltNames) NSString* SSLCertSubjectAltNames;

- (NSString*)SSLCertSubjectAltNames;

@property (nonatomic,readonly,assign,getter=SSLCertThumbprintMD5) NSString* SSLCertThumbprintMD5;

- (NSString*)SSLCertThumbprintMD5;

@property (nonatomic,readonly,assign,getter=SSLCertThumbprintSHA1) NSString* SSLCertThumbprintSHA1;

- (NSString*)SSLCertThumbprintSHA1;

@property (nonatomic,readonly,assign,getter=SSLCertThumbprintSHA256) NSString* SSLCertThumbprintSHA256;

- (NSString*)SSLCertThumbprintSHA256;

@property (nonatomic,readonly,assign,getter=SSLCertUsage) NSString* SSLCertUsage;

- (NSString*)SSLCertUsage;

@property (nonatomic,readonly,assign,getter=SSLCertUsageFlags) int SSLCertUsageFlags;

- (int)SSLCertUsageFlags;

@property (nonatomic,readonly,assign,getter=SSLCertVersion) NSString* SSLCertVersion;

- (NSString*)SSLCertVersion;

@property (nonatomic,readwrite,assign,getter=SSLCertSubject,setter=setSSLCertSubject:) NSString* SSLCertSubject;

- (NSString*)SSLCertSubject;
- (void)setSSLCertSubject :(NSString*)newSSLCertSubject;

@property (nonatomic,readwrite,assign,getter=SSLCertEncoded,setter=setSSLCertEncoded:) NSString* SSLCertEncoded;

- (NSString*)SSLCertEncoded;
- (void)setSSLCertEncoded :(NSString*)newSSLCertEncoded;

@property (nonatomic,readwrite,assign,getter=SSLCertEncodedB,setter=setSSLCertEncodedB:) NSData* SSLCertEncodedB;

- (NSData*)SSLCertEncodedB;
- (void)setSSLCertEncodedB :(NSData*)newSSLCertEncoded;
 

Default Value

False

Remarks

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

SSLProvider Property (SharePoint Module)

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

Syntax

• Swift
• Objective-C

public var sslProvider: SharePointSSLProviders {
  get {...}
  set {...}
}

public enum SharePointSSLProviders: Int32 {
  case sslpAutomatic = 0
  case sslpPlatform = 1
  case sslpInternal = 2
}

@property (nonatomic,readwrite,assign,getter=SSLProvider,setter=setSSLProvider:) int SSLProvider;

- (int)SSLProvider;
- (void)setSSLProvider :(int)newSSLProvider;

Default Value

0

Remarks

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

Possible values are as follows:

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

When Automatic is selected, the platform implementation will be used by default in all cases in the macOS edition.

SSLServerCert Property (SharePoint Module)

The server certificate for the last established connection.

Syntax

• Swift
• Objective-C

public var sslServerCert: Certificate {
  get {...}
}

@property (nonatomic,readonly,assign,getter=SSLServerCertEffectiveDate) NSString* SSLServerCertEffectiveDate;

- (NSString*)SSLServerCertEffectiveDate;

@property (nonatomic,readonly,assign,getter=SSLServerCertExpirationDate) NSString* SSLServerCertExpirationDate;

- (NSString*)SSLServerCertExpirationDate;

@property (nonatomic,readonly,assign,getter=SSLServerCertExtendedKeyUsage) NSString* SSLServerCertExtendedKeyUsage;

- (NSString*)SSLServerCertExtendedKeyUsage;

@property (nonatomic,readonly,assign,getter=SSLServerCertFingerprint) NSString* SSLServerCertFingerprint;

- (NSString*)SSLServerCertFingerprint;

@property (nonatomic,readonly,assign,getter=SSLServerCertFingerprintSHA1) NSString* SSLServerCertFingerprintSHA1;

- (NSString*)SSLServerCertFingerprintSHA1;

@property (nonatomic,readonly,assign,getter=SSLServerCertFingerprintSHA256) NSString* SSLServerCertFingerprintSHA256;

- (NSString*)SSLServerCertFingerprintSHA256;

@property (nonatomic,readonly,assign,getter=SSLServerCertIssuer) NSString* SSLServerCertIssuer;

- (NSString*)SSLServerCertIssuer;

@property (nonatomic,readonly,assign,getter=SSLServerCertPrivateKey) NSString* SSLServerCertPrivateKey;

- (NSString*)SSLServerCertPrivateKey;

@property (nonatomic,readonly,assign,getter=SSLServerCertPrivateKeyAvailable) BOOL SSLServerCertPrivateKeyAvailable;

- (BOOL)SSLServerCertPrivateKeyAvailable;

@property (nonatomic,readonly,assign,getter=SSLServerCertPrivateKeyContainer) NSString* SSLServerCertPrivateKeyContainer;

- (NSString*)SSLServerCertPrivateKeyContainer;

@property (nonatomic,readonly,assign,getter=SSLServerCertPublicKey) NSString* SSLServerCertPublicKey;

- (NSString*)SSLServerCertPublicKey;

@property (nonatomic,readonly,assign,getter=SSLServerCertPublicKeyAlgorithm) NSString* SSLServerCertPublicKeyAlgorithm;

- (NSString*)SSLServerCertPublicKeyAlgorithm;

@property (nonatomic,readonly,assign,getter=SSLServerCertPublicKeyLength) int SSLServerCertPublicKeyLength;

- (int)SSLServerCertPublicKeyLength;

@property (nonatomic,readonly,assign,getter=SSLServerCertSerialNumber) NSString* SSLServerCertSerialNumber;

- (NSString*)SSLServerCertSerialNumber;

@property (nonatomic,readonly,assign,getter=SSLServerCertSignatureAlgorithm) NSString* SSLServerCertSignatureAlgorithm;

- (NSString*)SSLServerCertSignatureAlgorithm;

@property (nonatomic,readonly,assign,getter=SSLServerCertStore) NSString* SSLServerCertStore;

- (NSString*)SSLServerCertStore;

@property (nonatomic,readonly,assign,getter=SSLServerCertStoreB) NSData* SSLServerCertStoreB;

- (NSData*)SSLServerCertStoreB;
@property (nonatomic,readonly,assign,getter=SSLServerCertStorePassword) NSString* SSLServerCertStorePassword;

- (NSString*)SSLServerCertStorePassword;

@property (nonatomic,readonly,assign,getter=SSLServerCertStoreType) int SSLServerCertStoreType;

- (int)SSLServerCertStoreType;

@property (nonatomic,readonly,assign,getter=SSLServerCertSubjectAltNames) NSString* SSLServerCertSubjectAltNames;

- (NSString*)SSLServerCertSubjectAltNames;

@property (nonatomic,readonly,assign,getter=SSLServerCertThumbprintMD5) NSString* SSLServerCertThumbprintMD5;

- (NSString*)SSLServerCertThumbprintMD5;

@property (nonatomic,readonly,assign,getter=SSLServerCertThumbprintSHA1) NSString* SSLServerCertThumbprintSHA1;

- (NSString*)SSLServerCertThumbprintSHA1;

@property (nonatomic,readonly,assign,getter=SSLServerCertThumbprintSHA256) NSString* SSLServerCertThumbprintSHA256;

- (NSString*)SSLServerCertThumbprintSHA256;

@property (nonatomic,readonly,assign,getter=SSLServerCertUsage) NSString* SSLServerCertUsage;

- (NSString*)SSLServerCertUsage;

@property (nonatomic,readonly,assign,getter=SSLServerCertUsageFlags) int SSLServerCertUsageFlags;

- (int)SSLServerCertUsageFlags;

@property (nonatomic,readonly,assign,getter=SSLServerCertVersion) NSString* SSLServerCertVersion;

- (NSString*)SSLServerCertVersion;

@property (nonatomic,readonly,assign,getter=SSLServerCertSubject) NSString* SSLServerCertSubject;

- (NSString*)SSLServerCertSubject;

@property (nonatomic,readonly,assign,getter=SSLServerCertEncoded) NSString* SSLServerCertEncoded;

- (NSString*)SSLServerCertEncoded;

@property (nonatomic,readonly,assign,getter=SSLServerCertEncodedB) NSData* SSLServerCertEncodedB;

- (NSData*)SSLServerCertEncodedB;
 

Default Value

False

Remarks

This property contains the server certificate for the last established connection.

SSLServerCert is reset every time a new connection is attempted.

StartByte Property (SharePoint Module)

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

Syntax

• Swift
• Objective-C

public var startByte: Int64 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=startByte,setter=setStartByte:) long long startByte;

- (long long)startByte;
- (void)setStartByte :(long long)newStartByte;

Default Value

0

Remarks

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

Timeout Property (SharePoint Module)

The timeout for the module.

Syntax

• Swift
• Objective-C

public var timeout: Int32 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=timeout,setter=setTimeout:) int timeout;

- (int)timeout;
- (void)setTimeout :(int)newTimeout;

Default Value

60

Remarks

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

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

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

If Timeout expires, and the operation is not yet complete, the class .

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

The default value for the Timeout property is 60 seconds.

UseResumableUpload Property (SharePoint Module)

Whether to use resumable uploads.

Syntax

• Swift
• Objective-C

public var useResumableUpload: Bool {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=useResumableUpload,setter=setUseResumableUpload:) BOOL useResumableUpload;

- (BOOL)useResumableUpload;
- (void)setUseResumableUpload :(BOOL)newUseResumableUpload;

Default Value

False

Remarks

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

Refer to UploadFile for more information.

AbortUpload Method (SharePoint Module)

Aborts the current resumable upload session.

Syntax

• Swift
• Objective-C

public func abortUpload() throws -> Void

- (void)abortUpload;

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

Adds a query parameter to the QueryParams properties.

Syntax

• Swift
• Objective-C

public func addQueryParam(name: String, value: String) throws -> Void

- (void)addQueryParam:(NSString*)name :(NSString*)value;

Remarks

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

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

Authorize Method (SharePoint Module)

Get the authorization string required to access the protected resource.

Syntax

• Swift
• Objective-C

public func authorize() throws -> Void

- (void)authorize;

Remarks

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

For more information, see the introduction section.

CalcAuthorization Method (SharePoint Module)

Calculates the Authorization header based on provided credentials.

Syntax

• Swift
• Objective-C

public func calcAuthorization() throws -> Void

- (void)calcAuthorization;

Remarks

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

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

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

Config Method (SharePoint Module)

Sets or retrieves a configuration setting.

Syntax

• Swift
• Objective-C

public func config(configurationString: String) throws -> String

- (NSString*)config:(NSString*)configurationString;

Remarks

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

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

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

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

CopyResource Method (SharePoint Module)

Copies the currently selected resource.

Syntax

• Swift
• Objective-C

public func copyResource(parentId: String, newName: String) throws -> Void

- (void)copyResource:(NSString*)parentId :(NSString*)newName;

Remarks

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

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

Monitoring Copy Operations

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

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

CreateFolder Method (SharePoint Module)

Creates a new folder resource.

Syntax

• Swift
• Objective-C

public func createFolder(folderName: String) throws -> String

- (NSString*)createFolder:(NSString*)folderName;

Remarks

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

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

Name Conflict Resolution

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

CreateLink Method (SharePoint Module)

Creates a resource sharing link.

Syntax

• Swift
• Objective-C

public func createLink(readOnly: Bool) throws -> String

- (NSString*)createLink:(BOOL)readOnly;

Remarks

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

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

DeleteResource Method (SharePoint Module)

Deletes the currently selected resource.

Syntax

• Swift
• Objective-C

public func deleteResource() throws -> Void

- (void)deleteResource;

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

Downloads the currently selected file resource.

Syntax

• Swift
• Objective-C

public func downloadFile() throws -> Void

- (void)downloadFile;

Remarks

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

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

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

Download Notes

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

Resuming Downloads

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

Resuming Encrypted File Downloads

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

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

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

GetCurrentChangeMarker Method (SharePoint Module)

Gets the most current change marker.

Syntax

• Swift
• Objective-C

public func getCurrentChangeMarker() throws -> Void

- (void)getCurrentChangeMarker;

Remarks

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

Refer to ListChanges for more information.

GetDocumentLibraryInfo Method (SharePoint Module)

Gets information about the currently selected document library.

Syntax

• Swift
• Objective-C

public func getDocumentLibraryInfo() throws -> Void

- (void)getDocumentLibraryInfo;

Remarks

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

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

GetResourceInfo Method (SharePoint Module)

Gets information about the currently selected resource.

Syntax

• Swift
• Objective-C

public func getResourceInfo() throws -> Void

- (void)getResourceInfo;

Remarks

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

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

Interrupt Method (SharePoint Module)

This method interrupts the current method.

Syntax

• Swift
• Objective-C

public func interrupt() throws -> Void

- (void)interrupt;

Remarks

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

ListChanges Method (SharePoint Module)

Lists changes to resources in the currently selected document library.

Syntax

• Swift
• Objective-C

public func listChanges() throws -> Void

- (void)listChanges;

Remarks

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

Starting from a Baseline State

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

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

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

Starting from the Latest State

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

General Usage

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

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

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

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

Usage Considerations

• 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 Module)

Lists the document libraries in the current site.

Syntax

• Swift
• Objective-C

public func listDocumentLibraries() throws -> Void

- (void)listDocumentLibraries;

Remarks

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

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

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

ListResources Method (SharePoint Module)

Lists resources in the currently selected folder.

Syntax

• Swift
• Objective-C

public func listResources() throws -> Void

- (void)listResources;

Remarks

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

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

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

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

ListSites Method (SharePoint Module)

List the sites currently accessible by the authenticated entity.

Syntax

• Swift
• Objective-C

public func listSites() throws -> Void

- (void)listSites;

Remarks

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

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

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

MoveResource Method (SharePoint Module)

Moves the currently selected resource.

Syntax

• Swift
• Objective-C

public func moveResource(parentId: String) throws -> Void

- (void)moveResource:(NSString*)parentId;

Remarks

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

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

PollCopyStatus Method (SharePoint Module)

Gets the status of a copy operation.

Syntax

• Swift
• Objective-C

public func pollCopyStatus() throws -> Void

- (void)pollCopyStatus;

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

Gets the status of the current resumable upload session.

Syntax

• Swift
• Objective-C

public func pollUploadStatus() throws -> Void

- (void)pollUploadStatus;

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

Resets the component to its initial state.

Syntax

• Swift
• Objective-C

public func reset() throws -> Void

- (void)reset;

Remarks

This method resets the class to its initial state.

Search Method (SharePoint Module)

Searches for resources that match the specified query.

Syntax

• Swift
• Objective-C

public func search(query: String) throws -> Void

- (void)search:(NSString*)query;

Remarks

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

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

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

SendCustomRequest Method (SharePoint Module)

Sends a custom request to the Microsoft Graph API.

Syntax

• Swift
• Objective-C

public func sendCustomRequest(httpMethod: String, requestPath: String, requestBody: String) throws -> Void

- (void)sendCustomRequest:(NSString*)httpMethod :(NSString*)requestPath :(NSString*)requestBody;

Remarks

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

Valid values for HttpMethod are:

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

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

Usage

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

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

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

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

UpdateResource Method (SharePoint Module)

Updates the currently selected resource.

Syntax

• Swift
• Objective-C

public func updateResource() throws -> Void

- (void)updateResource;

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 properties.
2. Modify the item's Resource* properties as desired; the following properties are supported:
   • ResourcesDescription (only updated if not empty)
   • ResourcesName
   • ResourcesParentId (only updated if not empty)
   • ResourcesParentPath (only updated if not empty and ResourcesParentId is empty)
   If the ClientCreatedTime and/or ClientModifiedTime configuration settings is non-empty, the corresponding timestamps will be sent as well.
3. For file resources, you may set LocalFile or ResourceData if you wish to update the file data on the server. (Refer to UploadFile for more information about simple vs. resumable uploads and encrypting the file data before uploading.)
4. Finally, call this method to update the resource.

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

Uploads a new file resource.

Syntax

• Swift
• Objective-C

public func uploadFile(fileName: String) throws -> String

- (NSString*)uploadFile:(NSString*)fileName;

Remarks

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

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

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

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

Upload Notes

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

Simple

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

Resumable

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

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

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

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

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

Name Conflict Resolution

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

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

Syntax

• Swift
• Objective-C

func onDocumentLibraryList(id: String, name: String, description: String, ownerId: String, ownerName: String)

- (void)onDocumentLibraryList:(NSString*)id :(NSString*)name :(NSString*)description :(NSString*)ownerId :(NSString*)ownerName;

Remarks

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

Id is the Id of the document library.

Name is the name of the document library.

Description holds the description of the document library.

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

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

EndTransfer Event (SharePoint Module)

This event fires when a document finishes transferring.

Syntax

• Swift
• Objective-C

func onEndTransfer(direction: Int32)

- (void)onEndTransfer:(int)direction;

Remarks

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

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

Error Event (SharePoint Module)

Fired when information is available about errors during data delivery.

Syntax

• Swift
• Objective-C

func onError(errorCode: Int32, description: String)

- (void)onError:(int)errorCode :(NSString*)description;

Remarks

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

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

Fires after each fragment of a resumable upload is completed.

Syntax

• Swift
• Objective-C

func onFragmentComplete(fragmentNumber: Int32, fragmentCount: Int32, interrupt: inout Bool)

- (void)onFragmentComplete:(int)fragmentNumber :(int)fragmentCount :(int*)interrupt;

Remarks

When UseResumableUpload is 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 to interrupt the upload. The upload may be resumed later.

Header Event (SharePoint Module)

Fired every time a header line comes in.

Syntax

• Swift
• Objective-C

func onHeader(field: String, value: String)

- (void)onHeader:(NSString*)field :(NSString*)value;

Remarks

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

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

Log Event (SharePoint Module)

Fired once for each log message.

Syntax

• Swift
• Objective-C

func onLog(logLevel: Int32, message: String, logType: String)

- (void)onLog:(int)logLevel :(NSString*)message :(NSString*)logType;

Remarks

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

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

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

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

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

Message is the log entry.

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

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

Progress Event (SharePoint Module)

Fires during an upload or download to indicate transfer progress.

Syntax

• Swift
• Objective-C

func onProgress(direction: Int32, bytesTransferred: Int64, totalBytes: Int64, percentDone: Int32)

- (void)onProgress:(int)direction :(long long)bytesTransferred :(long long)totalBytes :(int)percentDone;

Remarks

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

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

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

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

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

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

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

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

ResourceList Event (SharePoint Module)

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

Syntax

• Swift
• Objective-C

func onResourceList(id: String, name: String, path: String, resourceType: Int32, createdTime: String, modifiedTime: String, size: Int64, eTag: String, deleted: Bool)

- (void)onResourceList:(NSString*)id :(NSString*)name :(NSString*)path :(int)resourceType :(NSString*)createdTime :(NSString*)modifiedTime :(long long)size :(NSString*)ETag :(BOOL)deleted;

Remarks

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

Id is the Id of the resource.

Name is the name of the resource.

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

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

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

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

ETag is the ETag of the resource.

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

SiteList Event (SharePoint Module)

Fires once for each site returned when listing sites.

Syntax

• Swift
• Objective-C

func onSiteList(id: String, name: String, url: String)

- (void)onSiteList:(NSString*)id :(NSString*)name :(NSString*)URL;

Remarks

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

Id is the Id of the site.

Name is the name of the site.

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

SSLServerAuthentication Event (SharePoint Module)

Fired after the server presents its certificate to the client.

Syntax

• Swift
• Objective-C

func onSSLServerAuthentication(certEncoded: Data, certSubject: String, certIssuer: String, status: String, accept: inout Bool)

- (void)onSSLServerAuthentication:(NSData*)certEncoded :(NSString*)certSubject :(NSString*)certIssuer :(NSString*)status :(int*)accept;

Remarks

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

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

SSLStatus Event (SharePoint Module)

Fired when secure connection progress messages are available.

Syntax

• Swift
• Objective-C

func onSSLStatus(message: String)

- (void)onSSLStatus:(NSString*)message;

Remarks

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

StartTransfer Event (SharePoint Module)

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

Syntax

• Swift
• Objective-C

func onStartTransfer(direction: Int32)

- (void)onStartTransfer:(int)direction;

Remarks

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

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

Transfer Event (SharePoint Module)

Fired while a document transfers (delivers document).

Syntax

• Swift
• Objective-C

func onTransfer(direction: Int32, bytesTransferred: Int64, percentDone: Int32, text: Data)

- (void)onTransfer:(int)direction :(long long)bytesTransferred :(int)percentDone :(NSData*)text;

Remarks

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

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

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

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

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

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

public init()

public init(encoded: )

public init(storeType: , store: , storePassword: , subject: )

public init(storeType: , store: , storePassword: , subject: )

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 and the .

Fields

Constructors

public init()

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 , and its corresponding .

Fields

Constructors

public init()

public init(field: , value: )

OAuthSettings Type

The settings to use to authenticate with the service provider.

Remarks

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

Fields

Constructors

public init()

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 and the .

Fields

Constructors

public init()

public init(server: , port: )

public init(server: , port: , user: , password: )

QueryParam Type

A query parameter to send in the request.

Remarks

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

Fields

Constructors

public init()

public init(name: , value: )

SharePointDocumentLibrary Type

A SharePoint document library.

Remarks

This type represents a SharePoint document library.

Fields

Constructors

public init()

SharePointResource Type

A SharePoint resource.

Remarks

This type represents a SharePoint resource.

Fields

Constructors

public init()

SharePointSite Type

A SharePoint site.

Remarks

This type represents a SharePoint site.

Fields

Constructors

public init()

Config Settings (SharePoint Module)

SharePoint Config Settings

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

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

OAuth Config Settings

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert ...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert ...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert ...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert ...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

Socket Config Settings