Struct roboat::Client

source ·

pub struct Client { /* private fields */ }

Expand description

A client used for making requests to the Roblox API.

The client stores the roblosecurity cookie, X-CSRF-TOKEN header, and an HTTPS client to send web requests. The client also caches the user id, username, and display name of the user.

Constructed using a ClientBuilder.

Construction Examples

Without Roblosecurity or a Custom Reqwest Client

use roboat::ClientBuilder;

let client = ClientBuilder::new().build();

With a Roblosecurity

use roboat::ClientBuilder;

const ROBLOSECURITY: &str = "roblosecurity";

let client = ClientBuilder::new().roblosecurity(ROBLOSECURITY.to_string()).build();

With a Custom Reqwest Client

use roboat::ClientBuilder;

let reqwest_client = reqwest::Client::new();
let client = ClientBuilder::new().reqwest_client(reqwest_client).build();

With a Roblosecurity and a Custom Reqwest Client

use roboat::ClientBuilder;

const ROBLOSECURITY: &str = "roblosecurity";

let reqwest_client = reqwest::Client::new();
let client = ClientBuilder::new().roblosecurity(ROBLOSECURITY.to_string()).reqwest_client(reqwest_client).build();

Standard Errors

The errors that can be returned by any of Client’s methods are:

Auth Required Errors

The errors that can be returned by any of Client’s methods that require authentication are:

X-CSRF-TOKEN Required Errors

The errors that can be returned by any of Client’s methods that require the X-CSRF-TOKEN header are:

2-Factor Authentication / Captcha Required Errors

The errors that can be returned by any of Client’s methods that require 2-factor authentication or a captcha are:

Implementations§

source §

Grabs details of one or more non-tradable limiteds from https://apis.roblox.com/marketplace-items/v1/items/details. Does not work on normal items. Note that this is a messy, all-encompassing endpoint that should only be used directly when necessary.

Specialized endpoints that use this internally include: Client::collectible_product_id and Client::collectible_product_id_bulk.

Notes

Requires a valid roblosecurity.
The amount of items that can be requested at once is unknown as not enough non-tradable limiteds exist, and the endpoint doesn’t accept duplicates.
Will repeat once if the x-csrf-token is invalid.

Errors

All errors under Standard Errors.
All errors under X-CSRF-TOKEN Required Errors.
All errors under Auth Required Errors.

Examples

use roboat::ClientBuilder;

const ROBLOSECURITY: &str = "roblosecurity";

let client = ClientBuilder::new()
    .roblosecurity(ROBLOSECURITY.to_string())
    .build();

let collectible_item_id_1 = "a4b5cb79-5218-4ca1-93fa-1e3436f595ef".to_owned();
let collectible_item_id_2 = "61f2e366-9fe6-4562-8ce3-47334083372a".to_owned();
let items = vec![collectible_item_id_1, collectible_item_id_2];

let details = client.non_tradable_limited_details(items).await?;

println!("Item Name: {}", details[0].name);
println!("Item Description: {}", details[0].description);
println!("Item Price: {}", details[0].price);

println!("Item Name: {}", details[1].name);
println!("Item Description: {}", details[1].description);
println!("Item Price: {}", details[1].price);

Struct roboat::Client

Implementations§

impl Client

pub async fn force_refresh_xcsrf(&self) -> Result<(), RoboatError>

impl Client

pub async fn non_tradable_limited_details( &self, collectible_item_ids: Vec<String> ) -> Result<Vec<NonTradableLimitedDetails>, RoboatError>

pub async fn collectible_product_id( &self, collectible_item_id: String ) -> Result<String, RoboatError>

pub async fn collectible_product_id_bulk( &self, collectible_item_ids: Vec<String> ) -> Result<Vec<String>, RoboatError>

pub async fn collectible_creator_id( &self, collectible_item_id: String ) -> Result<u64, RoboatError>

pub async fn purchase_non_tradable_limited( &self, collectible_item_id: String, collectible_product_id: String, collectible_seller_id: u64, price: u64 ) -> Result<(), RoboatError>

impl Client

pub async fn item_details( &self, items: Vec<Item> ) -> Result<Vec<ItemDetails>, RoboatError>

pub async fn product_id(&self, item_id: u64) -> Result<u64, RoboatError>

pub async fn product_id_bulk( &self, item_ids: Vec<u64> ) -> Result<Vec<u64>, RoboatError>

pub async fn collectible_item_id( &self, item_id: u64 ) -> Result<String, RoboatError>

pub async fn collectible_item_id_bulk( &self, item_ids: Vec<u64> ) -> Result<Vec<String>, RoboatError>

pub async fn avatar_catalog_search( &self, query: &AvatarSearchQuery, cursor: Option<String> ) -> Result<(Vec<Item>, Option<String>), RoboatError>

impl Client

pub async fn unread_conversation_count(&self) -> Result<u64, RoboatError>

impl Client

pub async fn user_id(&self) -> Result<u64, RoboatError>

pub async fn username(&self) -> Result<String, RoboatError>

pub async fn display_name(&self) -> Result<String, RoboatError>

impl Client

pub async fn robux(&self) -> Result<u64, RoboatError>

pub async fn resellers( &self, item_id: u64, limit: Limit, cursor: Option<String> ) -> Result<(Vec<Listing>, Option<String>), RoboatError>

pub async fn user_sales( &self, limit: Limit, cursor: Option<String> ) -> Result<(Vec<UserSale>, Option<String>), RoboatError>

pub async fn put_limited_on_sale( &self, item_id: u64, uaid: u64, price: u64 ) -> Result<(), RoboatError>

pub async fn take_limited_off_sale( &self, item_id: u64, uaid: u64 ) -> Result<(), RoboatError>

pub async fn purchase_tradable_limited( &self, product_id: u64, seller_id: u64, uaid: u64, price: u64 ) -> Result<(), RoboatError>

impl Client

pub async fn group_roles(&self, group_id: u64) -> Result<Vec<Role>, RoboatError>

pub async fn group_role_members( &self, group_id: u64, role_id: u64, limit: Limit, cursor: Option<String> ) -> Result<(Vec<User>, Option<String>), RoboatError>

pub async fn set_group_member_role( &self, user_id: u64, group_id: u64, role_id: u64 ) -> Result<(), RoboatError>

impl Client

pub async fn register_presence(&self) -> Result<(), RoboatError>

impl Client

pub async fn messages( &self, page: u64, message_tab_type: MessageTabType ) -> Result<(Vec<Message>, MessagesMetadata), RoboatError>

impl Client

pub async fn thumbnail_url_bulk( &self, ids: Vec<u64>, size: ThumbnailSize, thumbnail_type: ThumbnailType ) -> Result<Vec<String>, RoboatError>

pub async fn thumbnail_url( &self, id: u64, size: ThumbnailSize, thumbnail_type: ThumbnailType ) -> Result<String, RoboatError>