Class NetworkManager

Hierarchy

NetworkManager

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new NetworkManager(client: PteroClient, serverId: string): NetworkManager

- Defined in src/client/NetworkManager.ts:12
Parameters
- client: PteroClient
- serverId: string
Returns NetworkManager

Properties

cache

cache: Dict<number, NetworkAllocation>

client

client: PteroClient

serverId

serverId: string

Methods

_patch

_patch(data: any): any

- Defined in src/client/NetworkManager.ts:23
Transforms the raw allocation object(s) into typed objects.

Parameters
- data: any
  
  The resolvable allocation object(s).
Returns any
The resolved allocation object(s).

fetch

fetch(): Promise<Dict<number, NetworkAllocation>>

- Defined in src/client/NetworkManager.ts:52
Fetches the network allocations on the server.
example
```
const server = await client.servers.fetch('1c639a86');
await server.network.fetch()
 .then(console.log)
 .catch(console.error);
```
Returns Promise<Dict<number, NetworkAllocation>>
The fetched network allocations.

setNote

setNote(id: number, notes: string): Promise<NetworkAllocation>

- Defined in src/client/NetworkManager.ts:72
Sets the notes of a specified network allocation.
example
```
const server = await client.servers.fetch('1c639a86');
await server.network.setNote(14, 'bungee')
 .then(console.log)
 .catch(console.error);
```
Parameters
- id: number
  
  The ID of the network allocation.
- notes: string
  
  The notes to set.
Returns Promise<NetworkAllocation>
The updated network allocation.

setPrimary

setPrimary(id: number): Promise<NetworkAllocation>

- Defined in src/client/NetworkManager.ts:92
Sets the primary allocation of the server.
example
```
const server = await client.servers.fetch('1c639a86');
await server.network.setPrimary(14)
 .then(console.log)
 .catch(console.error);
```
Parameters
- id: number
  
  The ID of the network allocation.
Returns Promise<NetworkAllocation>
The updated network allocation.

unassign

unassign(id: number): Promise<void>

- Defined in src/client/NetworkManager.ts:108
Unassigns the specified network allocation form the server.
example
```
const server = await client.servers.fetch('1c639a86');
await server.network.unassign(12).catch(console.error);
```
Parameters
- id: number
  
  The ID of the network allocation.
Returns Promise<void>

Generated using TypeDoc