Class NetsResource

Voice net management (create, rename, remove).

Index

Constructors

Methods

create list remove removeByRef rename

Constructors

constructor

new NetsResource(http: BaseClient): NetsResource
Parameters
- http: BaseClient
Returns NetsResource
- Defined in src/resources/nets.ts:16

Methods

create

create(name: string): Promise<NetCreateResponse>
Creates a new voice net on the shard.
Parameters
- name: string
  Display name for the net.
Returns Promise<NetCreateResponse>
- Defined in src/resources/nets.ts:33

list

list(): Promise<ShardNetStatus[]>
Lists all configured nets with live occupancy and relay info. Fetches the full shard status and returns the nets array.

Returns Promise<ShardNetStatus[]>
- Defined in src/resources/nets.ts:24

remove

remove(netId: number, netUid?: string): Promise<NetRemoveResponse>
Removes a net by numeric ID.
Parameters
- netId: number
  Numeric net identifier.
- OptionalnetUid: string
  Net UID (alternative to netId).
Returns Promise<NetRemoveResponse>
- Defined in src/resources/nets.ts:56

removeByRef

removeByRef(ref: string): Promise<NetRemoveResponse>
Removes a net by its UID or string reference.
Parameters
- ref: string
  Net UID (e.g., "net_abc123") or numeric ID as string.
Returns Promise<NetRemoveResponse>
- Defined in src/resources/nets.ts:67

rename

rename(netId: number, name: string, netUid?: string): Promise<NetRenameResponse>
Renames an existing net.
Parameters
- netId: number
  Numeric net identifier.
- name: string
  New display name.
- OptionalnetUid: string
  Net UID (alternative to netId).
Returns Promise<NetRenameResponse>
- Defined in src/resources/nets.ts:43