PteroApplication class abstract

Pterodactyl Application API Client

Annotations

• @RestApi()

Constructors

PteroApplication(Dio dio, {String? baseUrl})

factory

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

createNode({CancelToken? cancelToken, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress, required CreateNodeRequest request}) → Future<FractalDataMeta<Node, ResourceMeta>>

createUser({CancelToken? cancelToken, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress, required CreateUserRequest request}) → Future<FractalData<ApplicationUser>>

deleteNode({CancelToken? cancelToken, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress, required int id}) → Future<void>

deleteUser({CancelToken? cancelToken, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress, required int id}) → Future<void>

getNode({CancelToken? cancelToken, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress, required int id, NodeIncludes? include}) → Future<FractalData<Node>>

getNodeAllocations({CancelToken? cancelToken, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress, required int id, AllocationIncludes? include, int? page, int? perPage, String? filterAll, String? filterByIp, int? filterByPort, String? filterByServerId}) → Future<FractalListMeta<ApplicationAllocation, PaginatedMeta>>

getNodes({CancelToken? cancelToken, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress, NodeIncludes? include, NodesSort? sort, int? page, int? perPage, String? filterAll, String? filterByUuid, String? filterByName, String? filterByFqdn, String? filterByDaemonTokenId}) → Future<FractalListMeta<Node, PaginatedMeta>>

getUser({CancelToken? cancelToken, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress, required int id, ApplicationUsersIncludes? include}) → Future<FractalData<ApplicationUser>>

getUserByExternalId({CancelToken? cancelToken, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress, required String externalId, ApplicationUsersIncludes? include}) → Future<FractalData<ApplicationUser>>

getUsers({CancelToken? cancelToken, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress, ApplicationUsersIncludes? include, UsersSort? sort, int? page, int? perPage, String? filterAll, String? filterEmail, String? filterUuid, String? filterUsername, String? filterExternalId}) → Future<FractalListMeta<ApplicationUser, PaginatedMeta>>

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

updateNode({CancelToken? cancelToken, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress, required int id, required UpdateNodeRequest request}) → Future<FractalDataMeta<Node, ResourceMeta>>

updateUser({CancelToken? cancelToken, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress, required int id, required UpdateUserRequest request}) → Future<FractalData<ApplicationUser>>

Operators

operator ==(Object other) → bool

The equality operator.

inherited