Class Subscription

constructor

• new Subscription(api: TAKAPI): Subscription

  Parameters

  • api: TAKAPI

  Returns Subscription

schema

cli

• cli(): Promise<string | object>

  Returns Promise<string | object>

list

• list(
      query: {
          direction: string;
          limit: number;
          page: number;
          sortBy: string;
      },
  ): Promise<
      {
          data: {
              appFramerate: string;
              battery: string;
              batteryStatus: string;
              batteryTemp: string;
              callsign: string;
              clientUid: string;
              deviceDataRx: string;
              deviceDataTx: string;
              deviceIPAddress: string;
              dn: string
              | null;
              groups: {
                  active: boolean;
                  bitpos: number;
                  created: string;
                  description?: string;
                  direction: string;
                  name: string;
                  type: string;
              }[];
              handlerType: string;
              heapCurrentSize: string;
              heapFreeSize: string;
              heapMaxSize: string;
              incognito: boolean;
              ipAddress: string;
              lastReportDiffMilliseconds: number;
              lastReportMilliseconds: number;
              numProcessed: number;
              pendingWrites: number;
              port: string;
              protocol: string;
              role: string;
              storageAvailable: string;
              storageTotal: string;
              subscriptionUid: string;
              takClient: string;
              takVersion: string;
              team: string;
              username: string;
              xpath: string
              | null;
          }[];
          messages?: string[];
          nodeId?: string;
          type: string;
          version: string;
      },
  >

  Parameters

  • query: { direction: string; limit: number; page: number; sortBy: string }

  Returns Promise<
      {
          data: {
              appFramerate: string;
              battery: string;
              batteryStatus: string;
              batteryTemp: string;
              callsign: string;
              clientUid: string;
              deviceDataRx: string;
              deviceDataTx: string;
              deviceIPAddress: string;
              dn: string
              | null;
              groups: {
                  active: boolean;
                  bitpos: number;
                  created: string;
                  description?: string;
                  direction: string;
                  name: string;
                  type: string;
              }[];
              handlerType: string;
              heapCurrentSize: string;
              heapFreeSize: string;
              heapMaxSize: string;
              incognito: boolean;
              ipAddress: string;
              lastReportDiffMilliseconds: number;
              lastReportMilliseconds: number;
              numProcessed: number;
              pendingWrites: number;
              port: string;
              protocol: string;
              role: string;
              storageAvailable: string;
              storageTotal: string;
              subscriptionUid: string;
              takClient: string;
              takVersion: string;
              team: string;
              username: string;
              xpath: string
              | null;
          }[];
          messages?: string[];
          nodeId?: string;
          type: string;
          version: string;
      },
  >