Struct ts3::client::Client

pub struct Client { /* fields omitted */ }

A Client used to send commands to the serverquery interface.

Implementations

impl Client

pub async fn new<A: ToSocketAddrs>(addr: A) -> Result<Client>

Create a new connection

pub fn set_event_handler<H: EventHandler + 'static>(&self, handler: H)

pub async fn send<T: Decode<T>>(&self, cmd: String) -> Result<T>

Send a raw command directly to the server. The response will be directly decoded into the type T. To get a HashMap like response, use the RawResp struct.

impl Client

pub async fn apikeyadd(
    &self,
    scope: APIKeyScope,
    lifetime: Option<u64>,
    cldbid: Option<u64>
) -> Result<APIKey>

Creates a new apikey using the specified scope, for the invoking user. The default lifetime of a token is 14 days, a zero lifetime means no expiration. It is possible to create apikeys for other users using b_virtualserver_apikey_manage.

pub async fn apikeydel(&self, id: u64) -> Result<()>

Delete an apikey. Any apikey owned by the current user can always be deleted. Deleting apikeys from another user requires b_virtualserver_apikey_manage.

pub async fn apikeylist(
    &self,
    cldbid: Option<(u64, bool)>,
    start: Option<u64>,
    duration: Option<u64>,
    count: bool
) -> Result<Vec<APIKey>>

Lists all apikeys owned by the user, or of all users using cldbid=(0, true). Usage of cldbid=… requires b_virtualserver_apikey_manage.

pub async fn banadd(
    &self,
    ip: Option<&str>,
    name: Option<&str>,
    uid: Option<&str>,
    mytsid: Option<&str>,
    time: Option<u64>,
    banreason: Option<&str>,
    lastnickname: Option<&str>
) -> Result<()>

Add a new ban rule on the selected virtual server. One of ip, name, uid and mytsid must not be None.

pub async fn gm(&self, msg: &str) -> Result<()>

Sends a text message to all clients on all virtual servers in the TeamSpeak 3 Server instance.

pub async fn login(&self, username: &str, password: &str) -> Result<()>

Authenticate with the given data.

pub async fn logout(&self) -> Result<()>

Deselects the active virtual server and logs out from the server instance.

pub async fn quit(&self) -> Result<()>

Send a quit command, disconnecting the client and closing the TCP connection

pub async fn sendtextmessage(
    &self,
    target: TextMessageTarget,
    msg: &str
) -> Result<()>

pub async fn servergroupaddclient(
    &self,
    sgid: usize,
    cldbid: usize
) -> Result<()>

Adds one or more clients to the server group specified with sgid. Please note that a client cannot be added to default groups or template groups.

pub async fn servergroupdelclient(
    &self,
    sgid: usize,
    cldbid: usize
) -> Result<()>

Removes one or more clients specified with cldbid from the server group specified with sgid.

pub async fn servernotifyregister(
    &self,
    event: ServerNotifyRegister
) -> Result<()>

Registers for a specified category of events on a virtual server to receive notification messages. Depending on the notifications you’ve registered for, the server will send you a message on every event in the view of your ServerQuery client (e.g. clients joining your channel, incoming text messages, server configuration changes, etc). The event source is declared by the event parameter while id can be used to limit the notifications to a specific channel.

pub async fn serverstart(&self, sid: u64) -> Result<()>

Starts the virtual server specified with sid. Depending on your permissions, you’re able to start either your own virtual server only or all virtual servers in the server instance.

pub async fn serverstop(&self, sid: u64) -> Result<()>

Stops the virtual server specified with sid. Depending on your permissions, you’re able to stop either your own virtual server only or all virtual servers in the server instance. The reasonmsg parameter specifies a text message that is sent to the clients before the client disconnects.

pub async fn use_sid(&self, sid: usize) -> Result<()>

Switch to the virtualserver (voice) with the given server id

pub async fn use_port(&self, port: u16) -> Result<()>

Like use_sid but instead use_port uses the voice port to connect to the virtualserver

pub async fn version(&self) -> Result<Version>

Returns information about the server version

pub async fn whoami(&self) -> Result<RawResp>

Returns information about the query client connected

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.