|
Checks out the file specified by the file path from the
SharePoint server. If the file is already checked out by the same
user, this method returns false; otherwise it checks
out the file and returns true.
For information about the General and Route Evaluation property
groups, see Common operation properties.
Login Settings propertiesLogin settings for invoking the Connector for Microsoft SharePoint
service.
Login ModeA com.adobe.livecycle.crc.sharepoint.client.types.LoginSettings value
that represents how the operation will be authenticated with SharePoint.
Valid values are INVOCATION_CONTEXT (Use Credentials
from process context) and USER_CREDENTIALS (Use
User Credentials).
If you provide a literal value, select
one of the following options:
- Use Credentials
from process context:
- Uses the LiveCycle User Management credential from the process
context for SharePoint authentication.
- Use User Credentials:
- Uses the specified User Name and Password properties to authenticate
with the SharePoint server.
Hostname(Optional)
A string value that specifies
the hostname of the machine which hosts Microsoft SharePoint. You
can also use the Hostname field to connect with any web application
running on a port number other that 80 by specifying the hostname
and port number in the format [hostname]:[port number].
This
field is only used when Login Mode is set to 'Use User Credentials'.
No default is provided.
User Name(Optional) A string value that specifies
the user name to be used to connect with the SharePoint server.
If the user account is of Windows local users or users configured
using Forms Authentication on the SharePoint site, only the user name
is required. However, domain users for Windows Authentication enabled sites
must provide both the domain name and login name in the format domainName\LoginName.
This
field is only used when the Login Mode is set to 'Use User Credentials'.
No default is provided.
Password(Optional)
A string value that specifies
the password to be used to connect with the SharePoint server. This
field is only used when Login Mode is set to 'Use User Credentials'.
No default is provided.
Domain(Optional)
A string value that specifies
the domain in which the SharePoint server is present. This field
is only used when Login Mode is set to 'Use User Credentials'.
Site and Document Library Information propertiesProperties to specify the SharePoint site and document library.
Site URLA string value that specifies
the URL of the SharePoint site. Do not append a forward slash to
the path. If you provide a literal value, type the URL of the SharePoint
site or click Sites to browse existing SharePoint sites on the host
machine. No default is provided.
Document Library NameA string value that specifies
the document library. If you provide a literal value, type the path
or click Document Library to select the document library from the Microsoft
SharePoint repository. Do not include the repository name in the
folder path.
File Information propertiesProperties to specify the file to be checked out.
Select File to Check OutA string value that specifies
the relative URL of the file to be checked out. Do not append a
forward slash to the path. If you provide a literal value, type
the path or click Select File to view existing files and folders
at the selected document library.
If the file does not exist,
an exception is thrown.
Result propertiesA boolean value that indicates
whether the check out operation was successful. A true indicates
that the file was checked out successfully; a false if
check out failed.
|
|
|
