Class AssignmentsResource

Net assignment operations (assign, unassign, bulk, temporary).

Index

Constructors

Methods

assign bulk list temporary unassign

Constructors

constructor

new AssignmentsResource(http: BaseClient): AssignmentsResource
Parameters
- http: BaseClient
Returns AssignmentsResource
- Defined in src/resources/assignments.ts:17

Methods

assign

assign(userId: string, netId: number): Promise<ShardAssignmentResult>
Assigns a user to a net.
Parameters
- userId: string
  Discord user ID of the operator.
- netId: number
  Numeric net identifier.
Returns Promise<ShardAssignmentResult>
- Defined in src/resources/assignments.ts:31

bulk

bulk(assignments: AssignmentAction[]): Promise<ShardBulkAssignmentResult>
Assigns or unassigns multiple users in a single request.
Parameters
- assignments: AssignmentAction[]
Returns Promise<ShardBulkAssignmentResult>
- Defined in src/resources/assignments.ts:47

list

list(): Promise<ShardAssignmentsResponse>
Fetches all current net assignments (user → net mappings).

Returns Promise<ShardAssignmentsResponse>
- Defined in src/resources/assignments.ts:22

temporary

temporary(
    userId: string,
    netId: number,
    ttlMs?: number,
): Promise<TemporaryAssignmentResult>
Creates a temporary net assignment that auto-expires.
Parameters
- userId: string
  Discord user ID of the operator.
- netId: number
  Numeric net identifier.
- OptionalttlMs: number
  Time-to-live in milliseconds (min 15s, max 24h). Defaults to 5 minutes.
Returns Promise<TemporaryAssignmentResult>
- Defined in src/resources/assignments.ts:58

unassign

unassign(userId: string, netId: number): Promise<ShardAssignmentResult>
Unassigns a user from a net.
Parameters
- userId: string
  Discord user ID of the operator.
- netId: number
  Numeric net identifier.
Returns Promise<ShardAssignmentResult>
- Defined in src/resources/assignments.ts:41