This class represents some data used for class DRMSecurityHandler .
◆ GetCipher()
| fsdk.DRMEncryptData.GetCipher |
( |
| ) |
|
◆ GetIs_encrypt_metadata()
| fsdk.DRMEncryptData.GetIs_encrypt_metadata |
( |
| ) |
|
Get a boolean value to decide whether to encrypt metadata or not.
- Returns
- A boolean value to decide whether to encrypt metadata or not. true means to encrypt metadata, and false means not to encrypt metadata.
◆ GetIs_owner()
| fsdk.DRMEncryptData.GetIs_owner |
( |
| ) |
|
Get a boolean value to decide whether current user is owner or not.
- Returns
- A boolean value to decide whether current user is owner or not. true means current user is owner, and false means current user is not owner.
◆ GetKey_length()
| fsdk.DRMEncryptData.GetKey_length |
( |
| ) |
|
◆ GetSub_filter()
| fsdk.DRMEncryptData.GetSub_filter |
( |
| ) |
|
Get the sub filter name that specifies the syntax of the encryption dictionary contents.
- Returns
- The sub filter name that specifies the syntax of the encryption dictionary contents.
◆ GetUser_permissions()
| fsdk.DRMEncryptData.GetUser_permissions |
( |
| ) |
|
Get the user permissions.
- Returns
- The user permissions. Please refer to values starting from fsdk.PDFDocE_PermPrint and this can be one or combination of these values.
◆ Set()
| def fsdk.DRMEncryptData.Set |
( |
|
is_encrypt_metadata, |
|
|
|
sub_filter, |
|
|
|
cipher, |
|
|
|
key_length, |
|
|
|
is_owner, |
|
|
|
user_permissions |
|
) |
| |
Set value.
- Parameters
-
| [in] | is_encrypt_metadata | true means to encrypt metadata, and false means not to encrypt metadata |
| [in] | sub_filter | The sub filter name that specifies the syntax of the encryption dictionary contents. |
| [in] | cipher | Cipher type. Please refer to values starting from fsdk.SecurityHandlerE_CipherRC4 and this should be one of these values except fsdk.SecurityHandlerE_CipherNone . |
| [in] | key_length | The key length, in bytes.
For fsdk.SecurityHandlerE_CipherRC4 cipher, this value should be between 5 and 16.
For fsdk.SecurityHandlerE_CipherAES cipher, this value should be 16 or 32. |
| [in] | is_owner | true means current user is owner, and false means current user is not owner. |
| [in] | user_permissions | The user permissions. Please refer to values starting from fsdk.PDFDocE_PermPrint and this can be one or combination of these values. |
- Returns
- None.
◆ SetCipher()
| fsdk.DRMEncryptData.SetCipher |
( |
|
value | ) |
|
Set cipher type.
- Parameters
-
- Returns
- None.
◆ SetIs_encrypt_metadata()
| fsdk.DRMEncryptData.SetIs_encrypt_metadata |
( |
|
value | ) |
|
Set a boolean value to decide whether to encrypt metadata or not.
- Parameters
-
| [in] | value | A boolean value to decide whether to encrypt metadata or not. true means to encrypt metadata, and false means not to encrypt metadata. |
- Returns
- None.
◆ SetIs_owner()
| fsdk.DRMEncryptData.SetIs_owner |
( |
|
value | ) |
|
Set a boolean value to decide whether current user is owner or not.
- Parameters
-
| [in] | value | A boolean value to decide whether current user is owner or not. true means current user is owner, and false means current user is not owner. |
- Returns
- None.
◆ SetKey_length()
| fsdk.DRMEncryptData.SetKey_length |
( |
|
value | ) |
|
Set the key length, in bytes.
- Parameters
-
- Returns
- None.
◆ SetSub_filter()
| fsdk.DRMEncryptData.SetSub_filter |
( |
|
value | ) |
|
Set the sub filter name that specifies the syntax of the encryption dictionary contents.
- Parameters
-
| [in] | value | The sub filter name that specifies the syntax of the encryption dictionary contents. |
- Returns
- None.
◆ SetUser_permissions()
| fsdk.DRMEncryptData.SetUser_permissions |
( |
|
value | ) |
|
Set the user permissions.
- Parameters
-
| [in] | value | The user permissions. Please refer to values starting from fsdk.PDFDocE_PermPrint and this can be one or combination of these values. |
- Returns
- None.