Cloud Storage Integrator - Online Help
Cloud Storage Integrator
Questions / Feedback?

SharePoint Bean

Properties   Methods   Events   Configuration Settings   Errors  

Manages the documents of a Document Library on a SharePoint Server.

Syntax

InCloudStorage.Sharepoint

Remarks

The SPDocuments component allows you to manage SharePoint Documents.

To get started, first set the URL, User, and Password properties to point the component to your Site, and then set DocumentLibrary to the Id of a specific SharePoint Document Library to work with. To retrieve Ids for all of the Document Libraries on your Site, use the SPSITE component.

When List is called, the Document event will fire for each document in the specified library.

To download a document, call Get. Use the Add and AddFolder methods to add documents and folders to the library, and the Delete method to delete documents or folders. To check-out (lock) and check-in documents, use CheckOut and CheckIn. The DiscardCheckout method can be used to abort a previous call to CheckOut without checking-in changes.

About SharePoint Online Services

When using Microsoft SharePoint Online you must set AuthScheme to authSPOnline (7).

Property List


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

AuthSchemeThe authentication scheme to be used while authenticating with the server.
DocumentLibraryThe name of the selected document library.
EncryptionAlgorithmThe encryption algorithm.
EncryptionPasswordThe encryption password.
FirewallA set of properties related to firewall access.
IdleThe current status of the component.
LocalFileThe path to a local file for downloading.
PasswordThe password to use for authentication.
ProxyA set of properties related to proxy access.
SSLAcceptServerCertInstructs the component to unconditionally accept the server certificate that matches the supplied certificate.
SSLCertThe certificate to be used during SSL negotiation.
SSLServerCertThe server certificate for the last established connection.
TimeoutA timeout for the component.
URLThe base URL for the site.
UserThe user account to use for authentication.
VersionsA collection of document versions.

Method List


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

addAdds a document to the library specified by DocumentLibrary .
addFolderAdds a folder to the document library.
checkInChecks in a document.
checkOutChecks out a document.
configSets or retrieves a configuration setting .
copyCopies the specified document to a new location.
deleteDeletes a document from the library specified by DocumentLibrary .
discardCheckoutDiscards a checkout lock.
doEventsProcesses events from the internal message queue.
getRetrieves a document from the library specified by DocumentLibrary .
getIdRetrieve the Document Id of the specified document.
getXAttributeRetrieve the value at the specified XPath in the SOAP response.
interruptInterrupt the current method.
listLists the documents contained in the specified document library.
listVersionsLists the versions of the specified document.
moveMoves the specified document to a new document library.
renameRenames the specified document in the document library.
resetResets request-related properties.
sendCustomRequestSends a custom request to the server.
setDownloadStreamSets the stream to which the downloaded data from the server will be written.
setUploadStreamSets the stream to be uploaded to the server.

Event List


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

ConnectedFired immediately after a connection completes (or fails).
DisconnectedFired when a connection is closed.
DocumentFired for each document.
EndTransferFired when a document finishes transferring.
ErrorInformation about errors during data delivery.
SSLServerAuthenticationFired after the server presents its certificate to the client.
SSLStatusShows the progress of the secure connection.
StartTransferFired when a document starts transferring (after the headers).
TransferFired while a document transfers (delivers document).
VersionFired for each version.

Configuration Settings


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

CheckInTypeThe type of check-in performed.
CheckOutToLocalWhether the file is to be checked out for offline editting.
DocCommentUsed to set the first comment when adding a document.
DocMetaInfoSpecifies the metadata to be associated with a document when it is added.
DocumentAuthor[i]The author of the document indicated by index i.
DocumentCheckedOutBy[i]The user who has checked out the document indicated by index i.
DocumentCountThe number of documents returned by a call to List.
DocumentCreated[i]The date and time the document indicated by index i was created.
DocumentFileName[i]The filename of the document indicated by index i.
DocumentFileReference[i]The file reference of the document indicated by index i.
DocumentIsFolder[i]Whether the document indicated by index i is a folder.
DocumentModified[i]The date and time the document indicated by index i was last modified.
DocumentSourceControlVersion[i]The source control version of the document indicated by index i.
DocumentIndexSelects a document.
DocumentFieldCountThe number of fields for the current document.
DocumentFieldName[i]The name of the field at the specified index.
DocumentFieldValue[i]The value of the field at the specified index.
IncludedFieldsThe fields to request when calling List.
IncludeFieldsWithViewIdIndicates whether to use the IncludedFields setting when using the ViewId setting.
IncludeOrderByIdWhether to request that results are ordered by Id when listing documents.
LastModifiedA date in RFC 1123 date format representing the date and time of the last modification to the file.
PagingIdUsed to check for paged results from SharePoint.
QueryThe query to be used while listing documents.
RawEntryReturns the raw entry for the listing inside.
ResolveLibraryNamesControls whether or not library names will automatically be resolved.
RowLimitLimits the rows returned by ListItems.
SiteURLThe complete URL for a service.
ScopeSets the scope for the View used by the List method.
SOAPResponseThe response from the last request.
SOAPRequestThe contents of the request sent to the server.
StoreDocumentListWhether or not to store the Documents returned by the List method.
SubfolderThe subfolder of the specified document library.
FormBasedCookiesHolds the security cookies for Form-Based Authentication.
SPOnlineSecurityCookiesHolds the security cookies for SharePoint Online.
SPOnlineSSOWhether to use Single Sign On (SSO) with Active Directory Federation Services (ADFS).
SPOnlineSTSThe URL of the online STS.
SPOnlineADFSAuthSchemeThe HTTP authentication scheme used when working with SSO.
SSODomainSpecifies the federation domain configured in Office 365.
UseSOAPWhether to use SOAP or RPC calls for SharePoint operations.
VersionURLUsed to retrieve a specific past version of a document from SharePoint.
ViewIDThe GUID of a view to use when listing documents.
EncryptionIVThe initialization vector to be used for encryption/decryption.
EncryptionKeyThe key to use during encryption/decryption.
ParseCustomResponseWhether to automatically parse the response from the SendCustomRequest() method.
XPathProvides a way to point to a specific element in the returned XML response.
XTextThe text of the current element.
XElementThe name of the current element.
XNamespaceThe namespace of the current element.
XParentThe parent of the current element.
XPrefixThe prefix of the current element.
XSubTreeA snapshot of the current element in the document.
XAttributesCountThe number of attributes of the current element.
XAttributesName[x]The name of the selected attribute.
XAttributesValue[x]The attribute value.
XAttributesNamespace[x]The attribute namespace.
XAttributesPrefix[x]The attribute prefix.
XChildrenCountThe number of child elements of the current element.
XChildrenName[x]The name of the child element.
XChildrenXText[x]The inner text of the child element.
XChildrenNamespace[x]The namespace of the child element.
XChildrenPrefix[x]The prefix of the child element.
AcceptEncodingUsed to tell the server which types of content encodings the client supports.
AllowHTTPCompressionThis property enables HTTP compression for receiving data.
AllowIdenticalRedirectURLAllow redirects to the same URL.
AppendWhether to append data to LocalFile.
AuthorizationThe Authorization string to be sent to the server.
BytesTransferredContains the number of bytes transferred in the response data.
EncodeURLIf set to true the URL will be encoded by the component.
FollowRedirectsDetermines what happens when the server issues a redirect.
GetOn302RedirectIf set to true the component will perform a GET on the new location.
HTTPVersionThe version of HTTP used by the component.
IfModifiedSinceA date determining the maximum age of the desired document.
KeepAliveDetermines whether the HTTP connection is closed after completion of the request.
MaxRedirectAttemptsLimits the number of redirects that are followed in a request.
OtherHeadersOther headers as determined by the user (optional).
ProxyAuthorizationThe authorization string to be sent to the proxy server.
ProxyAuthSchemeThe authorization scheme to be used for the proxy.
ProxyPasswordA password if authentication is to be used for the proxy.
ProxyPortPort for the proxy server (default 80).
ProxyServerName or IP address of a proxy server (optional).
ProxyUserA user name if authentication is to be used for the proxy.
TransferredDataLimitThe maximum number of incoming bytes to be stored by the component.
TransferredHeadersThe full set of headers as received from the server.
UseChunkedEncodingEnables or Disables HTTP chunked encoding for transfers.
ChunkSizeSpecifies the chunk size in bytes when using chunked encoding.
UserAgentInformation about the user agent (browser).
KerberosSPNThe Service Principal Name for the Kerberos Domain Controller.
ConnectionTimeoutSets a separate timeout value for establishing a connection.
FirewallAutoDetectTells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallHostName or IP address of firewall (optional).
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall.
FirewallPortThe TCP port for the FirewallHost;.
FirewallTypeDetermines the type of firewall to connect through.
FirewallUserA user name if authentication is to be used connecting through a firewall.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
LingerWhen set to True, connections are terminated gracefully.
LingerTimeTime in seconds to have the connection linger.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe TCP port in the local host where the component binds.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
MaxTransferRateThe transfer rate limit in bytes per second.
RecordLengthThe length of received data records.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
UseIPv6Whether to use IPv6.
TcpNoDelayWhether or not to delay when sending packets.
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLProviderThe name of the security provider to use.
SSLSecurityFlagsFlags that control certificate verification.
OpenSSLCADirThe path to a directory containing CA certificates.
OpenSSLCAFileName of the file containing the list of CA's trusted by your application.
OpenSSLCipherListA string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedDataThe data to seed the pseudo random number generator (PRNG).
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
CodePageThe system code page used for Unicode to Multibyte translations.

 
 
Copyright (c) 2017 /n software inc. - All rights reserved.
Build 1.0.6240.0