Package com.inductiveautomation.ignition.gateway.tags.model

Interface GatewayTagProvider

All Superinterfaces:

TagProvider

public interface GatewayTagProvider
extends TagProvider

Method Summary

Modifier and Type	Method	Description
void	addStructureListener(TagStructureListener listener)
default CompletableFuture<Results<NodeDescription>>	browseAsync(TagPath tagPath, BrowseFilter filter)
CompletableFuture<QualityCode>	deleteAllTagReferences()
CompletableFuture<QualityCode>	deleteTagReferences(TagPath path, Long afterTime, Long beforeTime)
CompletableFuture<List<com.inductiveautomation.ignition.common.tags.config.model.TagReference>>	getTagReferences(com.inductiveautomation.ignition.common.tags.config.model.TagReferenceQuery query)
default CompletableFuture<List<QualityCode>>	importTagsAsync(TagPath basePath, String importText, String importType, CollisionPolicy cp)
CompletableFuture<List<QualityCode>>	moveTagsAsync(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.
CompletableFuture<Results<NodeDescription>>	queryAsync(TagQueryFilter filter, SecurityContext securityContext)
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, removeTagGroupsAsync, saveTagConfigsAsync, saveTagConfigsAsync, saveTagGroupsAsync, saveTagGroupsAsync, writeAsync

Method Details

addStructureListener

void addStructureListener(TagStructureListener listener)

removeStructureListener

void removeStructureListener(TagStructureListener listener)

setup

void setup(TagSubscriptionModel model)

startup

void startup()

shutdown

void shutdown()

moveTagsAsync

CompletableFuture<List<QualityCode>> moveTagsAsync(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 CompletableFuture<Results<NodeDescription>> browseAsync(TagPath tagPath,
 BrowseFilter filter)

Specified by:

browseAsync in interface TagProvider

importTagsAsync

default CompletableFuture<List<QualityCode>> importTagsAsync(TagPath basePath,
 String importText,
 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.

queryAsync

CompletableFuture<Results<NodeDescription>> queryAsync(TagQueryFilter filter,
 SecurityContext securityContext)

getTagReferences

CompletableFuture<List<com.inductiveautomation.ignition.common.tags.config.model.TagReference>> getTagReferences(com.inductiveautomation.ignition.common.tags.config.model.TagReferenceQuery query)

deleteTagReferences

CompletableFuture<QualityCode> deleteTagReferences(TagPath path,
 Long afterTime,
 Long beforeTime)

deleteAllTagReferences

CompletableFuture<QualityCode> deleteAllTagReferences()