com.groupdocs.sdk.api

Class DocApi

java.lang.Object

com.groupdocs.sdk.api.DocApi

public class DocApi
extends Object

Constructor Summary

Constructors

Constructor and Description
DocApi()

Method Summary

Methods

Modifier and Type	Method and Description
String	getBasePath()
DocumentAccessInfoResponse	GetDocumentAccessInfo(String userId, String fileId)
GetDocumentContentResponse	GetDocumentContent(String userId, String fileId, String contentType)
GetDocumentForeignTypesResponse	GetDocumentFormats(String userId, String fileId)
GetHyperlinksResponse	GetDocumentHyperlinks(String userId, String fileId)
GetDocumentInfoResponse	GetDocumentMetadata(String userId, String fileId)
GetDocumentInfoResponse	GetDocumentMetadataByPath(String userId, String path)
FileStream	GetDocumentPageHtml(String userId, String fileId, Integer pageNumber, Boolean expiresOn)
FileStream	GetDocumentPageHtmlFixed(String userId, String fileId, Integer pageNumber, Boolean expiresOn)
FileStream	GetDocumentPageImage(String userId, String fileId, Integer pageNumber, String dimension, Integer quality, Boolean usePdf, Boolean expiresOn)
GetImageUrlsResponse	GetDocumentPagesHtmlUrls(String userId, String fileId, Integer firstPage, Integer pageCount)
GetImageUrlsResponse	GetDocumentPagesImageUrls(String userId, String fileId, Integer firstPage, Integer pageCount, String dimension, Integer quality, Boolean usePdf, String token)
GetTagsResponse	GetDocumentTags(String userId, String fileId)
DocumentViewsResponse	GetDocumentViews(String userId, String startIndex, String pageSize)
GetEditLockResponse	GetEditLock(String userId, String fileId)
SharedUsersResponse	GetFolderSharers(String userId, String folderId)
ApiInvoker	getInvoker()
SharedDocumentsResponse	GetSharedDocuments(String userId, String sharesTypes, String pageIndex, String pageSize, String orderBy, Boolean orderAsc)
TemplateFieldsResponse	GetTemplateFields(String userId, String fileId, Boolean includeGeometry)
RemoveTagsResponse	RemoveDocumentTags(String userId, String fileId)
RemoveEditLockResponse	RemoveEditLock(String userId, String fileId, String lockId)
void	setBasePath(String basePath)
DocumentAccessInfoResponse	SetDocumentAccessMode(String userId, String fileId, String mode)
SetDocumentPasswordResponse	SetDocumentPassword(String userId, String fileId, String body)
SetTagsResponse	SetDocumentTags(String userId, String fileId)
DocumentUserStatusResponse	SetDocumentUserStatus(String userId, String fileId, String status)
SharedUsersResponse	ShareDocument(String userId, String fileId, List<String> body)
SharedUsersResponse	ShareFolder(String userId, String folderId, List<String> body)
SharedUsersResponse	UnshareDocument(String userId, String fileId)
SharedUsersResponse	UnshareFolder(String userId, String folderId)
ViewDocumentResponse	ViewDocument(String userId, String fileId, String pageNumber, String pageCount, String width, String quality, String usePdf, String passwordSalt)
ViewDocumentResponse	ViewDocumentAsHtml(String userId, String fileId, String pageNumber, String pageCount, String passwordSalt)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DocApi

public DocApi()

Method Detail

getInvoker

public ApiInvoker getInvoker()

setBasePath

public void setBasePath(String basePath)

getBasePath

public String getBasePath()

ViewDocument

public ViewDocumentResponse ViewDocument(String userId,
                                String fileId,
                                String pageNumber,
                                String pageCount,
                                String width,
                                String quality,
                                String usePdf,
                                String passwordSalt)
                                  throws ApiException

Throws:

ApiException

ViewDocumentAsHtml

public ViewDocumentResponse ViewDocumentAsHtml(String userId,
                                      String fileId,
                                      String pageNumber,
                                      String pageCount,
                                      String passwordSalt)
                                        throws ApiException

Throws:

ApiException

GetDocumentViews

public DocumentViewsResponse GetDocumentViews(String userId,
                                     String startIndex,
                                     String pageSize)
                                       throws ApiException

Throws:

ApiException

ShareDocument

public SharedUsersResponse ShareDocument(String userId,
                                String fileId,
                                List<String> body)
                                  throws ApiException

Throws:

ApiException

SetDocumentPassword

public SetDocumentPasswordResponse SetDocumentPassword(String userId,
                                              String fileId,
                                              String body)
                                                throws ApiException

Throws:

ApiException

UnshareDocument

public SharedUsersResponse UnshareDocument(String userId,
                                  String fileId)
                                    throws ApiException

Throws:

ApiException

GetFolderSharers

public SharedUsersResponse GetFolderSharers(String userId,
                                   String folderId)
                                     throws ApiException

Throws:

ApiException

ShareFolder

public SharedUsersResponse ShareFolder(String userId,
                              String folderId,
                              List<String> body)
                                throws ApiException

Throws:

ApiException

UnshareFolder

public SharedUsersResponse UnshareFolder(String userId,
                                String folderId)
                                  throws ApiException

Throws:

ApiException

SetDocumentAccessMode

public DocumentAccessInfoResponse SetDocumentAccessMode(String userId,
                                               String fileId,
                                               String mode)
                                                 throws ApiException

Throws:

ApiException

GetDocumentAccessInfo

public DocumentAccessInfoResponse GetDocumentAccessInfo(String userId,
                                               String fileId)
                                                 throws ApiException

Throws:

ApiException

GetDocumentMetadata

public GetDocumentInfoResponse GetDocumentMetadata(String userId,
                                          String fileId)
                                            throws ApiException

Throws:

ApiException

GetDocumentMetadataByPath

public GetDocumentInfoResponse GetDocumentMetadataByPath(String userId,
                                                String path)
                                                  throws ApiException

Throws:

ApiException

SetDocumentUserStatus

public DocumentUserStatusResponse SetDocumentUserStatus(String userId,
                                               String fileId,
                                               String status)
                                                 throws ApiException

Throws:

ApiException

GetSharedDocuments

public SharedDocumentsResponse GetSharedDocuments(String userId,
                                         String sharesTypes,
                                         String pageIndex,
                                         String pageSize,
                                         String orderBy,
                                         Boolean orderAsc)
                                           throws ApiException

Throws:

ApiException

GetTemplateFields

public TemplateFieldsResponse GetTemplateFields(String userId,
                                       String fileId,
                                       Boolean includeGeometry)
                                         throws ApiException

Throws:

ApiException

GetDocumentFormats

public GetDocumentForeignTypesResponse GetDocumentFormats(String userId,
                                                 String fileId)
                                                   throws ApiException

Throws:

ApiException

GetDocumentPageImage

public FileStream GetDocumentPageImage(String userId,
                              String fileId,
                              Integer pageNumber,
                              String dimension,
                              Integer quality,
                              Boolean usePdf,
                              Boolean expiresOn)
                                throws ApiException

Throws:

ApiException

GetDocumentPageHtmlFixed

public FileStream GetDocumentPageHtmlFixed(String userId,
                                  String fileId,
                                  Integer pageNumber,
                                  Boolean expiresOn)
                                    throws ApiException

Throws:

ApiException

GetDocumentPageHtml

public FileStream GetDocumentPageHtml(String userId,
                             String fileId,
                             Integer pageNumber,
                             Boolean expiresOn)
                               throws ApiException

Throws:

ApiException

GetDocumentPagesImageUrls

public GetImageUrlsResponse GetDocumentPagesImageUrls(String userId,
                                             String fileId,
                                             Integer firstPage,
                                             Integer pageCount,
                                             String dimension,
                                             Integer quality,
                                             Boolean usePdf,
                                             String token)
                                               throws ApiException

Throws:

ApiException

GetDocumentPagesHtmlUrls

public GetImageUrlsResponse GetDocumentPagesHtmlUrls(String userId,
                                            String fileId,
                                            Integer firstPage,
                                            Integer pageCount)
                                              throws ApiException

Throws:

ApiException

GetEditLock

public GetEditLockResponse GetEditLock(String userId,
                              String fileId)
                                throws ApiException

Throws:

ApiException

RemoveEditLock

public RemoveEditLockResponse RemoveEditLock(String userId,
                                    String fileId,
                                    String lockId)
                                      throws ApiException

Throws:

ApiException

GetDocumentTags

public GetTagsResponse GetDocumentTags(String userId,
                              String fileId)
                                throws ApiException

Throws:

ApiException

SetDocumentTags

public SetTagsResponse SetDocumentTags(String userId,
                              String fileId)
                                throws ApiException

Throws:

ApiException

RemoveDocumentTags

public RemoveTagsResponse RemoveDocumentTags(String userId,
                                    String fileId)
                                      throws ApiException

Throws:

ApiException

GetDocumentContent

public GetDocumentContentResponse GetDocumentContent(String userId,
                                            String fileId,
                                            String contentType)
                                              throws ApiException

Throws:

ApiException

GetDocumentHyperlinks

public GetHyperlinksResponse GetDocumentHyperlinks(String userId,
                                          String fileId)
                                            throws ApiException

Throws:

ApiException