Subscribe Links¶

interface SubscribeLinksRequest {
  instance: string;
}

interface LinkEvent {
  type: Type;
  linkInfo: LinkInfo;
}

interface LinkInfo {
  instance: string;
  name: string;
  type: string;
  spec: string;
  disabled: boolean;
  status: string;
  dataInCount: string;  // String decimal
  dataOutCount: string;  // String decimal
  detailedStatus: string;

  //if this is a sublink of an aggregated data link, this is the name of the parent
  parentName: string;
}

enum Type {

  // A new link was registered. You also receive this event directly after you subscribe,
  //  for every link that is registered at that time.
  REGISTERED = "REGISTERED",

  // A link was unregistered.
  UNREGISTERED = "UNREGISTERED",

  // A link was updated in one of its attributes, for example the dataCount has increased,
  // or the status has changed.
  UPDATED = "UPDATED",
}