Skip to content

Classes

Jump to bottom
Jack Programs edited this page Jul 6, 2020 · 24 revisions

Users

Properties

  • None

Static Methods

  • get_username_from_id
  • get_id_from_username
  • is_in_group
  • get_rank_in_group
  • get_role_in_group
  • group_is_primary
  • get_profile_description
  • get_profile_status
  • get_avatar_image
  • is_banned
  • is_online
  • get_online_status
  • can_manage_asset

Users.get_username_from_id

Gets the User's name from their ID

Parameters

  • user_id (Integer)

Returns

  • String

Example

.get_username_from_id(12345)

Users.get_id_from_username

Gets the User's ID from their name

Parameters

  • username (String)

Returns

  • Integer

Example

.get_id_from_username("ROBLOX")

Users.is_in_group

If user is in a specific group

Parameters

  • user_id (Integer)
  • group_id (Integer)

Returns

  • Boolean

Example

.is_in_group(12345, 54321)

Users.get_rank_in_group

Get the User's rank in a specific group

Parameters

  • user_id (Integer)
  • group_id (Integer)

Returns

  • Integer

Example

.get_rank_in_group(12345, 54321)

Users.get_role_in_group

Get the User's role in a specific group

Parameters

  • user_id (Integer)
  • group_id (Integer)

Returns

  • String

Example

.get_role_in_group(12345, 54321)

Users.group_is_primary

If a specific group is the User's primary

Parameters

  • user_id (Integer)
  • group_id (Integer)

Returns

  • Boolean

Example

.group_is_primary(12345, 54321)

Users.get_profile_description

Get the User's profile description. This will return None if there is no profile description.

Parameters

  • user_id (Integer)

Returns

  • String

Example

.get_profile_description(12345)

Users.get_profile_status

Get the User's profile status. This will return None if there is no profile status.

Parameters

  • user_id (Integer)

Returns

  • String

Example

.get_profile_status(12345)

Users.get_avatar_image

Get the User's avatar image

Parameters

  • user_id (Integer)

Returns

  • String

Example

.get_avatar_image(12345)

Users.is_banned

If user is banned

Parameters

  • user_id (Integer)

Returns

  • Boolean

Example

.is_banned(12345)

Users.is_online

If user is online currently

Parameters

  • user_id (Integer)

Returns

  • Boolean

Example

.is_online(12345)

Users.get_online_status

Get the User's online status

Parameters

  • user_id (Integer)

Returns

  • JSON Object / Python Dictionary

Example

.get_online_status(12345)

Users.can_manage_asset

User can manage asset

Parameters

  • user_id (Integer)
  • asset_id (Integer)

Returns

  • Boolean

Example

.can_manage_asset(12345, 12345)

User

Creates a User object

Properties

  • name (String) - The User's Name.
  • display_name (String) - The User's Display name.
  • id (Integer) - The User's ID.
  • is_banned (Boolean) - Whether the user is banned or not.
  • created (String) - The date when the user was created.
  • description (String) - The description of the user.
  • status (String) - The status of the user.

Parameters

  • user_id (Integer)

Example

User(12345)

Friends

Properties

  • None

Static Methods

  • get_friends
  • get_first_friend
  • get_recent_friend
  • users_are_friends

Friends.get_friends

Gets the friends of the User

Parameters

  • user_id (Integer)

Returns

  • JSON Object / Python List and Dictionary

Example

.get_friends(12345)

Friends.get_first_friend

Gets the first friend of the User

Parameters

  • user_id (Integer)

Returns

  • JSON Object / Python Dictionary

Example

.get_first_friend(12345)

Friends.get_recent_friend

Gets the recent friend of the User

Parameters

  • user_id (Integer)

Returns

  • JSON Object / Python Dictionary

Example

.get_recent_friend(12345)

Friends.users_are_friends

Whether the user is friends with the other user or not

Parameters

  • user_id_1 (Integer)
  • user_id_2 (Integer)

Returns

  • Boolean

Example

.users_are_friends(12345, 54321)

Assets

Properties

  • None

Static Methods

  • get_asset
  • user_has_asset

Assets.get_asset

Gets the asset information

Parameters

  • asset_id (Integer)

Returns

  • JSON Object / Python Dictionary

Example

.get_asset(12345)

Assets.user_has_asset

Whether the user has a specified asset or not

Parameters

  • user_id (Integer)
  • asset_id (Integer)

Returns

  • Boolean

Example

.user_has_asset(12345, 54321)

Asset

Creates a new Asset object

Properties

  • product_type (String) - The type of product (for example: "User Product").
  • asset_id (Integer) - The asset ID.
  • product_id (Integer) - The product ID.
  • name (String) - The asset name.
  • description (String) - The asset description.
  • asset_type_id (Integer) - The asset type ID.
  • creator (String) - The creator of the asset.
  • creator_id (Integer) - The creator's ID.
  • creator_type (String) - The creator's type.
  • created (String) - The date when the asset was created.
  • updated (String) - The date when the asset was recently updated.
  • price_in_robux (Integer) - The robux price of the asset.
  • sales (Integer) - The sales of the asset.
  • is_new (Boolean) - Whether the asset is new or not.
  • is_for_sale (Boolean) - Whether the asset is on for sale or not.
  • is_public_domain (Boolean) - Whether the asset is public domain or not.
  • is_limited (Boolean) - Whether the asset is a limited or not.
  • is_limited_unique (Boolean) - Whether the asset is limited unique or not.

Parameters

  • asset_id (Integer)

Example

Asset(12345)

Groups

Properties

  • None

Static Methods

  • get_users_groups
  • get_users_group_ids
  • get_group
  • get_group_name
  • get_group_owner
  • has_owner
  • get_group_description
  • get_group_roles
  • get_group_role_names
  • get_group_role_numbers
  • has_allies
  • has_enemies
  • get_group_allies
  • get_group_ally_names
  • get_recent_ally
  • get_group_enemies
  • get_group_enemy_names
  • get_recent_enemy

Groups.get_users_groups

Gets a list of the User's groups

Parameters

  • user_id (Integer)

Returns

  • Python List

Example

.get_users_groups(12345)

Groups.get_users_group_ids

Gets a list of the User's groups' IDs

Parameters

  • user_id (Integer)

Returns

  • Python List

Example

.get_users_group_ids(12345)

Groups.get_group

Gets the group's information

Parameters

  • group_id (Integer)

Returns

  • JSON Object / Python Dictionary

Example

.get_group(12345)

Groups.get_group_name

Gets the group's name

Parameters

  • group_id (Integer)

Returns

  • String

Example

.get_group_name(12345)

Groups.get_group_owner

Gets the group's owner

Parameters

  • group_id (Integer)

Returns

  • String (Returns None if no owner)

Example

.get_group_owner(12345)

Groups.has_owner

Whether the group has an owner or not

Parameters

  • group_id (Integer)

Returns

  • Boolean

Example

.has_owner(12345)

Groups.get_group_description

Gets the group's description

Parameters

  • group_id (Integer)

Returns

  • String

Example

.get_group_description(12345)

Groups.get_group_roles

Gets the group's roles

Parameters

  • group_id (Integer)

Returns

  • JSON Object / Python List and Dictionary

Example

.get_group_roles(12345)

Groups.get_group_role_names

Gets the group's role names

Parameters

  • group_id (Integer)

Returns

  • Python List

Example

.get_group_role_names(12345)

Groups.get_group_role_numbers

Gets the group's role numbers

Parameters

  • group_id (Integer)

Returns

  • Python List

Example

.get_group_role_numbers(12345)

Groups.has_allies

If the group has allies

Parameters

  • group_id (Integer)

Returns

  • Boolean

Example

.has_allies(12345)

Groups.has_enemies

If the group has enemies

Parameters

  • group_id (Integer)

Returns

  • Boolean

Example

.has_enemies(12345)

Groups.get_group_allies

Gets the group's allies

Parameters

  • group_id (Integer)

Returns

  • JSON Object / Python Dictionary

Example

.get_group_allies(12345)

Groups.get_group_ally_names

Gets the group's ally names

Parameters

  • group_id (Integer)

Returns

  • Python List

Example

.get_group_ally_names(12345)

Groups.get_recent_ally

Gets the group's recent ally

Parameters

  • group_id (Integer)

Returns

  • JSON Object / Python Dictionary (will return None if no allies)

Example

.get_recent_ally(12345)

Groups.get_group_enemies

Gets the group's enemies

Parameters

  • group_id (Integer)

Returns

  • JSON Object / Python Dictionary

Example

.get_group_enemies(12345)

Groups.get_group_enemy_names

Gets the group's enemy names

Parameters

  • group_id (Integer)

Returns

  • Python List

Example

.get_group_enemy_names(12345)

Groups.get_recent_enemy

Gets the group's recent enemy

Parameters

  • group_id (Integer)

Returns

  • JSON Object / Python Dictionary (will return None if no enemies)

Example

.get_recent_enemy(12345)

Group

Creates a new Group object

Properties

  • name (String) - The group's name.
  • id (Integer) - The group's ID.
  • owner (JSON Object / Python Dictionary) - The group's owner information. Returns None if no owner.
  • owner_name (String) - The group's owner name. Returns None if no owner.
  • owner_id (Integer) - The group's owner ID. Returns None if no owner.
  • emblem_url (String) - The group's emblem url.
  • description (String) - The group's description.
  • roles (JSON Object / Python Dictionary) - The group's roles.

Parameters

  • group_id (Integer)

Example

Group(12345)

Clone this wiki locally