All Superinterfaces:: TagProvider

public interface GatewayTagProvider
extends TagProvider

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`void`	`addStructureListener(TagStructureListener listener)`
`default java.util.concurrent.CompletableFuture<Results<NodeDescription>>`	`browseAsync(TagPath tagPath, BrowseFilter filter)`
`default java.util.concurrent.CompletableFuture<java.util.List<QualityCode>>`	`importTagsAsync(TagPath basePath, java.lang.String importText, java.lang.String importType, CollisionPolicy cp)`
`java.util.concurrent.CompletableFuture<java.util.List<QualityCode>>`	`moveTagsAsync(java.util.List<TagPath> tags, TagPath destination, CollisionPolicy collisionPolicy, SecurityContext securityContext)`	Moves the specified tags to the given destination, returning the result quality for each requested move.
`void`	`removeStructureListener(TagStructureListener listener)`
`void`	`setup(TagSubscriptionModel model)`
`void`	`shutdown()`
`void`	`startup()`

Methods inherited from interface com.inductiveautomation.ignition.common.tags.model.TagProvider
browseAsync, browseTagDataSourcesAsync, getDiagnosticsAsync, getName, getPropertiesAsync, getStatusInformation, getTagConfigModelAsync, getTagConfigsAsync, getTagGroupConfigModelAsync, getTagGroupsAsync, importTagsAsync, readAsync, reinitializeTagsAsync, removeTagConfigsAsync, removeTagConfigsAsync, removeTagGroupsAsync, saveTagConfigsAsync, saveTagConfigsAsync, saveTagGroupsAsync, writeAsync

Method Detail

addStructureListener

void addStructureListener(TagStructureListener listener)

removeStructureListener

void removeStructureListener(TagStructureListener listener)

setup

void setup(TagSubscriptionModel model)

startup
```
void startup()
```

shutdown
```
void shutdown()
```

moveTagsAsync

java.util.concurrent.CompletableFuture<java.util.List<QualityCode>> moveTagsAsync(java.util.List<TagPath> tags,
                                                                                  TagPath destination,
                                                                                  CollisionPolicy collisionPolicy,
                                                                                  SecurityContext securityContext)

Moves the specified tags to the given destination, returning the result quality for each requested move. Can be used to rename a single tag if tags.size() is 1 and destination 1) does not exist as a folder and 2) is a single level beneath the same folder as the existing tag. Can also be used to copy tags by sending true for the copy flag. In this case, the original tags will remain unchanged.

browseAsync

default java.util.concurrent.CompletableFuture<Results<NodeDescription>> browseAsync(TagPath tagPath,
                                                                                     BrowseFilter filter)

Specified by:: browseAsync in interface TagProvider

importTagsAsync

default java.util.concurrent.CompletableFuture<java.util.List<QualityCode>> importTagsAsync(TagPath basePath,
                                                                                            java.lang.String importText,
                                                                                            java.lang.String importType,
                                                                                            CollisionPolicy cp)

Specified by:: importTagsAsync in interface TagProvider
Parameters:: basePath - tags will be imported using this location as the base. The provider source must be set.; importText - a String holding the contents of the file to import; importType - The import file type. Use "json", "xml" or "csv". Any other value will return an error.; cp - The collision policy to use. The collision policy will apply to individual tags, which means that some tag imports may succeed, while others may not.

Interface GatewayTagProvider