Struct trovo::Client

pub struct Client<A> { /* private fields */ }

Entrypoint for making requests to the Trovo api.

Implementations

impl<A> Client<A> where
    A: ClientIdProvider, 

pub async fn chat_token_for_channel(
    &self,
    channel_id: impl AsRef<str>
) -> Result<ChatToken, RequestError>

Get a chat token for the provided channel id

pub async fn chat_messages_for_channel(
    &self,
    channel_id: impl AsRef<str>
) -> Result<ChatMessageStream, ChatMessagesForChannelError>

Connect to the given channel id and receive a stream of messages.

impl<A> Client<A> where
    A: AccessTokenProvider, 

pub async fn chat_token_for_user(
    &self
) -> Result<ChatToken, AuthenticatedRequestError<A::Error>>

Get a chat token for the authenticated user’s channel

pub async fn chat_messages_for_user(
    &self
) -> Result<ChatMessageStream, ChatMessagesForUserError<A::Error>>

Connect to the authenticated user’s channel and receive a stream of messages.

pub async fn send_chat_message(
    &self,
    channel_id: Option<String>,
    message: impl Into<String>
) -> Result<(), AuthenticatedRequestError<A::Error>>

Send a chat message to a channel

Scopes

Sending to your own channel

Requires chat_send_self

Sending to other channels

To send a message as sender (user A) to channel (owned by user B), the application needs to get scopes chat_send_self of user A, and send_to_my_channel of user B.

impl<A> Client<A>

pub fn new(auth_provider: A) -> Self

Creates a new default trovo client. If you are already using reqwest in your program, it is advisable to use Client::from_reqwest instead to allow for connection pool sharing.

Panics

This method panics if a TLS backend cannot be initialized, or the resolver cannot load the system configuration.

pub fn from_reqwest(http: Client, auth_provider: A) -> Self

Creates a new trovo client using the provided reqwest client.

This can be useful to allow sharing of a reqwest client’s connection pool across your program

impl<A> Client<A> where
    A: ClientIdProvider, 

pub async fn users(
    &self,
    usernames: Vec<String>
) -> Result<Vec<User>, RequestError>

Gets a list of user’s channel id, user id, and nickname, by usernames.

Note: Even if just one of the usernames doesn’t exist, the result will be an empty vec due to api limitations.

pub async fn user(
    &self,
    username: impl Into<String>
) -> Result<Option<User>, RequestError>

Gets a user’s channel id, user id, and nickname, by username.

Returns None if the user was not found

pub async fn channel_by_id(
    &self,
    channel_id: impl Into<String>
) -> Result<Option<ChannelInfo>, RequestError>

Gets channel information for the given id

Returns None if the channel was not found

pub async fn emotes(
    &self,
    emote_type: EmoteFetchType,
    channel_ids: Vec<String>
) -> Result<EmoteChannels, RequestError>

Gets list of emotes for each channel and global/event emotes if requested.

impl<A> Client<A> where
    A: AccessTokenProvider, 

pub async fn update_channel(
    &self,
    channel_id: impl Into<String>,
    update: ChannelUpdate
) -> Result<(), AuthenticatedRequestError<A::Error>>

Allows you to update the user’s channel settings, including title, category, language, audience type. You may update only part of the info.

Trait Implementations

impl<A: Clone> Clone for Client<A>

fn clone(&self) -> Client<A>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<A: Debug> Debug for Client<A>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.