Package com.inductiveautomation.ignition.gateway.model.entity

Interface DescriptionComponent

public interface DescriptionComponent
Data component that can be attached to an Entity to provide a human-readable description of the entity and any attached metadata.

  • Method Summary

    Modifier and Type
    Method
    Description
    Optional<String>
    getDescription()
     
    Map<String,com.inductiveautomation.ignition.common.gson.JsonElement>
    getDetails()
    String pair map of additional descriptive details associated with this entity.
    Optional<String>
    getIconUrl()
    URL of a small icon that represents this kind of entity.

  • Method Details

    • getDescription

      Optional<String> getDescription()
      Returns:
      a human-readable description of this entity.

    • getIconUrl

      Optional<String> getIconUrl()
      URL of a small icon that represents this kind of entity.

    • getDetails

      Map<String,com.inductiveautomation.ignition.common.gson.JsonElement> getDetails()
      String pair map of additional descriptive details associated with this entity.