Foxit PDF SDK
|
Classes | |
class | ClientInfo |
Structure that represents the client information which is used to apply for a client ID from ConnectedPDF server. More... | |
Public Types | |
enum | EncryptType { EncryptType.e_EncryptTypeAES = 1, EncryptType.e_EncryptTypeSM4CBC = 2 } |
Enumeration for encryption mode. More... | |
Public Member Functions | |
ConnectedPDF (string clientid, string user_token, string content_key, ConnectedPDF.EncryptType type, string file_path) | |
Constructor, with parameters and from an existing PDF file path. More... | |
ConnectedPDF (string clientid, string user_token, string content_key, ConnectedPDF.EncryptType type, FileReaderCallback file_read) | |
Constructor, with parameters and a foxit.common.fxcrt.FileReaderCallback object. More... | |
ConnectedPDF (string clientid, string user_token, string content_key, ConnectedPDF.EncryptType type, PDFDoc document) | |
Constructor, with parameters and a PDF document object. More... | |
ConnectedPDF (ConnectedPDF connected_pdf) | |
Constructor, with another ConnectedPDF object. More... | |
ErrorCode | ConvertToCDRM (string endpoint, string wrapper_path, string file_name) |
Convert the loaded document to a ConnectedPDF DRM document. More... | |
ErrorCode | ConvertToCDRM (string endpoint, FileReaderCallback wrapper_file_read, string file_name) |
Convert the loaded document to a ConnectedPDF DRM document. More... | |
ErrorCode | ConvertToCPDF (string endpoint, string file_name) |
Convert the loaded document to a ConnectedPDF document. More... | |
string | GetACL () |
Get ACL of a ConnectedPDF DRM document. More... | |
string | GetContentKey () |
Get the content key if the loaded document is a ConnectedPDF DRM document. More... | |
PDFDoc | GetDocument () |
Get the associated PDF document object. More... | |
string | GetDocURI () |
Get the ConnectedPDF document URI from the loaded document. More... | |
string | GetEndpoint () |
Get the ConnectedPDF document endpoint from the loaded document. More... | |
string | GetOwnerEmail () |
Get the ConnectedPDF document owner email. More... | |
string | GetOwnerName () |
Get the ConnectedPDF document owner name. More... | |
string | GetUserToken () |
Get the user token. More... | |
string | GetVersionID () |
Get the ConnectedPDF document version ID from the loaded document. More... | |
bool | IsCDRM () |
Check whether the loaded document is a ConnectedPDF DRM document or not. More... | |
bool | IsCPDF () |
Check whether the loaded document is a ConnectedPDF document or not. More... | |
bool | IsEmpty () |
Check whether current object is empty or not. More... | |
bool | IsOwner () |
Check whether current user is the owner. More... | |
string | RefreshVersionID () |
Refresh the ConnectedPDF document version ID from the loaded document. More... | |
ErrorCode | RemoveCDRM () |
Remove the ConnectedPDF DRM protection of a ConnectedPDF document. More... | |
bool | SaveAs (string file_path) |
Save the current ConnectedPDF document as another PDF file. More... | |
bool | SaveAs (FileWriterCallback file_write) |
Save the current ConnectedPDF document as another PDF file. More... | |
ErrorCode | SetACL (string acl) |
Set ACL of a ConnectedPDF DRM document. More... | |
void | SetUserToken (string user_token) |
Set the user token to switch it. More... | |
Static Public Member Functions | |
static string | GetClientIDFromServer (string endpoint, ConnectedPDF.ClientInfo client_info) |
Apply for a client id from ConnectedPDF server using the input client info. More... | |
static string | GetDocURI (string file_path) |
Get the ConnectedPDF document URI from the PDF path. More... | |
static string | GetUserTokenFromServer (string endpoint, string user_email, byte[] password) |
Get the user token from ConnectedPDF server. More... | |
Class ConnectedPDF offers following functions,
Convert a normal PDF document to a ConnectedPDF document.
Convert a normal PDF document or a ConnectedPDF document to a ConnectedPDF DRM document.
Decrypt and configure the ACL of ConnectedPDF DRM.
|
strong |
|
inline |
Constructor, with parameters and from an existing PDF file path.
A ConnectedPDF object can be constructed to load a normal PDF document, or a ConnectedPDF document, or a ConnectedPDF DRM document. If current document is a normal PDF document, it can be converted to a ConnectedPDF document or a ConnectedPDF DRM document. If current document is a ConnectedPDF document, it can be convert to a ConnectedPDF DRM document.
[in] | clientid | A client ID whcih is created by function ConnectedPDF.GetClientIDFromServer . |
[in] | user_token | A user token is created by function ConnectedPDF.GetUserTokenFromServer . |
[in] | content_key | If the client has cached the content key, just input the cached key to decrypt ConnectedPDF DRM document. Otherwise, set content_key with an empty string, and ConnectedPDF object will apply for the content key from server. |
[in] | type | Encryption algorithm. Please refer to values starting from foxit.addon.ConnectedPDF.EncryptType.e_EncryptTypeAES and this should be one of these values. |
[in] | file_path | A path of an existing PDF file. |
|
inline |
Constructor, with parameters and a foxit.common.fxcrt.FileReaderCallback object.
A ConnectedPDF object can be constructed to load a normal PDF document, or a ConnectedPDF document, or a ConnectedPDF DRM document. If current document is a normal PDF document, it can be converted to a ConnectedPDF document or a ConnectedPDF DRM document. If current document is a ConnectedPDF document, it can be convert to a ConnectedPDF DRM document.
[in] | clientid | A client ID whcih is created by function ConnectedPDF.GetClientIDFromServer . |
[in] | user_token | A user token is created by function ConnectedPDF.GetUserTokenFromServer . |
[in] | content_key | If the client has cached the content key, just input the cached key to decrypt ConnectedPDF DRM document. Otherwise, set content_key with an empty string, and ConnectedPDF object will apply for the content key from server. |
[in] | type | Encryption algorithm. Please refer to values starting from foxit.addon.ConnectedPDF.EncryptType.e_EncryptTypeAES and this should be one of these values. |
[in] | file_read | A foxit.common.fxcrt.FileReaderCallback object which is implemented by user to load a PDF document. It should not be null. |
|
inline |
Constructor, with parameters and a PDF document object.
The constructed ConnectedPDF object can be converted to a ConnectedPDF document or a ConnectedPDF DRM document.
[in] | clientid | A client ID whcih is created by function ConnectedPDF.GetClientIDFromServer . |
[in] | user_token | A user token is created by function ConnectedPDF.GetUserTokenFromServer . |
[in] | content_key | If the client has cached the content key, just input the cached key to decrypt ConnectedPDF DRM document. Otherwise, set content_key as null, and ConnectedPDF object will apply for the content key from server. |
[in] | type | Encryption algorithm. Please refer to values starting from foxit.addon.ConnectedPDF.EncryptType.e_EncryptTypeAES and this should be one of these values. |
[in] | document | A valid PDF document object which represents a normal PDF document. |
|
inline |
Constructor, with another ConnectedPDF object.
[in] | connected_pdf | Another ConnectedPDF object |
|
inline |
Convert the loaded document to a ConnectedPDF DRM document.
When the loaded document is converted to a ConnectedPDF DRM document, please use function ConnectedPDF.SaveAs to save it.
[in] | endpoint | The input ConnectedPDF server host address. For example, https://www-fz02.connectedpdf.com. |
[in] | wrapper_path | A path of an existing PDF file. |
[in] | file_name | The file name used by ConnectedPDF server. If this is an empty string, "Unknown.pdf" will be used as the file name by default |
|
inline |
Convert the loaded document to a ConnectedPDF DRM document.
When the loaded document is converted to a ConnectedPDF DRM document, please use function ConnectedPDF.SaveAs to save it.
[in] | endpoint | The input ConnectedPDF server host address. For example, https://www-fz02.connectedpdf.com. |
[in] | wrapper_file_read | A foxit.common.fxcrt.FileReaderCallback object which is implemented by user to save a PDF document. |
[in] | file_name | The file name used by ConnectedPDF server. If this is an empty string, "Unknown.pdf" will be used as the file name by default |
|
inline |
Convert the loaded document to a ConnectedPDF document.
When the loaded document is converted to a ConnectedPDF document, please use function ConnectedPDF.SaveAs to save it.
[in] | endpoint | The input ConnectedPDF server host address. For example, https://www-fz02.connectedpdf.com. |
[in] | file_name | The file name used by ConnectedPDF server. If this is an empty string, "Unknown.pdf" will be used as the file name by default |
|
inline |
Get ACL of a ConnectedPDF DRM document.
The owner can get all the user's ACL; otherwise, the current user can get its own ACL. If the loaded document is not a ConnectedPDF DRM document, this function will throw exception foxit.common.ErrorCode.e_ErrNotCDRM .
[ { Control the specified pages to be hidden. "accessPages" : { The page indexes to be hidden. For example, [ 1, [2,10],12 ]. "Pages" : [], The content cover over the hidden pages. "wrapperContent" : null, The picture cover over the hidden pages. Cannot support now. Just leave it empty. "wrapperPic" : null }, The PDF standard permission array. The value is hex. The values can be 4,8,10,20,100,200,400,800. Please refer to values starting from for more information. "decodePermission" : [ 8, 10 ], Limit device to open the document. "deviceLimit" : { The devices has opened the document. "appList" : [], No more device can open the document. "isLimit" : 0, The permitted device count to open the document. "limitNum" : 0 }, Whether the ACL is for everyone or not. "everyone" : 0, Whether the user has full control permission. "fullControl" : 0, The grout ID. "groupID" : "", The grout name. "groupName" : "", Whether the ACL is for a group or not. "isGroup" : 0, Whether the ACL has been revoked. "isRevoke" : 0, Whether the user can open the document offline. 0=Never 1=By Days 2=Always. "offline" : 0, The permitted offline days. "offlineDuration" : 0, Whether set the online expiration date. 0=Never 1=By Days 2=By Date. "online" : 0, Expiration date. For example, "2017-01-01 01:59:59". "onlineDuration" : "", Expiration days. "onlineDurationDays" : 0, The PDF standard permission. The value is decimal. It's the combination of the hex values 4,8,10,20,100,200,400,800. Please refer to values starting from for more information. "permission" : 312, The user info. "userAttribute" : { The domain the user belongs to. "Domain" : "", The user ID. "cUserID" : "58197659c2dcf1c7143febce", The user email. "userEmail" : "65908769@qq.com" } } ]
|
inlinestatic |
Apply for a client id from ConnectedPDF server using the input client info.
The client id represents a ConnectedPDF client running on a device. The client ID is used to create a ConnectedPDF object. It is required for converting normal PDF to ConnectedPDF. The client should apply for a client id once, then cache it and reuse it. This function may throw exception foxit.common.ErrorCode.e_ErrCanNotConnectToServer .
[in] | endpoint | The input ConnectedPDF server host address. For example, https://www-fz02.connectedpdf.com. |
[in] | client_info | The input client information used to apply for a client id from ConnectedPDF server. |
|
inline |
Get the content key if the loaded document is a ConnectedPDF DRM document.
|
inline |
Get the associated PDF document object.
The returned PDF document object can be edited. If the loaded document is a ConnectedPDF DRM document, user should save it by function ConnectedPDF.SaveAs ; otherwise, the saved document will be corrupted.
|
inlinestatic |
Get the ConnectedPDF document URI from the PDF path.
Every ConnectedPDF document or ConnectedPDF DRM document has the document URI. It is the unique identification of the ConnectedPDF document or ConnectedPDF DRM document.
[in] | file_path | A path of an existing PDF file. |
|
inline |
Get the ConnectedPDF document URI from the loaded document.
|
inline |
Get the ConnectedPDF document endpoint from the loaded document.
|
inline |
Get the ConnectedPDF document owner email.
|
inline |
Get the ConnectedPDF document owner name.
|
inline |
Get the user token.
|
inlinestatic |
Get the user token from ConnectedPDF server.
A user token should be gotten before accessing ConnectedPDF web service. The client can get the user token once, then cache it and reuse it. This function may throw exception foxit.common.ErrorCode.e_ErrCanNotConnectToServer .
[in] | endpoint | The input ConnectedPDF server host address. For example, https://www-fz02.connectedpdf.com. |
[in] | user_email | The input user email. |
[in] | password | The input user password. |
|
inline |
Get the ConnectedPDF document version ID from the loaded document.
|
inline |
Check whether the loaded document is a ConnectedPDF DRM document or not.
|
inline |
Check whether the loaded document is a ConnectedPDF document or not.
|
inline |
Check whether current object is empty or not.
When the current object is empty, that means current object is useless.
|
inline |
Check whether current user is the owner.
|
inline |
Refresh the ConnectedPDF document version ID from the loaded document.
|
inline |
Remove the ConnectedPDF DRM protection of a ConnectedPDF document.
Only the owner has the permission to remove the ConnectedPDF DRM protection. When the ConnectedPDF DRM protection is removed, function ConnectedPDF.SaveAs can be used to save it.
|
inline |
Save the current ConnectedPDF document as another PDF file.
If the loaded document is a ConnectedPDF DRM document, the document can be saved as only by this funcction; otherwise the saved document will be corrupted.
[in] | file_path | A path for the new saved PDF file. It should not be an empty string. |
|
inline |
Save the current ConnectedPDF document as another PDF file.
If the loaded document is a ConnectedPDF DRM document, the document can be saved as only by this funcction; otherwise the saved document will be corrupted.
[in] | file_write | A foxit.common.fxcrt.FileWriterCallback object which is implemented by user to do the saving. |
|
inline |
Set ACL of a ConnectedPDF DRM document.
Only the owner has the permission to set ACL. This function will revoke all the ACL of the ConnectedPDF DRM document first, and then apply the new ACL.
[in] | acl | The input ACL data. The data is a JSON string. "userList" is an array of all the user's ACL. Every element of "userList" is one user's ACL. The format is described as follows, { "userList": [ { The user email. "userEmail": "fz02_50@qq.com", |
The grout ID. Cannot support now. Just leave it empty. "groupId": "",
Whether the ACL is for a group or not. Cannot support now. Just leave it 0. "isGroup": "0",
Whether the ACL is for everyone or not. "everyone": "0",
Whether the user has full control permission. "fullControl": "0",
The PDF standard permission array. The value is hex. The values can be 4,8,10,20,100,200,400,800. Please refer to values starting from for more information. "permission": [4],
Whether the user can open the document offline. 0=Never 1=By Days 2=Always. "offline": "0",
The permitted offline days. "offlineDays": 0,
Whether set the online expiration date. 0=Never 1=By Days 2=By Date. "online": "0",
Expiration date. For example, "2017-01-01 01:59:59". "onlineDate": "",
Expiration days. "onlineDays": "0",
The permitted device count to open the document. "deviceLimit": "0",
Control the specified pages to be hidden. "accessPages": { The content cover over the hidden pages. "wrapperContent": "",
The picture cover over the hidden pages. Cannot support now. Just leave it empty. "wrapperPic": "",
The page indexes to be hidden. For example, [ 1, [2,10],12 ]. "Pages": [0] } } ] }
|
inline |
Set the user token to switch it.
[in] | user_token | The input user token. |