|
Cancels the checkout of the file identified by the file
path. If the file is not already checked out, this operation returns
a
false
and does nothing. Otherwise, this operation
cancels the check-out and returns
true
.
For information about the General and Route Evaluation property
groups, see
Common operation properties
.
Login Settings properties
Login settings for invoking the Connector for Microsoft SharePoint
service.
Login Mode
A
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 AEM forms 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 properties properties
Properties to specify the SharePoint site and document library.
Site URL
A
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 Name
A
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 Location Information properties
Properties to specify the file on which the check out operation
is to be canceled.
Select File
A
string
value that specifies
the relative URL of the file on which the check-out is to be canceled.
Do not append a forward slash to the path. If you provide a literal
value, type the path or click Select File to view all existing files
at the selected document library. If the file does not exist, an
exception is thrown.
Result properties
A
boolean
value that indicates
whether canceling the check out operation is successful. A
true
indicates
success; a
false
if the check out failed.
|
|
|
