Class NetworkClient

Hierarchy

NetworkClient

Index

Constructors

constructor

Methods

Constructors

constructor

new NetworkClient(_request: IRequest): NetworkClient

- Defined in src/client/index.ts:189
Parameters
- _request: IRequest
Returns NetworkClient

Methods

assign

assign(serverID: string): Promise<IClientAllocations[]>

- Defined in src/client/index.ts:196
Automatically assigns a new allocation if auto-assign is enabled on the instance

Parameters
- serverID: string
  
  Server Identifier
Returns Promise<IClientAllocations[]>

delete

delete(serverID: string, allocationID: number): Promise<boolean>

- Defined in src/client/index.ts:206
Deletes the specified non-primary allocation

Parameters
- serverID: string
  
  Server Identifier
- allocationID: number
Returns Promise<boolean>

getAll

getAll(serverID: string): Promise<IClientAllocations[]>

- Defined in src/client/index.ts:213
Retrieves the allocations information for the specified server

Parameters
- serverID: string
  
  Server Identifier
Returns Promise<IClientAllocations[]>

setNote

setNote(serverID: string, allocationID: number, allocationNotes: string): Promise<any>

- Defined in src/client/index.ts:229
Sets a note for the allocation

Parameters
- serverID: string
  
  Server Identifier
- allocationID: number
  
  Allocation Identifier
- allocationNotes: string
Returns Promise<any>

setPrimary

setPrimary(serverID: string, allocationID: number): Promise<IClientAllocations>

- Defined in src/client/index.ts:221
Sets the primary allocation

Parameters
- serverID: string
  
  Server Identifier
- allocationID: number
  
  Allocation Identifier
Returns Promise<IClientAllocations>

Generated using TypeDoc