DeviceApi class

Constructors

DeviceApi(Dio _dio, Serializers _serializers)

const

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

createDevice({CreateOrUpdateDeviceRequest? createOrUpdateDeviceRequest, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<Device>>

Create new device Create new device

createDeviceAvdertisedRoute({required String deviceID, AdvertisedRoute? advertisedRoute, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<AdvertisedRoute>>

Create new device advertised routes Create new device avdertised route

createDevicePortForwarding({required String deviceID, CreateOrUpdatePortForwardingRequest? createOrUpdatePortForwardingRequest, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<PortForwarding>>

Create new device port forwarding Create new device port forwarding

deleteDevice({required String deviceID, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<void>>

Delete Device Delete device by id

deleteDevicePortForwarding({required String deviceID, required String portForwardingID, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<void>>

Delete Device's Port Forwarding Delete device's port forwarding by id

getDevice({required String deviceID, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<Device>>

Device Info Retrieve device info

getDeviceStats({required String deviceID, required String statsID, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<DeviceStats>>

Device's stats detail

getDeviceWireGuard({required String deviceID, required String wireGuardID, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<WireGuard>>

Device's wireguard profile detail

getWireGuardConf({required String deviceID, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<String>>

Wireguard conf Wireguard conf as plain text

listDeviceAdvertisedRoutes({required String deviceID, int? perPage, int? page, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<BuiltList<AdvertisedRoute>>>

Device advertised routes List Retrieve device's advertised routes list

listDeviceBindings({required String deviceID, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<BuiltList<String>>>

Device bindings Each device has bindings to specific servers. This methods returns hostnames where this device binded in a particular time.

listDeviceConnectionModes({required String deviceID, String? xAndroidPackage, String? xAndroidSHA1, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<BuiltList<ConnectionMode>>>

Device connection modes This methods returns list of connection modes are availbale for current device.

listDeviceDetailStats({required String deviceID, String? dateTimeAfter, String? dateTimeBefore, int? perPage, int? page, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<BuiltList<DeviceStats>>>

Device's detail stats list

listDevicePortForwardings({required String deviceID, int? perPage, int? page, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<BuiltList<PortForwarding>>>

Device Port Forwarding List Retrieve device's port forwarding lis

listDevices({String? q, String? externalKey, bool? recentlyActive, DateTime? lastActiveAtAfter, DateTime? lastActiveAtBefore, String? sort, int? perPage, int? page, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<BuiltList<Device>>>

Device List Retrieve devices list

listDeviceStats({required String deviceID, Date? dateAfter, Date? dateBefore, int? perPage, int? page, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<BuiltList<DeviceStats>>>

Device's stats list

listDeviceWireGuardPeers({required String deviceID, required String wireGuardID, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<BuiltList<WireGuardPeer>>>

Device's wireguard peers

listDeviceWireGuards({required String deviceID, int? perPage, int? page, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<BuiltList<WireGuard>>>

Device's wireguard profiles list

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

updateDevice({required String deviceID, required CreateOrUpdateDeviceRequest createOrUpdateDeviceRequest, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<Device>>

Update device properties Update device properties

updateDevicePortForwarding({required String deviceID, required String portForwardingID, required CreateOrUpdatePortForwardingRequest createOrUpdatePortForwardingRequest, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<PortForwarding>>

Update device's port forwarding Update device's port forwarding dst_port

Operators

operator ==(Object other) → bool

The equality operator.

inherited