Session

Session.

Session related objects.

Session

Session(
    client: Client,
    name: str,
    ssl: bool,
    host: str,
    port: int,
    password: str,
    attempts: int,
)

Session.

The base session object.

PARAMETER	DESCRIPTION
client	The ongaku client attached to this session. TYPE: Client
name	The name of the session. TYPE: str
ssl	Whether the server is https or just http. TYPE: bool
host	The host of the lavalink server. TYPE: str
port	The port of the lavalink server. TYPE: int
password	The password of the lavalink server. TYPE: str
attempts	The attempts that the session is allowed to use, before completely shutting down. TYPE: int

client property

client: Client

The client this session is included in.

app property

app: hikari.GatewayBotAware

The application this session is included in.

name property

name: str

The name of the session.

ssl property

ssl: bool

Whether the server uses https or just http.

host property

host: str

The host or domain of the site.

port property

port: int

The port of the server.

password property

password: str

The password for the server.

base_uri property

base_uri: str

The base URI for the server.

auth_headers property

auth_headers: typing.Mapping[str, typing.Any]

The headers required for authorization.

status property

status: session_.SessionStatus

The current status of the session.

session_id property

session_id: str | None

The current session id.

Note

Shows up as none if the current session failed to connect, or has not connected yet.

request async

request(
    method: str,
    path: str,
    return_type: typing.Type[types.RequestT] | None,
    *,
    headers: typing.Mapping[str, typing.Any] = {},
    json: (
        typing.Mapping[str, typing.Any]
        | typing.Sequence[typing.Any]
    ) = {},
    params: typing.Mapping[str, typing.Any] = {},
    ignore_default_headers: bool = False,
    version: bool = True
) -> types.RequestT | None

Request.

Make a http(s) request to the current session

PARAMETER	DESCRIPTION
method	The method to send the request as. GET, POST, PATCH, DELETE, PUT TYPE: str
path	The path to the url. e.g. /v4/info TYPE: str
return_type	The response type you expect. TYPE: typing.Type[types.RequestT] | None
headers	The headers to send. TYPE: typing.Mapping[str, typing.Any] DEFAULT: {}
json	The json data to send. TYPE: typing.Mapping[str, typing.Any] | typing.Sequence[typing.Any] DEFAULT: {}
params	The parameters to send. TYPE: typing.Mapping[str, typing.Any] DEFAULT: {}
ignore_default_headers	Whether to ignore the default headers or not. TYPE: bool DEFAULT: False
version	Whether or not to include the version in the path. TYPE: bool DEFAULT: True

RETURNS	DESCRIPTION
types.RequestT | None	Your requested type of data.

RAISES	DESCRIPTION
TimeoutError	Raised when the request takes too long to respond.
RestEmptyError	Raised when the request required a return type, but received nothing, or a 204 response.
RestStatusError	Raised when a 4XX or a 5XX status is received.
BuildError	Raised when the mapping or sequence could not be built.
RestRequestError	Raised when a 4XX or a 5XX status is received, and lavalink gives more information.
RestError	Raised when an unknown error is caught.

transfer async

transfer(session_handler: handler_.SessionHandler) -> None

Transfer.

Transfer all the players from this session, to a different one.

Warning

This will close the current sessions connection.

PARAMETER	DESCRIPTION
session_handler	The session handler, that will allow this session to move its players too. TYPE: handler_.SessionHandler

start async

start() -> None

Start the session.

Starts up the session, to receive events.

stop async

stop() -> None

Stop the session.

Stops the current session, if it is running.