public interface NuxeoRemoting extends BaseNuxeoWebService
Modifier and Type | Method and Description |
---|---|
DocumentDescriptor[] |
getChildren(String sessionId,
String uuid)
Gets the children of the given document.
|
DocumentDescriptor |
getCurrentVersion(String sid,
String uid)
Gets the current version of the given document.
|
DocumentDescriptor |
getDocument(String sessionId,
String uuid)
Gets the doc descriptor given the doc UUID.
|
WsACE[] |
getDocumentACL(String sid,
String uuid)
Returns the merged ACL of the document (contains all ACEs defined on the document and its parents).
|
DocumentBlob[] |
getDocumentBlobs(String sid,
String uuid)
Returns the document blobs only using byte[] format
|
DocumentBlob[] |
getDocumentBlobsExt(String sid,
String uuid,
boolean useDownloadUrl)
Returns the document blobs only.
|
WsACE[] |
getDocumentLocalACL(String sid,
String uuid)
Returns the merged ACL of the document (contains all ACEs defined on the document, filtering the inherited ones).
|
DocumentProperty[] |
getDocumentNoBlobProperties(String sid,
String uuid)
Same as
getDocumentProperties(String, String) but skips blobs. |
DocumentProperty[] |
getDocumentProperties(String sid,
String uuid)
Returns the document properties.
|
DocumentSnapshot |
getDocumentSnapshot(String sid,
String uuid)
Gets all properties and ACLs from a document uses byte[] format to export blob
|
DocumentSnapshot |
getDocumentSnapshotExt(String sid,
String uuid,
boolean useDownloadUrl)
Gets all properties and ACLs from a document
|
String[] |
getGroups(String sid,
String parentGroup)
Gets all sub-groups inside the given group.
|
String |
getRelativePathAsString(String sessionId,
String uuid)
Returns the relative path as a displayable path with parent titles.
|
String |
getRepositoryName(String sid)
Gets the current repository name.
|
DocumentDescriptor |
getRootDocument(String sessionId)
Gets the root document descriptor.
|
DocumentDescriptor |
getSourceDocument(String sid,
String uid)
Gets the document that created the version specified by the given uid.
|
String[] |
getUsers(String sid,
String parentGroup)
Get all users inside the given group.
|
DocumentDescriptor[] |
getVersions(String sid,
String uid)
Gets the versions of the given document.
|
boolean |
hasPermission(String sid,
String uuid,
String permission)
Checks the given permission for the current user on the given document.
|
String[] |
listGroups(String sid,
int from,
int to)
Return the list of all groups.
|
String[] |
listUsers(String sid,
int from,
int to)
Returns the list of all users.
|
String |
uploadDocument(String sid,
String path,
String type,
String[] properties) |
connect, disconnect
String getRepositoryName(String sid)
sid
- the session idDocumentDescriptor getRootDocument(String sessionId)
DocumentDescriptor getDocument(String sessionId, String uuid)
sessionId
- the session iduuid
- the doc uuidDocumentDescriptor[] getChildren(String sessionId, String uuid)
sessionId
- the session iduuid
- the doc uuidString getRelativePathAsString(String sessionId, String uuid)
Example: /Workspaces/My Workspaces/Nice Document
sessionId
- : the session iduuid
- : the document uuidDocumentDescriptor[] getVersions(String sid, String uid)
sid
- uid
- DocumentDescriptor getCurrentVersion(String sid, String uid)
sid
- DocumentDescriptor getSourceDocument(String sid, String uid)
sid
- uid
- DocumentProperty[] getDocumentProperties(String sid, String uuid)
All property are returned even blobs. All values are converted to strings.
It includes the perm link of the document.
No need to includes blobs here. See the dedicated API.
uuid
- uuid of the document.DocumentProperty[] getDocumentNoBlobProperties(String sid, String uuid)
getDocumentProperties(String, String)
but skips blobs.sid
- uuid
- DocumentBlob[] getDocumentBlobs(String sid, String uuid)
uuid
- the uuid of the document.DocumentBlob[] getDocumentBlobsExt(String sid, String uuid, boolean useDownloadUrl)
uuid
- the uuid of the document.useDownloadUrl
- defines if blob are exported as download url or as byte|[]WsACE[] getDocumentACL(String sid, String uuid)
It includes all ACLs for each ACP.
uuid
- the uuid of the documentWsACE[] getDocumentLocalACL(String sid, String uuid)
It includes all ACLs for each ACP.
uuid
- the uuid of the documentboolean hasPermission(String sid, String uuid, String permission)
sid
- uuid
- permission
- String[] listUsers(String sid, int from, int to)
This method supports pagination in case of large user dbs.
Pagination is not yet working!
from
- pagination startto
- pagination stopString[] listGroups(String sid, int from, int to)
This method supports pagination in case of large user dbs
Pagination is not yet working!
from
- pagination startto
- pagination stopString[] getUsers(String sid, String parentGroup)
sid
- the session idparentGroup
- the parent groupString[] getGroups(String sid, String parentGroup)
sid
- the session idparentGroup
- the parent groupDocumentSnapshot getDocumentSnapshot(String sid, String uuid)
sid
- the session iduuid
- the doc uuidDocumentSnapshot getDocumentSnapshotExt(String sid, String uuid, boolean useDownloadUrl)
sid
- the session iduuid
- the doc uuiduseDownloadUrl
- define blob export formatCopyright © 2017 Nuxeo. All rights reserved.