Class Action

Implements

Constructors

constructor

Methods

destroy getFilePath getType getTypeName setDest setFilePath create

Constructors

constructor

  • new Action(options?: Options): Action

    Parameters

    • Optionaloptions: Options

      No longer use 'new' to create, but use create instead

    Returns Action

    Example

    const action = await Action.create();

Methods

destroy

getFilePath

  • getFilePath(): Promise<string>

    Gets the file full path of the PDF Action.

    Returns Promise<string>

    • The file full path of the PDF Action

getType

  • getType(): Promise<number>

    Gets the type of the action.

    Returns Promise<number>

    • The type of the action.

getTypeName

  • getTypeName(): Promise<string>

    Gets the type name of the PDF action.

    Returns Promise<string>

    The type name of the PDF action

setDest

  • setDest(dest: DestType): Promise<void>

    Sets the destination of PDF action.

    Parameters

    • dest: DestType

      Refer to a PDF destination

    Returns Promise<void>

setFilePath

  • setFilePath(filePath: string, isURL: boolean): Promise<void>

    Sets the file full path.

    Parameters

    • filePath: string

      The input file full path.

    • isURL: boolean

      Whether the file path is a URL or not.

    Returns Promise<void>

Staticcreate

  • create(options?: Options): Promise<ActionType>

    Creates a PDF action.

    Parameters

    • Optionaloptions: Options

      The required configuration options, including necessary initialization information.

    Returns Promise<ActionType>

    • a PDF action

    Example

    // If `dict` is provided, the action is created based on the PDF dictionary.
    {
        dict: pdfDictionary
    }

    Example

    // If `doc` and `actionType` (both must be provided) are passed, the action is created based on `actionType`.
    {
        doc: doc,
        actionType: Enum.FPD_ActionType
    }

Settings

Member Visibility

On This Page

Constructors
Methods