Members
(static, constant) SupportedSourceFormat
- Description:
Supported source file formats for ReplacePagesOperation.
Properties:
Name | Type | Description |
---|---|---|
pdf |
string | Represents "application/pdf" media type |
Supported source file formats for ReplacePagesOperation.
Methods
(static) createNew() → {ReplacePagesOperation}
- Description:
Constructs a ReplacePagesOperation instance.
Returns:
A new ReplacePagesOperation instance.
setBaseInput(baseSourceFileRefnon-null)
- Description:
Sets a base input file.
Parameters:
Name | Type | Description |
---|---|---|
baseSourceFileRef |
FileRef | The base input file. |
addPagesForReplace(basePageToReplacenon-null, inputFilenon-null, pageRangesopt)
- Description:
Adds the pages of the input PDF file for replacing the 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, the specified page of the base PDF file will be replaced by all the pages of the input PDF file.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
basePageToReplace |
Number | Page of base PDF file. |
|
inputFile |
FileRef | A PDF file to be replaced with. |
|
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>