The <addSnapshot> element is a child of the <capture> element and denotes that an external snapshot block should be executed and its contents added to this snapshot.
Using an <addSnapshot> step is semantically equivalent to adding the prepare steps of the called snapshot to the end of the calling snapshot"s prepare block, adding the cleanup steps of the called snapshot to the start of the calling snapshot"s cleanup block, and adding the capture steps of the called snapshot to the calling snapshot"s capture block in place of the <addSnapshot> step. Accordingly, care should be taken that the files referenced by the called and calling snapshot blocks do not conflict.
Any number of <addSnapshot> steps may appear within a <capture> element, and the called snapshot may itself contain any number of <addSnapshot> steps within its <capture> element.
When files are added to a snapshot indirectly using <addSnapshot> callouts, the topmost component that initiated the snapshot capture is considered the owner of the files, as opposed to the component that contained the <addFile> directive. Similarly, when a diff is performed on a snapshot, only diff ignore directives of the topmost component that initiated the snapshot are considered. Diff ignore directives contained on components visited as a result of <addSnapshot> callouts are not considered.
Name |
Type |
Required |
Configurable |
Description |
---|---|---|---|---|
blockName |
String |
Yes |
No |
The name of the external snapshot block to execute. |
Name |
How Many? |
Description |
argList |
0 or 1 |
A list of arguments to pass to the snapshot block. |
installed component targeter |
0 or 1 |
Identifies the component containing the snapshot block. If unspecified, <thisComponent> is used. |