Azure Connectors Node.js SDK
    Preparing search index...

    Interface GetPackageAllPackagesOptions

    Options for the getPackageAllPackages operation.

    interface GetPackageAllPackagesOptions {
        abortSignal?: AbortSignalLike;
        asc?: boolean;
        attachments?: boolean;
        certifiedDocuments?: boolean;
        documentId?: number;
        documentStatuses?: string[];
        documentType?: string;
        expiry?: number;
        formFields?: boolean;
        modifiedFrom?: string;
        modifiedTo?: string;
        onResponse?: ConnectorRawResponseCallback;
        ownedBy?: string;
        packageId?: number;
        packageName?: string;
        recipientFrom?: string;
        recipientTo?: string;
        sizeFrom?: number;
        sizeTo?: number;
        smartForm?: string;
        sortBy?: string;
        tracingOptions?: OperationTracingOptions;
        xFolder?: string;
        xRecipientDetails?: string;
        xSearchText?: string;
        xSource?: string;
        xTotalRecords?: string;
    }

    Hierarchy (View Summary)

    Index
    abortSignal?: AbortSignalLike

    Signal used to cancel the operation.

    asc?: boolean

    Sorted the resultant records by ascending or descending order

    attachments?: boolean

    Only documents that have attachments

    certifiedDocuments?: boolean

    Only certified signed documents

    documentId?: number

    Document Id

    documentStatuses?: string[]

    Document Type

    documentType?: string

    Document Type like XML, PDF, DOCX etc

    expiry?: number

    Expiry (Days)

    formFields?: boolean

    Only documents that have form fields

    modifiedFrom?: string

    From Modified Date

    modifiedTo?: string

    To Modified Date

    Callback invoked with the complete response before the operation returns or throws.

    ownedBy?: string

    Owned By filter possible values are ME_OTHERS, ME, OTHERS.

    packageId?: number

    Package Id

    packageName?: string

    Package Name

    recipientFrom?: string

    From

    recipientTo?: string

    To

    sizeFrom?: number

    From Size (KB)

    sizeTo?: number

    To Size (KB)

    smartForm?: string

    Smart form name

    sortBy?: string

    Sort the resultant records as per your choice

    tracingOptions?: OperationTracingOptions

    Context used to parent the operation's tracing span.

    xFolder?: string

    Folder name from where the documents are to be fetched. Possible values are INBOX and ARCHIVE.
    Furthermore, recommended value for x-folder parameter is in Base64 encoded format.

    xRecipientDetails?: string

    If "true" is passed recipient details regarding Document Access Duration will be provided along decline information

    xSearchText?: string

    Search text sent in headers for further filtration of the documents. Package id, name and document owner can be searched.
    Furthermore, recommended value for search text parameter is in Base64 encoded format.

    xSource?: string

    This is the identification of the source of the document from where the document is uploaded, e.g. "My App".

    xTotalRecords?: string

    The total number of records found with the provided search criteria.