Package | Description |
---|---|
com.openkm.sdk4j.definition | |
com.openkm.sdk4j.impl |
Modifier and Type | Method and Description |
---|---|
void |
BaseAuth.assignRole(String userId,
String roleId)
Method to assign a role
|
StampImageSize |
BaseStamp.calculateFlyImageDimensions(String uuid,
long imgToStampWidth,
long imgToStampHeight,
long floatingImageWidth,
long floatingImageHeight,
int pageNumber)
Calculate fly image dimensions stamp image size.
|
StampCoordinates |
BaseStamp.calculateStampCoordinates(long imgToStampWidth,
long imgToStampHeight,
long floatingDivWidth,
long floatingDivHeight,
String exprX,
String exprY,
String stampType,
String stampAlign)
Calculate stamp coordinates stamp coordinates.
|
StampExpressions |
BaseStamp.calculateStampExpressions(long imgToStampWidth,
long imgToStampHeight,
long posX,
long posY)
Calculate stamp expressions stamp expressions.
|
void |
BaseAuth.createRole(String roleId,
boolean active)
Method to create a new role
|
void |
BaseAuth.createUser(String userId,
String password,
String email,
String name,
boolean active)
Method to create a new user
|
void |
BaseBookmark.deleteBookmark(int bookmarkId)
Remove a bookmark.
|
void |
BaseAuth.deleteRole(String roleId)
Method to create a delete a role
|
void |
BaseAuth.deleteUser(String userId)
Method to delete a user
|
String |
BaseAuth.disable2FA()
Disable 2FA
|
boolean |
BasePdf.extract(String uuid,
String dstId,
String name,
List<Integer> pages)
Extract boolean.
|
void |
BaseDocument.forceCancelCheckout(String uuid)
Force to cancel a previous checked out state in a document.
|
String |
BaseAuth.generate2FASecret()
Generate 2FA secret
|
List<StampItem> |
BaseStamp.getAllStamps()
Gets all stamps.
|
int |
BaseDocument.getNumberOfPages(String uuid)
Get the number of pages of a document.
|
String |
BaseDocument.getPageAsImage(String uuid,
int pageNumber,
int maxWidth,
int maxHeight)
Get page as image.
|
StampPersonalImage |
BaseStamp.getPersonalStampImage(String uuid,
String imageUuid,
long id)
Gets personal stamp image.
|
List<Document> |
BaseStamp.getPersonalStamps()
Gets personal stamps.
|
List<Profile> |
BaseAuth.getProfiles(boolean filterByActive)
Get all profiles
|
List<String> |
BaseAuth.getRoles(boolean showAll)
Retrieves a list of repository roles.
|
List<String> |
BaseAuth.getRolesByUser(String userId)
Retrieves a list of roles by user.
|
StampBarcode |
BaseStamp.getStampBarcodeByPk(long id,
String uuid)
Gets stamp barcode by pk.
|
StampImage |
BaseStamp.getStampImageByPk(long id,
String uuid)
Gets stamp image by pk.
|
StampText |
BaseStamp.getStampTextByPk(long id,
String uuid)
Gets stamp text by pk.
|
InputStream |
BaseAuth.getTwoFactorQR(String secret)
Get 2FA
|
CommonUser |
BaseAuth.getUser(String userId)
Retrieve information of a given user
|
List<Bookmark> |
BaseBookmark.getUserBookmarks()
Retrive an user bookmark collection.
|
Profile |
BaseAuth.getUserProfile(String userId)
Get user profile
|
List<CommonUser> |
BaseAuth.getUsers(boolean showAll)
Retrieve information of a given user
|
List<CommonUser> |
BaseAuth.getUsersByRole(String roleId)
Retrieves a list of users by role.
|
boolean |
BaseAuth.isAdmin()
Is admin
|
void |
BaseDocument.mergePdf(String destinationUuid,
String docName,
List<String> uuids)
Merge two or more PDF files.
|
boolean |
BasePdf.remove(String uuid,
String dstId,
String name,
List<Integer> pages)
Remove boolean.
|
void |
BaseAuth.removeRole(String userId,
String roleId)
Method to remove a role
|
void |
BaseBookmark.renameBookmark(int bookmarkId,
String name)
Rename a previous stored bookmark.
|
boolean |
BasePdf.rotate(String uuid,
String dstId,
String name,
Integer angle,
List<Integer> pages)
Rotate boolean.
|
Document |
BaseDocument.saveDocumentAsPdf(String uuid,
String newName)
Save the document as PDF in the OpenKM repository.
|
Document |
BaseMail.saveMailAsPdf(String uuid,
String newName)
Save mail as pdf document.
|
void |
BaseAuth.setUserProfile(String userId,
long profileId)
Set the user profile
|
boolean |
BasePdf.split(String uuid,
String dstId,
String baseName,
List<Integer> pages)
Split boolean.
|
void |
BaseStamp.stampBarcode(String uuid,
long id)
Stamp barcode.
|
void |
BaseStamp.stampImage(String uuid,
long id)
Stamp image.
|
void |
BaseStamp.stampImageCustom(String uuid,
long stampImageId,
String exprX,
String exprY,
String range,
double ratio,
InputStream is)
Stamp image custom.
|
void |
BaseStamp.stampImageManually(String uuid,
long id,
String exprX,
String exprY,
String range,
String personalStampUuid)
Stamp image manually.
|
void |
BaseStamp.stampText(String uuid,
long id)
Stamp text.
|
void |
BaseAuth.updateRole(String roleId,
boolean active)
Update role information
|
void |
BaseAuth.updateUser(String userId,
String password,
String email,
String name,
boolean active)
Update user information
|
String |
BaseAuth.validate2FAAndSaveSecret(String secret,
int code)
Validate 2FA and save secret
|
String |
BaseAuth.verify2FACode(int code)
Verify 2FA code
|
Modifier and Type | Method and Description |
---|---|
void |
AuthImpl.assignRole(String userId,
String roleId) |
void |
OKMWebservices.assignRole(String userId,
String roleId)
Deprecated.
As of sdk4j 3.8, replaced by
AuthImpl.assignRole(String, String) |
StampImageSize |
StampImpl.calculateFlyImageDimensions(String uuid,
long imgToStampWidth,
long imgToStampHeight,
long floatingImageWidth,
long floatingImageHeight,
int pageNumber) |
StampImageSize |
OKMWebservices.calculateFlyImageDimensions(String uuid,
long imgToStampWidth,
long imgToStampHeight,
long floatingImageWidth,
long floatingImageHeight,
int pageNumber)
Deprecated.
As of sdk4j 3.8, replaced by
StampImpl.calculateFlyImageDimensions(String, long, long, long, long, int) |
StampCoordinates |
StampImpl.calculateStampCoordinates(long imgToStampWidth,
long imgToStampHeight,
long floatingDivWidth,
long floatingDivHeight,
String exprX,
String exprY,
String stampType,
String stampAlign) |
StampCoordinates |
OKMWebservices.calculateStampCoordinates(long imgToStampWidth,
long imgToStampHeight,
long floatingDivWidth,
long floatingDivHeight,
String exprX,
String exprY,
String stampType,
String stampAlign)
Deprecated.
As of sdk4j 3.8, replaced by
StampImpl.calculateStampCoordinates(long, long,
long, long, String, String, String, String) |
StampExpressions |
StampImpl.calculateStampExpressions(long imgToStampWidth,
long imgToStampHeight,
long posX,
long posY) |
StampExpressions |
OKMWebservices.calculateStampExpressions(long imgToStampWidth,
long imgToStampHeight,
long posX,
long posY)
Deprecated.
As of sdk4j 3.8, replaced by
StampImpl.calculateStampExpressions(long, long, long, long) |
void |
AuthImpl.createRole(String roleId,
boolean active) |
void |
OKMWebservices.createRole(String roleId,
boolean active)
Deprecated.
As of sdk4j 3.8, replaced by
AuthImpl.createRole(String, boolean) |
void |
AuthImpl.createUser(String userId,
String password,
String email,
String name,
boolean active) |
void |
OKMWebservices.createUser(String userId,
String password,
String email,
String name,
boolean active)
Deprecated.
As of sdk4j 3.8, replaced by
AuthImpl.createUser(String, String, String, String, boolean) |
void |
BookmarkImpl.deleteBookmark(int bookmarkId) |
void |
OKMWebservices.deleteBookmark(int bookmarkId)
Deprecated.
As of sdk4j 3.8, replaced by
BookmarkImpl.deleteBookmark(int) |
void |
AuthImpl.deleteRole(String roleId) |
void |
OKMWebservices.deleteRole(String roleId)
Deprecated.
As of sdk4j 3.8, replaced by
AuthImpl.deleteRole(String) |
void |
AuthImpl.deleteUser(String userId) |
void |
OKMWebservices.deleteUser(String userId)
Deprecated.
As of sdk4j 3.8, replaced by
AuthImpl.deleteUser(String) |
String |
AuthImpl.disable2FA() |
String |
OKMWebservices.disable2FA()
Deprecated.
As of sdk4j 3.15, replaced by
AuthImpl.disable2FA() |
boolean |
PdfImpl.extract(String uuid,
String dstId,
String name,
List<Integer> pages) |
void |
DocumentImpl.forceCancelCheckout(String uuid) |
void |
OKMWebservices.forceCancelCheckout(String uuid)
Deprecated.
As of sdk4j 3.8, replaced by
DocumentImpl.forceCancelCheckout(String) |
String |
AuthImpl.generate2FASecret() |
String |
OKMWebservices.generate2FASecret()
Deprecated.
As of sdk4j 3.15, replaced by
AuthImpl.generate2FASecret() |
List<StampItem> |
StampImpl.getAllStamps() |
List<StampItem> |
OKMWebservices.getAllStamps()
Deprecated.
As of sdk4j 3.8, replaced by
StampImpl.getAllStamps() |
int |
DocumentImpl.getNumberOfPages(String uuid) |
int |
OKMWebservices.getNumberOfPages(String uuid)
Deprecated.
As of sdk4j 3.8, replaced by
DocumentImpl.getNumberOfPages(String) |
String |
DocumentImpl.getPageAsImage(String uuid,
int pageNumber,
int maxWidth,
int maxHeight) |
String |
OKMWebservices.getPageAsImage(String uuid,
int pageNumber,
int maxWidth,
int maxHeight)
Deprecated.
As of sdk4j 3.8, replaced by
DocumentImpl.getPageAsImage(String, int, int, int) |
StampPersonalImage |
StampImpl.getPersonalStampImage(String uuid,
String imgUuid,
long id) |
StampPersonalImage |
OKMWebservices.getPersonalStampImage(String uuid,
String imgUuid,
long id)
Deprecated.
As of sdk4j 3.8, replaced by
StampImpl.getPersonalStampImage(String, String, long) |
List<Document> |
StampImpl.getPersonalStamps() |
List<Document> |
OKMWebservices.getPersonalStamps()
Deprecated.
As of sdk4j 3.8, replaced by
StampImpl.getPersonalStamps() |
List<Profile> |
AuthImpl.getProfiles(boolean filterByActive) |
List<Profile> |
OKMWebservices.getProfiles(boolean filterByActive)
Deprecated.
As of sdk4j 3.8, replaced by
AuthImpl.getProfiles(boolean) |
List<String> |
AuthImpl.getRoles(boolean showAll) |
List<String> |
OKMWebservices.getRoles(boolean showAll)
Deprecated.
As of sdk4j 3.8, replaced by
AuthImpl.getRoles(boolean) |
List<String> |
AuthImpl.getRolesByUser(String userId) |
List<String> |
OKMWebservices.getRolesByUser(String userId)
Deprecated.
As of sdk4j 3.8, replaced by
AuthImpl.getRolesByUser(String) |
StampBarcode |
StampImpl.getStampBarcodeByPk(long id,
String uuid) |
StampBarcode |
OKMWebservices.getStampBarcodeByPk(long id,
String uuid)
Deprecated.
As of sdk4j 3.17, replaced by
StampImpl.getStampBarcodeByPk(long, String) |
StampImage |
StampImpl.getStampImageByPk(long id,
String uuid) |
StampImage |
OKMWebservices.getStampImageByPk(long id,
String uuid)
Deprecated.
As of sdk4j 3.8, replaced by
StampImpl.getStampImageByPk(long, String) |
StampText |
StampImpl.getStampTextByPk(long id,
String uuid) |
StampText |
OKMWebservices.getStampTextByPk(long id,
String uuid)
Deprecated.
As of sdk4j 3.8, replaced by
StampImpl.getStampTextByPk(long, String) |
InputStream |
AuthImpl.getTwoFactorQR(String secret) |
InputStream |
OKMWebservices.getTwoFactorQR(String secret)
Deprecated.
As of sdk4j 3.15, replaced by
AuthImpl.getTwoFactorQR(String) |
CommonUser |
AuthImpl.getUser(String userId) |
CommonUser |
OKMWebservices.getUser(String userId)
Deprecated.
As of sdk4j 3.8, replaced by
AuthImpl.getUser(String) |
List<Bookmark> |
BookmarkImpl.getUserBookmarks() |
List<Bookmark> |
OKMWebservices.getUserBookmarks()
Deprecated.
As of sdk4j 3.8, replaced by
BookmarkImpl.getUserBookmarks() |
Profile |
AuthImpl.getUserProfile(String userId) |
Profile |
OKMWebservices.getUserProfile(String userId)
Deprecated.
As of sdk4j 3.8, replaced by
AuthImpl.getUserProfile(String) |
List<CommonUser> |
AuthImpl.getUsers(boolean showAll) |
List<CommonUser> |
OKMWebservices.getUsers(boolean showAll)
Deprecated.
As of sdk4j 3.8, replaced by
AuthImpl.getUsers(boolean) |
List<CommonUser> |
AuthImpl.getUsersByRole(String roleId) |
List<CommonUser> |
OKMWebservices.getUsersByRole(String roleId)
Deprecated.
As of sdk4j 3.8, replaced by
AuthImpl.getUsersByRole(String) |
boolean |
AuthImpl.isAdmin() |
boolean |
OKMWebservices.isAdmin()
Deprecated.
As of sdk4j 3.8, replaced by
AuthImpl.isAdmin() |
void |
DocumentImpl.mergePdf(String destinationUuid,
String docName,
List<String> uuids) |
void |
OKMWebservices.mergePdf(String destinationUuid,
String docName,
List<String> uuids)
Deprecated.
As of sdk4j 3.8, replaced by
DocumentImpl.mergePdf(String, String, List) |
boolean |
PdfImpl.remove(String uuid,
String dstId,
String name,
List<Integer> pages) |
void |
AuthImpl.removeRole(String userId,
String roleId) |
void |
OKMWebservices.removeRole(String userId,
String roleId)
Deprecated.
As of sdk4j 3.8, replaced by
AuthImpl.removeRole(String, String) |
void |
BookmarkImpl.renameBookmark(int bookmarkId,
String name) |
void |
OKMWebservices.renameBookmark(int bookmarkId,
String name)
Deprecated.
As of sdk4j 3.8, replaced by
BookmarkImpl.renameBookmark(int, String) |
boolean |
PdfImpl.rotate(String uuid,
String dstId,
String name,
Integer angle,
List<Integer> pages) |
Document |
DocumentImpl.saveDocumentAsPdf(String uuid,
String newName) |
Document |
OKMWebservices.saveDocumentAsPdf(String uuid,
String newName)
Deprecated.
As of sdk4j 3.8, replaced by
DocumentImpl.saveDocumentAsPdf(String, String) |
Document |
MailImpl.saveMailAsPdf(String uuid,
String newName) |
Document |
OKMWebservices.saveMailAsPdf(String uuid,
String newName)
Deprecated.
As of sdk4j 3.8, replaced by
MailImpl.saveMailAsPdf(String, String) |
void |
AuthImpl.setUserProfile(String userId,
long profileId) |
void |
OKMWebservices.setUserProfile(String userId,
long profileId)
Deprecated.
As of sdk4j 3.8, replaced by
AuthImpl.setUserProfile(String, long) |
boolean |
PdfImpl.split(String uuid,
String dstId,
String baseName,
List<Integer> pages) |
void |
StampImpl.stampBarcode(String uuid,
long id) |
void |
OKMWebservices.stampBarcode(String uuid,
long id)
Deprecated.
As of sdk4j 3.17, replaced by
StampImpl.stampBarcode(String, long) |
void |
StampImpl.stampImage(String uuid,
long id) |
void |
OKMWebservices.stampImage(String uuid,
long id)
Deprecated.
As of sdk4j 3.8, replaced by
StampImpl.stampImage(String, long) |
void |
StampImpl.stampImageCustom(String uuid,
long id,
String exprX,
String exprY,
String range,
double ratio,
InputStream is) |
void |
OKMWebservices.stampImageCustom(String uuid,
long id,
String exprX,
String exprY,
String range,
double ratio,
InputStream is)
Deprecated.
As of sdk4j 3.8, replaced by
StampImpl.stampImageCustom(String, long, String, String, String, double, InputStream) |
void |
StampImpl.stampImageManually(String uuid,
long id,
String exprX,
String exprY,
String range,
String personalStampUuid) |
void |
OKMWebservices.stampImageManually(String uuid,
long id,
String exprX,
String exprY,
String range,
String personalStampUuid)
Deprecated.
As of sdk4j 3.8, replaced by
StampImpl.stampImageManually(String, long, String, String, String, String) |
void |
StampImpl.stampText(String uuid,
long id) |
void |
OKMWebservices.stampText(String uuid,
long id)
Deprecated.
As of sdk4j 3.8, replaced by
StampImpl.stampText(String, long) |
void |
AuthImpl.updateRole(String roleId,
boolean active) |
void |
OKMWebservices.updateRole(String roleId,
boolean active)
Deprecated.
As of sdk4j 3.8, replaced by
AuthImpl.updateRole(String, boolean) |
void |
AuthImpl.updateUser(String userId,
String password,
String email,
String name,
boolean active) |
void |
OKMWebservices.updateUser(String userId,
String password,
String email,
String name,
boolean active)
Deprecated.
As of sdk4j 3.8, replaced by
AuthImpl.updateUser(String, String, String, String, boolean) |
String |
AuthImpl.validate2FAAndSaveSecret(String secret,
int code) |
String |
OKMWebservices.validate2FAAndSaveSecret(String secret,
int code)
Deprecated.
As of sdk4j 3.15, replaced by
AuthImpl.validate2FAAndSaveSecret(String, int) |
String |
AuthImpl.verify2FACode(int code) |
String |
OKMWebservices.verify2FACode(int code)
Deprecated.
As of sdk4j 3.15, replaced by
AuthImpl.verify2FACode(int) |
Copyright © 2021 Open Knowledge Management System S.L.. All Rights Reserved.