All Implemented Interfaces:: java.io.Closeable , java.lang.AutoCloseable , reactor.core.Disposable


public final class LavalinkClient
 implements Closeable, Disposable

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description
`private final Long`	`userId`
`private final List<LavalinkNode>`	`nodes`
`private final List<Link>`	`links`
`private final Flux<ClientEvent>`	`flux`
`private ILoadBalancer`	`loadBalancer`
`private final Boolean`	`isDisposed`

Constructor Summary

Constructors
Constructor	Description
`LavalinkClient(Long userId)`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final Long`	`getUserId()`
`final List<LavalinkNode>`	`getNodes()`
`final List<Link>`	`getLinks()`
`final Flux<ClientEvent>`	`getFlux()`
`final ILoadBalancer`	`getLoadBalancer()`
`final Unit`	`setLoadBalancer(ILoadBalancer value)`
`final LavalinkNode`	`addNode(NodeOptions nodeOptions)`	Add a node to the client.
`final Boolean`	`removeNode(String name)`	Remove a node by its name.
`final Boolean`	`removeNode(LavalinkNode node)`	Disconnect and remove a node the client.
`final Link`	`getOrCreateLink(Long guildId, VoiceRegion region)`	Get or crate a link between a guild and a node.
`final Link`	`getOrCreateLink(Long guildId)`	Get or crate a link between a guild and a node.
`final Link`	`getLinkIfCached(Long guildId)`	Returns a Link if it exists in the cache.
`final <T extends ClientEvent> Flux<T>`	`on(Class<T> type)`	Listen to events from all nodes.
`final <T extends ClientEvent> Flux<T>`	`on()`	Listen to events from all nodes.
`Unit`	`close()`	Close the client and disconnect all nodes.
`Unit`	`dispose()`

Methods inherited from class reactor.core.Disposable
isDisposed
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - LavalinkClient
```
LavalinkClient(Long userId)
```
    Parameters:
    
    userId - ID of the bot for authenticating with Discord
- Method Detail
  - getUserId
```
 final Long getUserId()
```
  - getNodes
```
 final List<LavalinkNode> getNodes()
```
  - getLinks
```
 final List<Link> getLinks()
```
  - getFlux
```
 final Flux<ClientEvent> getFlux()
```
  - getLoadBalancer
```
 final ILoadBalancer getLoadBalancer()
```
  - setLoadBalancer
```
 final Unit setLoadBalancer(ILoadBalancer value)
```
  - addNode
```
 final LavalinkNode addNode(NodeOptions nodeOptions)
```
    Add a node to the client.
    
    Parameters:
    
    nodeOptions - a populated NodeOptionsObject
  - removeNode
```
 final Boolean removeNode(String name)
```
    Remove a node by its name.
  - removeNode
```
 final Boolean removeNode(LavalinkNode node)
```
    Disconnect and remove a node the client.
  - getOrCreateLink
```
@JvmOverloads() final Link getOrCreateLink(Long guildId, VoiceRegion region)
```
    Get or crate a link between a guild and a node.
    
    Parameters:
    
    guildId - The id of the guild
    
    region - (not currently used) The target voice region of when to select a node
  - getOrCreateLink
```
@JvmOverloads() final Link getOrCreateLink(Long guildId)
```
    Get or crate a link between a guild and a node.
    
    Parameters:
    
    guildId - The id of the guild
  - getLinkIfCached
```
 final Link getLinkIfCached(Long guildId)
```
    Returns a Link if it exists in the cache. If we select a link for voice updates, we don't know the region yet.
  - on
```
 final <T extends ClientEvent> Flux<T> on(Class<T> type)
```
    Listen to events from all nodes. Please note that uncaught exceptions will cause the listener to stop emitting events.
    
    Parameters:
    
    type - the ClientEvent to listen for
    
    Returns:
    
    a Flux of ClientEvents
  - on
```
 final <T extends ClientEvent> Flux<T> on()
```
    Listen to events from all nodes. Please note that uncaught exceptions will cause the listener to stop emitting events.
    
    Returns:
    
    a Flux of ClientEvents
  - close
```
 Unit close()
```
    Close the client and disconnect all nodes.
  - dispose
```
 Unit dispose()
```

Class LavalinkClient

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class reactor.core.Disposable

Methods inherited from class java.lang.Object

Constructor Detail

LavalinkClient

Method Detail

getUserId

getNodes

getLinks

getFlux

getLoadBalancer

setLoadBalancer

addNode

removeNode

removeNode

getOrCreateLink

getOrCreateLink

getLinkIfCached

on

on

close

dispose