Struct ts3plugin::TsApi

pub struct TsApi { /* fields omitted */ }

The main struct that contains all permanently save data.

Methods

impl TsApi

fn static_log_message<S1: AsRef<str>, S2: AsRef<str>>(
    message: S1,
    channel: S2,
    severity: LogLevel
) -> Result<(), Error>

Please try to use the member method log_message instead of this static method.

fn static_log_or_print<S1: AsRef<str>, S2: AsRef<str>>(
    message: S1,
    channel: S2,
    severity: LogLevel
)

Please try to use the member method log_or_print instead of this static method.

fn static_get_error_message(error: Error) -> Result<String, Error>

Please try to use the member method get_error_message instead of this static method.

unsafe fn get_raw_api(&self) -> &Ts3Functions

Get the raw TeamSpeak api functions. These functions can be used to invoke actions that are not yet implemented by this library. You should file a bug report or make a pull request if you need to use this function.

fn get_plugin_id(&self) -> &str

Get the plugin id assigned by TeamSpeak.

fn get_server_ids(&self) -> Vec<ServerId>

Get all server ids to which this client is currently connected.

fn log_message<S1: AsRef<str>, S2: AsRef<str>>(
    &self,
    message: S1,
    channel: S2,
    severity: LogLevel
) -> Result<(), Error>

Log a message using the TeamSpeak logging API.

fn log_or_print<S1: AsRef<str>, S2: AsRef<str>>(
    &self,
    message: S1,
    channel: S2,
    severity: LogLevel
)

Log a message using the TeamSpeak logging API. If that fails, print the message to stdout.

fn get_server(&self, server_id: ServerId) -> Option<&Server>

Get the server that has the specified id, returns None if there is no such server.

fn get_mut_server(&mut self, server_id: ServerId) -> Option<&mut Server>

Get the mutable server that has the specified id, returns None if there is no such server.

fn print_message<S: AsRef<str>>(&self, message: S)

Print a message to the currently selected tab. This is only visible in the window of this client and will not be sent to the server.

fn get_app_path(&self) -> String

Get the application path of the TeamSpeak executable.

fn get_resources_path(&self) -> String

Get the resource path of TeamSpeak.

fn get_config_path(&self) -> String

Get the path, where configuration files are stored. This is e.g. ~/.ts3client on linux or %AppData%/TS3Client on Windows.

fn get_plugin_path(&self) -> String

Get the path where TeamSpeak plugins are stored.