getDevices abstract method

@Get() Future<Response<AlifResponse<GetDevicesBody>>> getDevices({ @Query() required String token, @Query('device_type') String deviceType = 'rx', @Query('filter_d_name') String? filterDeviceName, @Query('filter_d_description') String? filterDeviceDescription, @Query('filter_d_location') String? filterDeviceLocation, @Query() String sort = 'name', @Query('sort_dir') String sortDirection = 'asc', @Query() String? status, @Query('show_all') String? showAll, @Query('page') int pageNumber = 1, @Query('results_per_page') int resultsPerPage = 1000, @Query('v') int version = 8, @Query() String method = 'get_devices', })

Returns a list of ALIF devices

Implementation

@Get()
Future<Response<AlifResponse<GetDevicesBody>>> getDevices({
  /// Authentication token of a currently logged-in user (active session)
  @Query() required String token,

  /// 'rx' = receivers, 'tx' = transmitters. Default = 'rx'
  @Query('device_type') String deviceType = 'rx',

  /// Device name search string
  @Query('filter_d_name') String? filterDeviceName,

  /// Device description search string
  @Query('filter_d_description') String? filterDeviceDescription,

  /// Device location search string
  @Query('filter_d_location') String? filterDeviceLocation,

  /// Sort results by 'name'/'description'/'location'. Default = 'name'
  @Query() String sort = 'name',

  /// Sort direction for results 'asc'/'desc'. Default = 'asc'
  @Query('sort_dir') String sortDirection = 'asc',

  /// '','outdated_aim_ip','rebooting','offline','outdated_firmware',
  /// 'invalid_backup_firmware','rebooting','upgrading_firmware',
  /// 'backup_mode','unconfigured'
  @Query() String? status,

  /// If set and not blank, shows all receivers,
  /// not just those the logged-in user is permitted to use
  @Query('show_all') String? showAll,

  /// Page number to start showing results for, default = 1
  @Query('page') int pageNumber = 1,

  /// Number of results per page, default = 1000
  @Query('results_per_page') int resultsPerPage = 1000,

  /// The AIM API version this request is designed for
  @Query('v') int version = 8,

  /// The remote procedure to call. Do not edit this
  @Query() String method = 'get_devices',
});