Package com.inductiveautomation.ignition.common.tags.model

Interface TagProvider

    • Method Detail

      • getTagConfigsAsync

        java.util.concurrent.CompletableFuture<java.util.List<TagConfigurationModel>> getTagConfigsAsync​(java.util.List<TagPath> tagPaths,
                                                                                                 boolean recursive,
                                                                                                 boolean localPropsOnly)
        Parameters:
        tagPaths - a List of TagPath objects
        recursive - set to true to return all TagConfigurationModels under a TagPath. Useful for returning models for child tags under a UDT.
        localPropsOnly - set to True to only return configuration created by a user (aka no inherited properties). Useful for tag export and tag UI edits of raw JSON text.
        Returns:
        a list of TagConfigurationModels, one for each passed tagPath.

      • removeTagConfigsAsync

        java.util.concurrent.CompletableFuture<java.util.List<QualityCode>> removeTagConfigsAsync​(java.util.List<TagPath> tagPaths,
                                                                                          SecurityContext securityContext)

      • removeTagConfigsAsync

        default java.util.concurrent.CompletableFuture<java.util.List<QualityCode>> removeTagConfigsAsync​(java.util.List<TagPath> tagPaths)

      • getTagGroupsAsync

        java.util.concurrent.CompletableFuture<java.util.List<TagGroupConfiguration>> getTagGroupsAsync()

      • saveTagGroupsAsync

        java.util.concurrent.CompletableFuture<java.util.List<QualityCode>> saveTagGroupsAsync​(java.util.List<TagGroupConfiguration> tagGroups)

      • removeTagGroupsAsync

        java.util.concurrent.CompletableFuture<java.util.List<QualityCode>> removeTagGroupsAsync​(java.util.List<java.lang.String> tagGroupNames)

      • getPropertiesAsync

        java.util.concurrent.CompletableFuture<TagProviderProps> getPropertiesAsync()

      • getDiagnosticsAsync

        java.util.concurrent.CompletableFuture<TagDiagnostics> getDiagnosticsAsync​(TagPath path)

      • importTagsAsync

        java.util.concurrent.CompletableFuture<java.util.List<QualityCode>> importTagsAsync​(TagPath basePath,
                                                                                    java.lang.String importText,
                                                                                    java.lang.String importType,
                                                                                    CollisionPolicy cp)
        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.

      • getName

        java.lang.String getName()
        Returns:
        the name of the tag provider

      • reinitializeTagsAsync

        default java.util.concurrent.CompletableFuture<java.util.List<QualityCode>> reinitializeTagsAsync​(java.util.List<TagPath> paths)