AdderlinkService class abstract
The AIM API provides access for external applications to key routines used within the AIM server
- Annotations
-
- @ChopperApi(baseUrl: "/api")
Constructors
Properties
- client ↔ ChopperClient
-
getter/setter pairinherited
- definitionType → Type
-
Used internally to retrieve the service from
ChopperClient.no setterinherited - hashCode → int
-
The hash code for this object.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
connectChannel(
{required String channelId, required String receiverId, required String token, int version = 5, String method = 'connect_channel'}) → Future< Response< AlifResponse< >Map< >String, dynamic> > - This method connects a receiver to a channel.
-
connectCUsb(
{required String receiverMac, required String transmitterMac, required String token, int version = 6, String method = 'connect_c_usb'}) → Future< Response< AlifResponse< >Map< >String, dynamic> > - This method connects a C-USB LAN network extender receiver to a C-USB LAN network extender transmitter.
-
disconnectChannel(
{required String receiverId, required String token, int force = 0, int version = 6, String method = 'disconnect_channel'}) → Future< Response< AlifResponse< >Map< >String, dynamic> > - This method disconnects a receiver, a number of receivers, or all connected receivers.
-
disconnectCUsb(
{required String mac, required String token, int version = 6, String method = 'disconnect_c_usb'}) → Future< Response< AlifResponse< >Map< >String, dynamic> > - This method disconnects a C-USB LAN network extender receiver.
-
getAllCUsb(
{required String token, int version = 6, String method = 'get_all_c_usb'}) → Future< Response< AlifResponse< >GetAllCUsbBody> > - This method returns a list of the C-USB LAN network extenders.
-
getChannels(
{int? deviceId, String? filterChannelName, String? filterChannelDescription, String? filterChannelLocation, String? filterFavourites, int page = 1, int resultsPerPage = 1000, required String token, int version = 11, String method = 'get_channels'}) → Future< Response< AlifResponse< >GetChannelsBody> > - Returns a list of channels available to the authenticated user, for a specific receiver.
-
getDevices(
{required String token, String deviceType = 'rx', String? filterDeviceName, String? filterDeviceDescription, String? filterDeviceLocation, String sort = 'name', String sortDirection = 'asc', String? status, String? showAll, int pageNumber = 1, int resultsPerPage = 1000, int version = 8, String method = 'get_devices'}) → Future< Response< AlifResponse< >GetDevicesBody> > - Returns a list of ALIF devices
-
login(
{String? username, String? password, int version = 1, String method = 'login'}) → Future< Response< AlifResponse< >LoginBody> > - Requires a valid AIM user's login credentials to be presented in the first request. The API will return an authentication code, which must be passed in all future requests. This authentication code can be re-used until a logout request is made, at which point the authentication code will no longer be valid.
-
logout(
{required String token, int version = 1, String method = 'logout'}) → Future< Response< AlifResponse< >Map< >String, dynamic> > - The authentication token provided by the 'login' method can be used until the 'logout' method is called.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
rebootDevices(
{required String ids, required String token, int version = 7, String method = 'reboot_devices'}) → Future< Response< AlifResponse< >Map< >String, dynamic> > - Sends a reboot command to the specified devices.
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
create(
[ChopperClient? client]) → AdderlinkService - Creates an instance of the Adderlink service with an optionally provided ChopperClient