Foxit PDF SDK  9.1
FSLTVVerifier Class Reference

Attribute type: invalid.
More...

Inheritance diagram for FSLTVVerifier:
FSBase

Instance Methods

(void) - addDSS:
 Add the verify result (as VRI information) of a signature to the DSS.
More...
 
(void) - dealloc
 
(void *) - getCptr
 
(id) - initWithCptr:swigOwnCObject:
 
(id) - initWithDocument:is_verify_signature:use_expired_tst:ignore_doc_info:time_type:
 Constructor, with parameters.
More...
 
(id) - initWithOther:
 Constructor, with another LTV verifier object.
More...
 
(BOOL) - isEmpty
 Check whether current object is empty or not.
More...
 
(id) - NS_UNAVAILABLE
 
(void) - setRevocationCallback:
 Set a customized pdf::RevocationCallback object.
More...
 
(void) - setTrustedCertStoreCallback:
 Set a customized pdf::TrustedCertStoreCallback object if user wants to trust some certificates.
More...
 
(void) - setVerifyMode:
 Set the verifying mode to specify which validation process is to be used.
More...
 
(FSSignatureVerifyResultArray *) - verify
 Verify all the signatures in the PDF document which is used to constructed current object.
More...
 
(FSSignatureVerifyResultArray *) - verifySignature:
 Verify the target signature in the PDF document which is used to constructed current object.
More...
 

Additional Inherited Members

- Protected Attributes inherited from FSBase
BOOL swigCMemOwn
 
void * swigCPtr
 

Detailed Description

Attribute type: invalid.

Attribute type: role, which means strings of structure element meaning and standard type it maps to.

Note
Value type for this attribute type is string.

Attribute type: Placement, which means the positioning of the element with respect to the enclosing reference area and other content.

Note
Value type for this attribute type is enum. Valid enum values are:
  • endlink<br></li><li>@link@endlink<br></li><li>@link@endlink<br></li><li>@link@endlink<br></li><li>@link@endlink<br></li></ul><br>Attributetype:Rotation.<br>@noteValuetypeforthisattributetypeisnumber.<br>Attributetype:WritingMode,whichmeansthedirectionsoflayoutprogressionforpackingofILSEs(inlineprogression)andstackingofBLSEs(blockprogression).<br>@noteValuetypeforthisattributetypeisenum.Validenumvaluesare:<br><ul><li>@link@endlink<br></li><li>@link@endlink<br></li><li>@link@endlink<br></li><li>@link@endlink(PDF2.0)<br></li></ul><br>Attributetype:Destination(PDF2.0),whichprovidesameanstoaccesscontent.<br>@noteValuetypeforthisattributetypeisanarrayofzeroorstirngswithID.<br>Attributetype:BBox,whichrepresentstheelement'sboundingbox(therectanglethatcompletelyenclosesitsvisiblecontent).<br>@noteValuetypeforthisattributetypeisanarrayoffournumbersin@refFSPDFPage"PDFcoordinatesystem"givingthecoordinatesoftheleft,bottom,right,andtopedgesoftheelements'sboundingbox.<br>Attributetype:Width,whichrepresentsthewidthoftheelement'scontentrectangle.<br>@noteValuetypeforthisattributetypeisnumberorenumvalue@link@endlink.<br>Attributetype:Height,whichrepresentstheheightoftheelement'scontentrectangle.<br>@noteValuetypeforthisattributetypeisnumberorenumvalue@link@endlink.<br>Attributetype:BackgroundColor,whichrepresentsthecolortobeusedtofillthebackgroundofatablecelloranyelement'scontentrectangle.<br>@noteValuetypeforthisattributetypeisRGBcolor.<br>Attributetype:BorderColor,whichrepresentsthecoloroftheborderdrawnontheedgesofatablecelloranyelement'scontentrectangle.<br>@noteValuetypeforthisattributetypeisRGBcolororanarrayofRGBcolorvalues.<br>Attributetype:BorderStyle,whichrepresentsthestyleofanelement'sborder.<br>@noteValuetypeforthisattributetypeisenumoranarrayofenumvalues.Validenumvaluesare:<ul><li>@link@endlink<br></li><li>@link@endlink<br></li><li>@link@endlink<br></li><li>@link@endlink<br></li><li>@link@endlink<br></li><li>@link@endlink<br></li><li>@link@endlink<br></li><li>@link@endlink<br></li><li>@link@endlink<br></li><li>@link@endlink<br></li></ul><br>Attributetype:BorderThickness,whichrepresentsthethicknessoftheborderdrawnontheedgesofatablecelloranyelement'scontentrectangle.<br>@noteValuetypeforthisattributetypeisnumber(forallfouredges)oranarrayoffournumbers(foroneedgeoftheborder,intheorderofthebefore,after,start,andendedge).<br>Attributetype:Attached,whichspecifiestheedgesofthepage,ifany,towhichtheartifactislogicallyattached.<br>@noteValuetypeforthisattributetypeisanarrayofspecifiedenumvalues.Validenumvaluesare:<ul><li>@link@endlink<br></li><li>@link@endlink<br></li><li>@link@endlink<br></li><li>@link@endlink<br></li></ul><br>Attributetype:Subtype,whichmeansthesubtypeofannotationorartifact.<br>@noteValuetypeforthisattributetype:<ul><li>Forannotation,valuetypeisstring.<br></li><li>Forartifact,valuetypeisenum.Validenumvaluesare:<ul><li>@link@endlink<br></li><li>@link@endlink<br></li><li>@link@endlink<br></li><li>@link@endlink<br></li></ul><br></li></ul><br>Attributetype:Padding,whichspecifiesanoffsettoaccountfortheseparationbetweentheelement'scontentrectangleandthesurroundingborder.<br>@noteValuetypeforthisattributetypeisnumber(forallfoursides)oranarrayoffournumbers(forthebefore,after,start,andendedge).<br>Attributetype:Color,whichrepresentsthecolortobeusedfordrawingtextandthedefaultvalueforthecoloroftablebordersandtextdecorations.<br>@noteValuetypeforthisattributetypeisRGBcolor.<br>Attributetype:SpaceBefore,whichrepresentstheamountofextraspaceprecedingthebeforeedgeoftheBLSE.<br>@noteValuetypeforthisattributetypeisnumber.<br>Attributetype:SpaceAfter,whichrepresentstheamountofextraspacefollowingtheafteredgeoftheBLSE.<br>@noteValuetypeforthisattributetypeisnumber.<br>Attributetype:StartIndent,whichrepresentsthedistancefromthestartedgeofthereferenceareatothatoftheBLSE.<br>@noteValuetypeforthisattributetypeisnumber.<br>Attributetype:EndIndent,whichrepresentsthedistancefromtheendedgeoftheBLSEtothatofthereferencearea.<br>@noteValuetypeforthisattributetypeisnumber.<br>Attributetype:TextIndent,whichrepresentstheadditionaldistancefromthestartedgeoftheBLSE,asspecifiedby@link@endlink,tothatofthefirstlineoftext.<br>@noteValuetypeforthisattributetypeisnumber.<br>Attributetype:TextAlign,whichrepresentsthealignmentoftextandothercontentwithinlinesoftheBLSE.<br>@noteValuetypeforthisattributetypeisenum.Validenumvaluesare:<ul><li>@link@endlink<br></li><li>@link@endlink<br></li><li>@link@endlink<br></li><li>@link@endlink<br></li></ul><br>Attributetype:BlockAlign,whichrepresentsthealignment,intheblock-progressiondirection,ofcontentwithinthetablecell.<br>@noteValuetypeforthisattributetypeisenum.Validenumvaluesare:<ul><li>@link@endlink<br></li><li>@link@endlink<br></li><li>@link@endlink<br></li><li>@link@endlink<br></li></ul><br>Attributetype:InlineAlign,whichrepresentsthealignment,intheinline-progressiondirection,ofcontentwithinthetablecell.<br>@noteValuetypeforthisattributetypeisenum.Validenumvaluesare:<ul><li>@link@endlink<br></li><li>@link@endlink<br></li><li>@link@endlink<br></li></ul><br>Attributetype:TBorderStyle,whichrepresentsthestyleoftheborderdrawnoneachedgeofatablecell.<br>@noteValuetypeforthisattributetypeisenumoranarrayofspecifiedenumvalues.Validenumvaluesare:<ul><li>@link@endlink<br></li><li>@link@endlink<br></li><li>@link@endlink<br></li><li>@link@endlink<br></li><li>@link@endlink<br></li><li>@link@endlink<br></li><li>@link@endlink<br></li><li>@link@endlink<br></li><li>@link@endlink<br></li><li>@link@endlink<br></li></ul><br>Attributetype:TPadding,whichspecifiesanoffsettoaccountfortheseparationbetweenthetablecell'scontentrectangleandthesurroundingborder.<br>@noteValuetypeforthisattributetypeisnumber(forallfouredgesofthetablecell)oranarrayoffournumbers(forthebeforeedge,afteredge,startedge,andendedgeofthecontentrectangle).<br>Attributetype:BaselineShift,whichmeansthedistancebywhichtheelement'sbaselineisshiftedrelativetothatofitsparentelement.<br>@noteValuetypeforthisattributetypeisnumber.<br>Attributetype:LineHeight,whichmeanstheelement'spreferredheight,intheblock-progressiondirection.<br>@noteValuetypeforthisattributetypecanbenumberorenum.Validenumvaluesare:<ul><li>@link@endlink<br></li><li>@link@endlink<br></li></ul><br>Attributetype:TextDecorationColor,whichrepresentsthecolortobeusedfordrawingtextdecorations.<br>@noteValuetypeforthisattributetypeisRGBcolor.<br>Attributetype:TextDecorationThickness,whichrepresentsthethicknessofeachlinedrawnaspartofthetextdecoration.<br>@noteValuetypeforthisattributetypeisnumber.<br>Attributetype:TextDecorationType,whichrepresentsthetextdecoration,ifany,tobeappliedtotheelement'stext.<br>@noteValuetypeforthisattributetypeisenumoranarrayofspecifiedenumvalues.Validenumvaluesare:<ul><li>@link@endlink<br></li><li>@link@endlink<br></li><li>@link@endlink<br></li><li>@link@endlink<br></li></ul><br>Attributetype:RubyAlign,whichrepresentsthejustificationofthelineswithinarubyassembly.<br>@noteValuetypeforthisattributetypeisenumoranarrayofspecifiedenumvalues.Validenumvaluesare:<ul><li>@link@endlink<br></li><li>@link@endlink<br></li><li>@link@endlink<br></li><li>@link@endlink<br></li><li>@link@endlink<br></li></ul><br>Attributetype:RubyPosition,whichrepresentstheplacementoftheRTstructureelementrelativetotheRBelementinarubyassembly.<br>@noteValuetypeforthisattributetypeisenum.Validenumvaluesare:<ul><li>@link@endlink<br></li><li>@link@endlink<br></li><li>@link@endlink<br></li><li>@link@endlink<br></li></ul><br>Attributetype:GlyphOrientationVertical,whichspecifiestheorientationofglyphswhentheinline-progressiondirectionistoptobottomorbottomtotop.<br>@noteValuetypeforthisattributetypeisnumber(whichshouldbeoneofspecifiednumbers-90,0,90,180,and270)orenum(whichshouldbevalue@link@endlink).<br>Attributetype:ColumnCount,whichrepresentsthenumberofcolumnsinthecontentofthegroupingelement.<br>@noteValuetypeforthisattributetypeisnumber.<br>Attributetype:ColumnGap,whichrepresentsthedesiredspacebetweenadjacentcolumns,measuredintheinline-progressiondirection.<br>@noteValuetypeforthisattributetypecanbenumber(forallcolumns)oranarrayofnumbers.Whenthevaluetypeisarray:<ul><li>ifthearraycontains(ColumnCount-1)numbers,thesenumbersrepresentthespacebetweenthefirstandsecondcolumns,thesecondandthirdcolumns,andsoon,respectively.<br></li><li>iftherearefewerthan(ColumnCount-1)numbers,thelastelementspecifiesallremainingspaces;excessarrayelementsareignored.<br></li></ul><br>Attributetype:ColumnWidths,whichrepresentsthedesiredwidthofthecolumns,measuredintheinline-progressiondirection.<br>@noteValuetypeforthisattributetypecanbenumber(forallcolumns)oranarrayofnumbers.Whenthevaluetypeisarray:<ul><li>ifthearraycontainsColumnCountnumbers,thesenumbersrepresentthewidthofeachcolumn,inorder.<br></li><li>iftherearefewerthanColumnCountnumbers,thelastelementspecifiesallremainingwidths;excessarrayelementsareignored.<br></li></ul><br>AttributetypeonlyforList:ListNumbering,whichrepresentsthenumberingsystemtobeusedtogeneratethecontentoftheLbl(Label)elementsinanautonumberedlist,orthesymbolusedtoidentifyeachiteminanunnumberedlist.<br>@noteValuetypeforthisattributetypeisenum.Validenumvaluesare:<ul><li>@link@endlink<br></li><li>@link@endlink<br></li><li>@link@endlink<br></li><li>@link@endlink<br></li><li>@link@endlink<br></li><li>@link@endlink<br></li><li>@link@endlink<br></li><li>@link@endlink<br></li><li>@link@endlink<br></li><li>@link@endlink(PDF2.0)<br></li><li>@link@endlink(PDF2.0)<br></li></ul><br>AttributetypeonlyforPrintField:Role,whichrepresentsthetypeofformfieldrepresentedbythisgraphic.<br>@noteValuetypeforthisattributetypeisenum.Validenumvaluesare:<ul><li>@link@endlink<br></li><li>@link@endlink<br></li><li>@link@endlink<br></li><li>@link@endlink<br></li></ul><br>AttributetypeonlyforPrintField:checked,whichrepresentsthestateofaradiobuttonorcheckboxfield.<br>@noteValuetypeforthisattributetypeisenum.Validenumvaluesare:<ul><li>@link@endlink<br></li><li>@link@endlink<br></li><li>@link@endlink<br></li></ul><br>AttributetypeonlyforPrintField:Desc,whichrepresentsthealternatenameofthefield,similartothevaluesuppliedintheTUentryofthefielddictionaryforinteractivefields.<br>@noteValuetypeforthisattributetypeisstring.<br>AttributetypeonlyforTable:RowSpan,whichrepresentsthenumberofrowsintheenclosingtablethatarespannedbythecell.<br>@noteValuetypeforthisattributetypeisnumber.<br>AttributetypeonlyforTable:ColSpan,whichrepresentsthenumberofcolumnsintheenclosingtablethatarespannedbythecell.<br>@noteValuetypeforthisattributetypeisnumber.<br>(Currently,unsupported)AttributetypeonlyforTable:Headers,whichrepresentsanarrayofelementidentifiers.<br>@noteValuetypeforthisattributetypeisanarrayofstrings.<br>AttributetypeonlyforTable:Scope,whichindicateswhethertheheadercellappliestotherestofthecellsintherowthatcontainsit,thecolumnthatcontainsit,orboththerowandthecolumnthatcontainit.<br>@noteValuetypeforthisattributetypeisenum.Validenumvaluesare:<ul><li>@link@endlink<br></li><li>@link@endlink<br></li><li>@link@endlink<br></li></ul><br>AttributetypeonlyforTable:Summary,whichrepresentsasummaryofthetable'spurposeandstructure,foruseinnon-visualrenderingsuchasspeechorbraille.<br>@noteValuetypeforthisattributetypeisstring.<br>Attributetype:Short(PDF2.0),whichcontainsashortformofthecontentofaTHstructureelement'scontent.<br>@noteValuetypeforthisattributetypeisstring.<br>(Reserved)Attributetype:Direction.<br>@noteValuetypeforthisattributetypeisenum.Validenumvaluesare:<ul><li>@link@endlink<br></li><li>@link@endlink<br></li><li>@link@endlink<br></li><li>@link@endlink<br></li><li>@link@endlink(PDF2.0)<br></li></ul><br>(Reserved)Attributetype:ABox.<br>@noteValuetypeforthisattributetypeisanarrayoffournumbers.<br>(Reserved)Attributetype:Version,whichrepresentsschemaversionoflayoutrecognitionengine.<br>@noteValuetypeforthisattributetypeisnumber.<br>\ilinebr\ilinebrLTVverifierisusedtoverifysignatureinLTVworkflow.Beforeusethisclasstoverifysignature(s),pleaseensureverifymodehasbeensetbyfunction@linkFSLTVVerifier::setVerifyMode:@endlink.<br>FoxitPDFSDKhasadefaultrevocationcallbackforLTVverifier.Ifuserwantstousecustomizedrevocationcallback,pleaserefertofunction@linkFSLTVVerifier::setRevocationCallback:@endlink.<br>Ifuserwantstotrustsomecertificates,pleaserefertofunction@linkFSLTVVerifier::setTrustedCertStoreCallback:@endlink.<br><br>

Method Documentation

◆ addDSS:

- (void) addDSS: (FSSignatureVerifyResult*)  signature_verify_result

Add the verify result (as VRI information) of a signature to the DSS.

Parameters
[in]signature_verify_resultA signature verify result to be added to DSS.
Returns
None.

◆ dealloc

- (void) dealloc

Reimplemented from FSBase.

◆ getCptr

- (void*) getCptr

Reimplemented from FSBase.

◆ initWithCptr:swigOwnCObject:

- (id) initWithCptr: (void *)  cptr
swigOwnCObject: (BOOL)  ownCObject 

Reimplemented from FSBase.

◆ initWithDocument:is_verify_signature:use_expired_tst:ignore_doc_info:time_type:

- (id) initWithDocument: (FSPDFDoc*)  document
is_verify_signature: (BOOL)  is_verify_signature
use_expired_tst: (BOOL)  use_expired_tst
ignore_doc_info: (BOOL)  ignore_doc_info
time_type: (FSLTVVerifierTimeType time_type 

Constructor, with parameters.

Parameters
[in]documentA valid PDF document object.
[in]is_verify_signature(Only available for FSLTVVerifierVerifyModeAcrobat) Use to decide whether to verify signature validity when verifying signature or note.
[in]use_expired_tst(Only available for FSLTVVerifierVerifyModeAcrobat) Use to decide whether to use expired TST to verify signature or note.
[in]ignore_doc_info(Only available for FSLTVVerifierVerifyModeAcrobat) Use to decide whether to ignore the revocation information in DSS and signature or not.
[in]time_type(Only available for FSLTVVerifierVerifyModeAcrobat) Use to speicify the time type which is expected to be used for verifying. Please refer to values starting from FSLTVVerifierSignatureCreationTime and this should be one of these values except FSLTVVerifierVRICreationTime.

◆ initWithOther:

- (id) initWithOther: (FSLTVVerifier*)  other

Constructor, with another LTV verifier object.

Parameters
[in]otherAnother LTV verifier object.

◆ isEmpty

- (BOOL) isEmpty

Check whether current object is empty or not.

When the current object is empty, that means current object is useless.

Returns
YES means current object is empty, while NO means not.

◆ NS_UNAVAILABLE

- (id) NS_UNAVAILABLE

◆ setRevocationCallback:

- (void) setRevocationCallback: (id<FSRevocationCallback>)  callback

Set a customized pdf::RevocationCallback object.

If no customized revocation callback is set by this function, Foxit PDF SDK will use a default one.

Parameters
[in]callbackA customized revocation callback object, which is implemented based on callback class pdf::RevocationCallback. This should not be nil.
Returns
None.

◆ setTrustedCertStoreCallback:

- (void) setTrustedCertStoreCallback: (id<FSTrustedCertStoreCallback>)  callback

Set a customized pdf::TrustedCertStoreCallback object if user wants to trust some certificates.

If no trusted cert store callback object is set by this function, no certificate will be trusted during verifying process.

Parameters
[in]callbackA customized trusted cert store callback object, which is implemented based on callback class pdf::TrustedCertStoreCallback. This can be set to nil which means not to use it.

◆ setVerifyMode:

- (void) setVerifyMode: (FSLTVVerifierVerifyMode mode

Set the verifying mode to specify which validation process is to be used.

Please ensure to set the verify mode before doing verifying.

Parameters
[in]modeThe verify mode used for express verify process. Please refer to values starting from FSLTVVerifierVerifyModeAcrobat and this should be one of these values.
Returns
None.

◆ verify

Verify all the signatures in the PDF document which is used to constructed current object.

If verify mode is FSLTVVerifierVerifyModeAcrobat, the verifying process will stop immediately when fail to verify any signature and return verify results for successfully verified signatures only. If verify mode is FSLTVVerifierVerifyModeAcrobat, all the signatures will be verified and return verify results for all the signatures.

Returns
An array of signature verify results.

◆ verifySignature:

- (FSSignatureVerifyResultArray *) verifySignature: (FSSignature*)  signature

Verify the target signature in the PDF document which is used to constructed current object.

Parameters
[in]signatureTarget signature to be verified. If verify mode is FSLTVVerifierVerifyModeAcrobat, this function will verify signatures until target signature. If verify mode is FSLTVVerifierVerifyModeAcrobat, this function will only verify target signature.
Returns
An array of signature verify result.