getChannels abstract method

@Get() Future<Response<AlifResponse<GetChannelsBody>>> getChannels({ @Query('device_id') int? deviceId, @Query('filter_c_name') String? filterChannelName, @Query('filter_c_description') String? filterChannelDescription, @Query('filter_c_location') String? filterChannelLocation, @Query('filter_favourites') String? filterFavourites, @Query() int page = 1, @Query('results_per_page') int resultsPerPage = 1000, @Query() required String token, @Query('v') int version = 11, @Query() String method = 'get_channels', })

Returns a list of channels available to the authenticated user, for a specific receiver.

Implementation

@Get()
Future<Response<AlifResponse<GetChannelsBody>>> getChannels({
  /// ID of the receiver that this channel will be connected to.
  /// Recommended to ensure full checks for connection mode availability.
  @Query('device_id') int? deviceId,

  /// channel name search string
  @Query('filter_c_name') String? filterChannelName,

  /// channel description search string
  @Query('filter_c_description') String? filterChannelDescription,

  /// channel location search string
  @Query('filter_c_location') String? filterChannelLocation,

  /// set this non-empty to only show a user's favourites
  @Query('filter_favourites') String? filterFavourites,

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

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

  /// Authentication token of a currently logged-in user (active session)
  @Query() required String token,

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

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