groupdocs-signature-cloud
Version:
GroupDocs.Signature Cloud SDK for Node.js
2,300 lines (2,299 loc) • 95.9 kB
TypeScript
/**
* Describes Barcode type
*/
export declare class BarcodeType {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* Barcode type name
*/
name: string;
constructor(init?: Partial<BarcodeType>);
}
/**
* Describes collection of supported Barcode types
*/
export declare class BarcodesResult {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* List of Barcode types
*/
barcodeTypes: Array<BarcodeType>;
constructor(init?: Partial<BarcodesResult>);
}
/**
* Defines base class for settings
*/
export declare class BaseSettings {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* File info
*/
fileInfo: FileInfo;
constructor(init?: Partial<BaseSettings>);
}
/**
* Instance to keep Border line properties
*/
export declare class BorderLine {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* Gets or sets the signature border style
*/
style: BorderLine.StyleEnum;
/**
* Gets or sets the signature border transparency (value from 0.0 (opaque) through 1.0 (clear))
*/
transparency: number;
/**
* Gets or sets the weight of the signature border
*/
weight: number;
/**
* Gets or sets the border color of signature
*/
color: Color;
/**
* Gets or sets the border visibility
*/
visible: boolean;
constructor(init?: Partial<BorderLine>);
}
export declare namespace BorderLine {
enum StyleEnum {
Solid,
ShortDash,
ShortDot,
ShortDashDot,
ShortDashDotDot,
Dot,
Dash,
LongDash,
DashDot,
LongDashDot,
LongDashDotDot,
RoundDot,
SquareDot,
DashDotDot,
DashLongDash,
DashLongDashDot
}
}
/**
* Represents base class for various brushes
*/
export declare class Brush {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* Internal property that specify the current brush type
*/
brushType: string;
constructor(init?: Partial<Brush>);
}
/**
* Keep color value
*/
export declare class Color {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* HTML string color representation
*/
web: string;
constructor(init?: Partial<Color>);
}
/**
* Metered license consumption information
*/
export declare class ConsumptionResult {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* Amount of used credits
*/
credit: number;
/**
* Amount of MBs processed
*/
quantity: number;
constructor(init?: Partial<ConsumptionResult>);
}
/**
* Base container class for delete signature options
*/
export declare class DeleteOptions {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* Specifies the type of signature
*/
signatureType: DeleteOptions.SignatureTypeEnum;
/**
* Unique signature identifier to modify signature in the document over Update or Delete methods. This property will be set automatically after Sign or Search method being called. If this property was saved before it can be set manually to manipulate the signature.
*/
signatureId: string;
constructor(init?: Partial<DeleteOptions>);
}
export declare namespace DeleteOptions {
enum SignatureTypeEnum {
None,
Text,
Image,
Digital,
Barcode,
QRCode,
Stamp,
FormField,
Metadata
}
}
/**
* Delete result information
*/
export declare class DeleteResult {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* Source document file info
*/
fileInfo: FileInfo;
/**
* Source document size in bytes
*/
size: number;
/**
* List of successfully deleted signatures
*/
succeeded: Array<Signature>;
/**
* List of signatures that were not deleted
*/
failed: Array<Signature>;
constructor(init?: Partial<DeleteResult>);
}
export declare class DigitalVBA {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* Gets or sets the password of digital certificate
*/
password: string;
/**
* Gets or sets the digital certificate file path
*/
certificateFilePath: string;
/**
* Gets or sets setting of only VBA project signing. If set to true, the SpreadSheet document will not be signed, but the VBA project will be signed.
*/
signOnlyVBAProject: boolean;
/**
* Gets or sets the signature comments.
*/
comments: string;
constructor(init?: Partial<DigitalVBA>);
}
/**
* Class for disc space information.
*/
export declare class DiscUsage {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* Application used disc space.
*/
usedSize: number;
/**
* Total disc space.
*/
totalSize: number;
constructor(init?: Partial<DiscUsage>);
}
/**
* The error details
*/
export declare class ErrorDetails {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* The request id
*/
requestId: string;
/**
* Date
*/
date: Date;
constructor(init?: Partial<ErrorDetails>);
}
/**
* File info
*/
export declare class FileInfo {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* File path in storage
*/
filePath: string;
/**
* Storage name
*/
storageName: string;
/**
* Version ID
*/
versionId: string;
/**
* Password to open file
*/
password: string;
constructor(init?: Partial<FileInfo>);
}
/**
* File versions FileVersion.
*/
export declare class FileVersions {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* File versions FileVersion.
*/
value: Array<FileVersion>;
constructor(init?: Partial<FileVersions>);
}
/**
* Files list
*/
export declare class FilesList {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* Files and folders contained by folder StorageFile.
*/
value: Array<StorageFile>;
constructor(init?: Partial<FilesList>);
}
/**
* File upload result
*/
export declare class FilesUploadResult {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* List of uploaded file names
*/
uploaded: Array<string>;
/**
* List of errors.
*/
errors: Array<Error>;
constructor(init?: Partial<FilesUploadResult>);
}
/**
* File format
*/
export declare class Format {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* File format extension
*/
extension: string;
/**
* File format name
*/
fileFormat: string;
constructor(init?: Partial<Format>);
}
/**
* Describes list of supported file formats
*/
export declare class FormatsResult {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* Supported file formats
*/
formats: Array<Format>;
constructor(init?: Partial<FormatsResult>);
}
/**
* Document info result
*/
export declare class InfoResult {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* Input File info
*/
fileInfo: FileInfo;
/**
* Document extension
*/
extension: string;
/**
* Document file format
*/
fileFormat: string;
/**
* Document size in bytes
*/
size: number;
/**
* Count of pages in document
*/
pagesCount: number;
/**
* Document created date
*/
dateCreated: Date;
/**
* Document modification date
*/
dateModified: Date;
/**
* Specifies width for max height of document page
*/
widthForMaxHeight: number;
/**
* Specifies max page height
*/
maxPageHeight: number;
/**
* List of document pages descriptions
*/
pages: Array<PageInfo>;
/**
* Collection of document signatures
*/
signatures: Array<Signature>;
constructor(init?: Partial<InfoResult>);
}
/**
* Error
*/
export declare class ModelError {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* Code
*/
code: string;
/**
* Message
*/
message: string;
/**
* Description
*/
description: string;
/**
* Inner Error
*/
innerError: ErrorDetails;
constructor(init?: Partial<ModelError>);
}
/**
* Object exists
*/
export declare class ObjectExist {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* Indicates that the file or folder exists.
*/
exists: boolean;
/**
* True if it is a folder, false if it is a file.
*/
isFolder: boolean;
constructor(init?: Partial<ObjectExist>);
}
/**
* Base container class for all possible options data
*/
export declare class OptionsBase {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* Specifies the signature type of processing
*/
signatureType: OptionsBase.SignatureTypeEnum;
/**
* Gets or sets a document page number for processing. Value is optional
*/
page: number;
/**
* Process all document pages. Type of processing depends on SignatureType For Images Document Type it can be used only for multi-frames images like .tiff
*/
allPages: boolean;
/**
* Options to specify pages for processing
*/
pagesSetup: PagesSetup;
constructor(init?: Partial<OptionsBase>);
}
export declare namespace OptionsBase {
enum SignatureTypeEnum {
None,
Text,
Image,
Digital,
Barcode,
QRCode,
Stamp,
FormField,
Metadata
}
}
/**
* Represents padding or margin information associated with element
*/
export declare class Padding {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* Gets or sets the padding value for all the edges
*/
all: number;
/**
* Gets or sets the padding value for the left edge
*/
left: number;
/**
* Gets or sets the padding value for the top edge
*/
top: number;
/**
* Gets or sets the padding value for the right edge
*/
right: number;
/**
* Gets or sets the padding value for the bottom edge
*/
bottom: number;
constructor(init?: Partial<Padding>);
}
/**
* Page information
*/
export declare class PageInfo {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* Page number
*/
number: number;
/**
* Page name
*/
name: string;
/**
* Page width
*/
width: number;
/**
* Page height
*/
height: number;
/**
* Page angle
*/
angle: number;
/**
* Page visibility
*/
visible: boolean;
constructor(init?: Partial<PageInfo>);
}
/**
* Describes special pages of document to process
*/
export declare class PagesSetup {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* Get or set flag to use first document page
*/
firstPage: boolean;
/**
* Get or set flag to use last document page
*/
lastPage: boolean;
/**
* Get or set flag to use odd pages of document
*/
oddPages: boolean;
/**
* Get or set flag to use even pages of document
*/
evenPages: boolean;
/**
* Set arbitrary pages of document to use
*/
pageNumbers: Array<number>;
constructor(init?: Partial<PagesSetup>);
}
/**
* Contains pdf digital Signature properties
*/
export declare class PdfDigitalSignature {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* Information provided by the signer to enable a recipient to contact the signer
*/
contactInfo: string;
/**
* The CPU host name or physical location of the signing.
*/
location: string;
/**
* The reason for the signing, such as (I agree…).
*/
reason: string;
/**
* Type of Pdf digital signature.
*/
type: PdfDigitalSignature.TypeEnum;
/**
* Time stamp for Pdf digital signature. Default value is null.
*/
timeStamp: TimeStamp;
/**
* Force to show/hide signature properties
*/
showProperties: boolean;
constructor(init?: Partial<PdfDigitalSignature>);
}
export declare namespace PdfDigitalSignature {
enum TypeEnum {
Signature,
Certificate
}
}
/**
* Document preview page
*/
export declare class PreviewPage {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* Page number
*/
pageNumber: number;
/**
* Page file path in storage
*/
filePath: string;
/**
* Page file size
*/
size: number;
/**
* Download url
*/
downloadUrl: string;
constructor(init?: Partial<PreviewPage>);
}
/**
* Document preview result
*/
export declare class PreviewResult {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* Input File info
*/
fileInfo: FileInfo;
/**
* Input File size
*/
size: number;
/**
* Count of pages
*/
pagesCount: number;
/**
* Document preview pages
*/
pages: Array<PreviewPage>;
constructor(init?: Partial<PreviewResult>);
}
/**
* Describes QR-code type
*/
export declare class QRCodeType {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* QR-code type name
*/
name: string;
constructor(init?: Partial<QRCodeType>);
}
/**
* Describes collection of supported QR-code types
*/
export declare class QRCodesResult {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* List of QRCode Types
*/
qRCodeTypes: Array<QRCodeType>;
constructor(init?: Partial<QRCodesResult>);
}
/**
* Base document save options class
*/
export declare class SaveOptions {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* Overwrite existing file with new output file. Otherwise new file will be created with number as suffix
*/
overwriteExisting: boolean;
/**
* Output file name
*/
outputFilePath: string;
/**
* format of save
*/
saveFormat: string;
constructor(init?: Partial<SaveOptions>);
}
/**
* Search result information
*/
export declare class SearchResult {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* Processed file info
*/
fileInfo: FileInfo;
/**
* Size in bytes
*/
size: number;
/**
* List of document signatures that were found during search
*/
signatures: Array<Signature>;
constructor(init?: Partial<SearchResult>);
}
/**
* Sign result information
*/
export declare class SignResult {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* Signed file info
*/
fileInfo: FileInfo;
/**
* Source document size in bytes
*/
size: number;
/**
* ULR to retrieve signed file
*/
downloadUrl: string;
/**
* List of newly created signatures
*/
succeeded: Array<Signature>;
/**
* List of signatures that were failed to create
*/
failed: Array<Signature>;
constructor(init?: Partial<SignResult>);
}
/**
* Describes base class for signatures
*/
export declare class Signature {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* Specifies the signature type (Text, Image, Digital, Barcode, QRCode, Stamp)
*/
signatureType: Signature.SignatureTypeEnum;
/**
* Specifies the page signature was found on
*/
pageNumber: number;
/**
* Unique signature identifier to modify signature in the document over Update or Delete methods. This property will be set automatically after Sign or Search method being called. If this property was saved before it can be set manually to manipulate the signature.
*/
signatureId: string;
/**
* Get or set flag to indicate if this component is Signature or document content. This property is being used with Update method to set element as signature (true) or document element (false).
*/
isSignature: boolean;
/**
* Get or set the signature creation date
*/
createdOn: Date;
/**
* Get or set the signature modification date
*/
modifiedOn: Date;
/**
* Specifies top position of signature
*/
top: number;
/**
* Specifies left position of signature
*/
left: number;
/**
* Specifies width of signature
*/
width: number;
/**
* Specifies height of signature
*/
height: number;
constructor(init?: Partial<Signature>);
}
export declare namespace Signature {
enum SignatureTypeEnum {
None,
Text,
Image,
Digital,
Barcode,
QRCode,
Stamp,
FormField,
Metadata
}
}
/**
* Appearance is a base class for keeping additional information for various options
*/
export declare class SignatureAppearance {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* Specifies the type of appearance
*/
appearanceType: SignatureAppearance.AppearanceTypeEnum;
constructor(init?: Partial<SignatureAppearance>);
}
export declare namespace SignatureAppearance {
enum AppearanceTypeEnum {
Undefined,
PdfTextAnnotation,
PdfTextSticker,
Image,
DigitalSignature,
PdfDigitalSignature
}
}
/**
* Create instance of SignatureFont class to specify Font properties
*/
export declare class SignatureFont {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* Font Family Name
*/
fontFamily: string;
/**
* Font Size
*/
fontSize: number;
/**
* Apply Font Bold Style
*/
bold: boolean;
/**
* Apply Font Italic Style
*/
italic: boolean;
/**
* Apply Underline Style
*/
underline: boolean;
constructor(init?: Partial<SignatureFont>);
}
/**
* Specify Stamp line properties
*/
export declare class StampLine {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* Gets or sets the line height on Stamp
*/
height: number;
/**
* Gets or sets the background color of signature
*/
backgroundColor: Color;
/**
* Gets or sets the text of stamp line
*/
text: string;
/**
* Get or set Font of Stamp Line text
*/
font: SignatureFont;
/**
* Gets or sets the text color of signature
*/
textColor: Color;
/**
* Gets or sets the bottom intent of text
*/
textBottomIntent: number;
/**
* Gets or sets text repeat type
*/
textRepeatType: StampLine.TextRepeatTypeEnum;
/**
* Setup Outer Border
*/
outerBorder: BorderLine;
/**
* Setup Internal Border
*/
innerBorder: BorderLine;
/**
* Get and set visibility of Stamp Line
*/
visible: boolean;
constructor(init?: Partial<StampLine>);
}
export declare namespace StampLine {
enum TextRepeatTypeEnum {
None,
FullTextRepeat,
RepeatWithTruncation
}
}
/**
* Storage exists
*/
export declare class StorageExist {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* Shows that the storage exists.
*/
exists: boolean;
constructor(init?: Partial<StorageExist>);
}
/**
* File or folder information
*/
export declare class StorageFile {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* File or folder name.
*/
name: string;
/**
* True if it is a folder.
*/
isFolder: boolean;
/**
* File or folder last modified DateTime.
*/
modifiedDate: Date;
/**
* File or folder size.
*/
size: number;
/**
* File or folder path.
*/
path: string;
constructor(init?: Partial<StorageFile>);
}
/**
* Represents data to get time stamp from third-party site.
*/
export declare class TimeStamp {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* Url of third-party site.
*/
url: string;
/**
* User.
*/
user: string;
/**
* Password.
*/
password: string;
constructor(init?: Partial<TimeStamp>);
}
/**
* Base container class for update signature options
*/
export declare class UpdateOptions {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* Specifies the type of signature
*/
signatureType: UpdateOptions.SignatureTypeEnum;
/**
* Unique signature identifier to modify signature in the document over Update or Delete methods. This property will be set automatically after Sign or Search method being called. If this property was saved before it can be set manually to manipulate the signature.
*/
signatureId: string;
/**
* Specifies left position of signature
*/
left: number;
/**
* Specifies top position of signature
*/
top: number;
/**
* Specifies width of signature
*/
width: number;
/**
* Specifies height of signature
*/
height: number;
/**
* Get or set flag to indicate if this component is Signature or document content. This property is being used with Update method to set element as signature (true) or document element (false).
*/
isSignature: boolean;
/**
* The text to update text signature
*/
text: string;
constructor(init?: Partial<UpdateOptions>);
}
export declare namespace UpdateOptions {
enum SignatureTypeEnum {
None,
Text,
Image,
Digital,
Barcode,
QRCode,
Stamp,
FormField,
Metadata
}
}
/**
* Update result information
*/
export declare class UpdateResult {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* Updated document file info
*/
fileInfo: FileInfo;
/**
* Source document size in bytes
*/
size: number;
/**
* List of successfully modified signatures
*/
succeeded: Array<Signature>;
/**
* List of signatures that were not updated
*/
failed: Array<Signature>;
constructor(init?: Partial<UpdateResult>);
}
/**
* Verification result information
*/
export declare class VerifyResult {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* Processed document file info
*/
fileInfo: FileInfo;
/**
* Processed document size in bytes
*/
size: number;
/**
* Indicates whether document contains signatures that meet verification criteria
*/
isSuccess: boolean;
constructor(init?: Partial<VerifyResult>);
}
/**
* Contains Barcode signature properties
*/
export declare class BarcodeSignature extends Signature {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* Specifies the Barcode type
*/
barcodeType: string;
/**
* Specifies text of Bar-code
*/
text: string;
/**
* Specifies the format of Barcode signature image.
*/
format: string;
constructor(init?: Partial<BarcodeSignature>);
}
export declare namespace BarcodeSignature {
}
/**
* Defines delete sign document settings
*/
export declare class DeleteSettings extends BaseSettings {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* Gets or sets options to perform signatures delete
*/
options: Array<DeleteOptions>;
constructor(init?: Partial<DeleteSettings>);
}
/**
* Contains digital Signature properties
*/
export declare class DigitalSignature extends Signature {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* Gets or sets the signing purpose comment
*/
comments: string;
/**
* Keeps true if this digital signature is valid and the document has not been tampered with
*/
isValid: boolean;
/**
* Gets or sets the time the document was signed
*/
signTime: Date;
/**
* Pdf digital signature properties
*/
pdfDigitalSignature: PdfDigitalSignature;
constructor(init?: Partial<DigitalSignature>);
}
export declare namespace DigitalSignature {
}
/**
* Describes appearance of Signature Line for Digital Signature. One Signature Line could be applied for only one Digital Signature. Signature Line always is on the first page. This feature may be useful for .docx, .doc, .odt and .xlsx file formats.
*/
export declare class DigitalSignatureAppearance extends SignatureAppearance {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* Gets or sets a email that will be displayed in signature line.
*/
email: string;
/**
* Gets or sets signer name for signature line.
*/
signer: string;
/**
* Gets or sets a title for signature line.
*/
title: string;
constructor(init?: Partial<DigitalSignatureAppearance>);
}
export declare namespace DigitalSignatureAppearance {
}
/**
* File Version
*/
export declare class FileVersion extends StorageFile {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* File Version ID.
*/
versionId: string;
/**
* Specifies whether the file is (true) or is not (false) the latest version of an file.
*/
isLatest: boolean;
constructor(init?: Partial<FileVersion>);
}
/**
* Contains Form field signature properties
*/
export declare class FormFieldSignature extends Signature {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* Specifies unique form field name
*/
name: string;
/**
* Specifies Form field type
*/
type: FormFieldSignature.TypeEnum;
constructor(init?: Partial<FormFieldSignature>);
}
export declare namespace FormFieldSignature {
enum TypeEnum {
Text,
Checkbox,
Combobox,
DigitalSignature,
Radio,
None
}
}
/**
* Describes extended appearance features for Image Signature.
*/
export declare class ImageAppearance extends SignatureAppearance {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* Gets or sets image brightness. Default value is 1 it corresponds to original brightness of image.
*/
brightness: number;
/**
* Gets or sets image contrast. Default value is 1 it corresponds to original contrast of image.
*/
contrast: number;
/**
* Gets or sets image gamma. Default value is 1 it corresponds to original gamma of image.
*/
gammaCorrection: number;
/**
* Setup this flag to true if gray-scale filter is required.
*/
grayscale: boolean;
constructor(init?: Partial<ImageAppearance>);
}
export declare namespace ImageAppearance {
}
/**
* Contains Image signature properties
*/
export declare class ImageSignature extends Signature {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* Specifies the image size
*/
size: number;
/**
* Specifies the format of image
*/
format: string;
constructor(init?: Partial<ImageSignature>);
}
export declare namespace ImageSignature {
}
/**
* Defines document information request settings
*/
export declare class InfoSettings extends BaseSettings {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* Gets or sets flag that includes deleted signatures into Document Info result.
*/
showDeletedSignaturesInfo: boolean;
constructor(init?: Partial<InfoSettings>);
}
/**
* Represents linear gradient brush
*/
export declare class LinearGradientBrush extends Brush {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* Gets or sets start gradient color
*/
startColor: Color;
/**
* Gets or sets finish gradient color
*/
endColor: Color;
/**
* Gets or sets gradient angle
*/
angle: number;
constructor(init?: Partial<LinearGradientBrush>);
}
/**
* Contains Metadata signature properties.
*/
export declare class MetadataSignature extends Signature {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* Specifies metadata type.
*/
type: MetadataSignature.TypeEnum;
/**
* Specifies metadata value type.
*/
dataType: MetadataSignature.DataTypeEnum;
/**
* Specifies metadata object value
*/
value: string;
/**
* Specifies unique metadata name
*/
name: string;
/**
* The identifier of Image Metadata signature. See GroupDocs.Signature.Domain.ImageMetadataSignatures class that contains standard Signature with predefined Id value.
*/
id: number;
/**
* Size of Image Metadata value
*/
size: number;
/**
* Description for standard Image Metadata signature
*/
description: string;
/**
* The prefix tag of Pdf Metadata signature name. By default this property is set to \"xmp\". Possible values are
*/
tagPrefix: string;
constructor(init?: Partial<MetadataSignature>);
}
export declare namespace MetadataSignature {
enum TypeEnum {
None,
Certificate,
Image,
Pdf,
Presentation,
Spreadsheet,
WordProcessing
}
enum DataTypeEnum {
Undefined,
Boolean,
Integer,
Double,
DateTime,
String
}
}
/**
* Describes appearance of Digital Signature are on PDF documents.
*/
export declare class PdfDigitalSignatureAppearance extends SignatureAppearance {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* Get or set background color of signature appearance.
*/
background: Color;
/**
* Get or set foreground text color of signature appearance. By default the value is Color.FromArgb(76, 100, 255)
*/
foreground: Color;
/**
* Gets or sets contact info label. Default value: \"Contact\". if this value is empty then no contact label will appear on digital signature area.
*/
contactInfoLabel: string;
/**
* Gets or sets date signed label. Default value: \"Date\".
*/
dateSignedAtLabel: string;
/**
* Gets or sets digital signed label. Default value: \"Digitally signed by\".
*/
digitalSignedLabel: string;
/**
* Gets or sets the Font family name to display the labels. Default value is \"Arial\".
*/
fontFamilyName: string;
/**
* Gets or sets the Font size to display the labels. Default value is 10.
*/
fontSize: number;
/**
* Gets or sets location label. Default value: \"Location\". if this value is empty then no location label will appear on digital signature area.
*/
locationLabel: string;
/**
* Gets or sets reason label. Default value: \"Reason\". if this value is empty then no reason label will appear on digital signature area.
*/
reasonLabel: string;
constructor(init?: Partial<PdfDigitalSignatureAppearance>);
}
export declare namespace PdfDigitalSignatureAppearance {
}
/**
* Describes appearance of PDF text annotation object (Title, Subject, Content).
*/
export declare class PdfTextAnnotationAppearance extends SignatureAppearance {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* Represents border appearance
*/
border: BorderLine;
/**
* Gets or sets border effect.
*/
borderEffect: PdfTextAnnotationAppearance.BorderEffectEnum;
/**
* Gets or sets border effect intensity. Valid range of value is [0..2].
*/
borderEffectIntensity: number;
/**
* Gets or sets content of annotation object.
*/
contents: string;
/**
* Gets or sets horizontal corner radius.
*/
hCornerRadius: number;
/**
* Gets or sets Subject representing description of the object.
*/
subject: string;
/**
* Gets or sets a Title that will be displayed in title bar of annotation object.
*/
title: string;
/**
* Gets or sets vertical corner radius.
*/
vCornerRadius: number;
constructor(init?: Partial<PdfTextAnnotationAppearance>);
}
export declare namespace PdfTextAnnotationAppearance {
enum BorderEffectEnum {
None,
Cloudy
}
}
/**
* Describes appearance of PDF text annotation sticker object and pop-up window of sticker.
*/
export declare class PdfTextStickerAppearance extends SignatureAppearance {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* Gets or sets the contents of pop-up window.
*/
contents: string;
/**
* Gets or sets the icon of sticker.
*/
icon: PdfTextStickerAppearance.IconEnum;
/**
* Setup if sticker pop-up window will be opened by default.
*/
opened: boolean;
/**
* Gets or sets subject.
*/
subject: string;
/**
* Gets or sets title of pop-up window.
*/
title: string;
constructor(init?: Partial<PdfTextStickerAppearance>);
}
export declare namespace PdfTextStickerAppearance {
enum IconEnum {
Note,
Comment,
Key,
Help,
NewParagraph,
Paragraph,
Insert,
Check,
Cross,
Circle,
Star
}
}
/**
* Defines preview request settings
*/
export declare class PreviewSettings extends BaseSettings {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
/**
* Returns attribute type map
*/
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
/**
* Preview images width
*/
width: number;
/**
* Preview images height
*/
height: number;
/**
* Gets or sets the resolution of the preview images in DPI (dots per inch).
*/
resolution: number;
/**
* Preview page numbers
*/
pageNumbers: Array<number>;
/**
* Preview format
*/
previewFormat: PreviewSettings.PreviewFormatEnum;
/**
* Flag to hide signatures from page preview image. Only signatures are marked as IsSignature will be hidden from generated document page image
*/
hideSignatures: boolean;
/**
* Set path for output pages. If not set then default path used.
*/
outputPath: string;
constructor(init?: Partial<PreviewSettings>);
}
export declare namespace PreviewSettings {
enum PreviewFormatEnum {
PNG,
JPEG,
BMP
}
}
/**
* Contains QRCode signature properties
*/
export declare class QRCodeSignature extends Signature {
/**
* Attribute type map
*/
static attributeTypeMap: Array<{
name: string;
baseName: string;