Members
(static, constant) SupportedSourceFormat
- Description:
Supported source file formats for InsertPagesOperation.
Properties:
Name | Type | Description |
---|---|---|
pdf |
string | Represents "application/pdf" media type |
Supported source file formats for InsertPagesOperation.
Methods
(static) createNew() → {InsertPagesOperation}
- Description:
Constructs a InsertPagesOperation instance.
Returns:
A new InsertPagesOperation instance.
- Type
- InsertPagesOperation
setBaseInput(baseSourceFileRefnon-null)
- Description:
Sets a base input file.
Parameters:
Name | Type | Description |
---|---|---|
baseSourceFileRef |
FileRef | The base input file. |
addPagesToInsertAt(basePagenon-null, inputFilenon-null, pageRangesopt)
- Description:
Adds the pages of the input PDF file to be inserted at the specified page of the base PDF file.
This method can be invoked multiple times with the same or different input PDF files.
If
pageRanges
is not provided, all the pages of the input PDF file will be inserted at the specified page of the base PDF file.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
basePage |
Number | Page of the base PDF file. |
|
inputFile |
FileRef | A PDF file for insertion. |
|
pageRanges |
PageRanges |
<optional> |
Page ranges of the input PDF file; defaults to all the pages. |
execute(contextnon-null) → {Promise.<FileRef>}
- Description:
Executes this operation using the supplied context and returns a Promise which resolves to the operation result.
The resulting file may be stored in the system temporary directory (per the os.tempdir(), symlinks are resolved to the actual path). See FileRef for how temporary resources are cleaned up.
Parameters:
Name | Type | Description |
---|---|---|
context |
ExecutionContext | The context in which the operation will be executed. |
Throws:
-
-
if an API call results in an error response.
- Type
- ServiceApiError
-
-
-
if service usage limits have been reached or credentials quota has been exhausted.
- Type
- ServiceUsageError
-
Returns:
A promise which resolves to the operation result.
- Type
- Promise.<FileRef>