Skip to content

Commit

Permalink
Add new methods to docs
Browse files Browse the repository at this point in the history
  • Loading branch information
acatiadroid committed Jan 7, 2024
1 parent 86dde2f commit 848777b
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions docs/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ The base class for all Bloxlink API interactions.
**Parameters:**
* **discord_id (int)**: the Roblox ID of the user you want to find the Discord ID of.
* **server_id (int)**: the ID of the server you want to search in.

\**if you intend on doing a global search (which required approval), do not include this argument.
Otherwise, you must provide this argument.*

Expand All @@ -30,6 +31,7 @@ The base class for all Bloxlink API interactions.
**Parameters:**
* **roblox_id (int)**: the ID of the Discord user you want to find the Roblox ID of.
* **server_id (int)***: the ID of the server you want to search in.

\**if you intend on doing a global search (which required approval), do not include this argument.
Otherwise, you must provide this argument.*

Expand Down Expand Up @@ -84,6 +86,22 @@ This information is only retrieved if you have Bloxlink Premium.
* **has_verified_badge (Optional[str])**: Whether the user has a verified badge.
* **groups2 (Optional[str])**: The Roblox users' groups. (this lists the groups in a dictionary using the group ID as the key as opposed to a list)

**Methods:**
* **await get_avatar_headshot_url()**

Makes a request to Roblox's API for the avatar headshot image URL.
Returns None if avatar can't be retrieved.

* **await get_avatar_bust_url()**

Makes a request to Roblox's API for the avatar bust image URL.
Returns None if avatar can't be retrieved.

* **await get_avatar_fullbody_url()**

Makes a request to Roblox's API for the avatar full body image URL.
Returns None if avatar can't be retrieved.

## Responses
`class bloxlink.RobloxUserResponse`

Expand Down

0 comments on commit 848777b

Please sign in to comment.