Classes v.4.5

THIS IS ONLY FOR PEOPLE USING VERSION 4.5 (OR MAYBE LOWER). ALL PEOPLE USING VERSION 5.0 OR ABOVE SHOULD GO TO THE 'CLASSES' TAB.

• Classes
  • Users
  • User
  • Friends
  • Assets
  • Asset
  • Groups
  • Group

---

Users

Properties

• None

Static Methods

• GetUsernameFromId
• GetIdFromUsername
• IsInGroup
• GetRankInGroup
• GetRoleInGroup
• GroupIsPrimary
• GetProfileDescription
• GetProfileStatus
• GetAvatarImage
• IsBanned
• IsOnline
• GetOnlineStatus
• CanManageAsset

Users.GetUsernameFromId

Gets the User's name from their ID

Parameters

• userId (Integer)

Returns

• String

Example

.GetUsernameFromId(12345)

Users.GetIdFromUsername

Gets the User's ID from their name

Parameters

• name (String)

Returns

• Integer

Example

.GetIdFromUsername("ROBLOX")

Users.IsInGroup

If user is in a specific group

Parameters

• userId (Integer)
• groupId (Integer)

Returns

• Boolean

Example

.IsInGroup(12345, 54321)

Users.GetRankInGroup

Get the User's rank in a specific group

Parameters

• userId (Integer)
• groupId (Integer)

Returns

• Integer

Example

.GetRankInGroup(12345, 54321)

Users.GetRoleInGroup

Get the User's role in a specific group

Parameters

• userId (Integer)
• groupId (Integer)

Returns

• String

Example

.GetRoleInGroup(12345, 54321)

Users.GroupIsPrimary

If a specific group is the User's primary

Parameters

• userId (Integer)
• groupId (Integer)

Returns

• Boolean

Example

.GroupIsPrimary(12345, 54321)

Users.GetProfileDescription

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

Parameters

• userId (Integer)

Returns

• String

Example

.GetProfileDescription(12345)

Users.GetProfileStatus

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

Parameters

• userId (Integer)

Returns

• String

Example

.GetProfileStatus(12345)

Users.GetAvatarImage

Get the User's avatar image

Parameters

• userId (Integer)

Returns

• String

Example

.GetAvatarImage(12345)

Users.IsBanned

If user is banned

Parameters

• userId (Integer)

Returns

• Boolean

Example

.IsBanned(12345)

Users.IsOnline

If user is online currently

Parameters

• userId (Integer)

Returns

• Boolean

Example

.IsOnline(12345)

Users.GetOnlineStatus

Get the User's online status

Parameters

• userId (Integer)

Returns

• JSON Object / Python Dictionary

Example

.GetOnlineStatus(12345)

Users.CanManageAsset

User can manage asset

Parameters

• userId (Integer)
• assetId (Integer)

Returns

• Boolean

Example

.CanManageAsset(12345, 12345)

User

Creates a User object

Properties

• Name (String) - The User's Name.
• DisplayName (String) - The User's Display name.
• Id (Integer) - The User's ID.
• IsBanned (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

• userId (Integer)

Example

User(12345)

Friends

Properties

• None

Static Methods

• GetFriends
• GetFirstFriend
• GetRecentFriend
• UsersAreFriends

Friends.GetFriends

Gets the friends of the User

Parameters

• userId (Integer)

Returns

• JSON Object / Python List and Dictionary

Example

.GetFriends(12345)

Friends.GetFirstFriend

Gets the first friend of the User

Parameters

• userId (Integer)

Returns

• JSON Object / Python Dictionary

Example

.GetFirstFriend(12345)

Friends.GetRecentFriend

Gets the recent friend of the User

Parameters

• userId (Integer)

Returns

• JSON Object / Python Dictionary

Example

.GetRecentFriend(12345)

Friends.UsersAreFriends

Whether the user is friends with the other user or not

Parameters

• userId1 (Integer)
• userId2 (Integer)

Returns

• Boolean

Example

.UsersAreFriends(12345, 54321)

Assets

Properties

• None

Static Methods

• GetAsset
• UserHasAsset

Assets.GetAsset

Gets the asset information

Parameters

• assetId (Integer)

Returns

• JSON Object / Python Dictionary

Example

.GetAsset(12345)

Assets.UserHasAsset

Whether the user has a specified asset or not

Parameters

• userId (Integer)
• assetId (Integer)

Returns

• Boolean

Example

.UserHasAsset(12345, 54321)

Asset

Creates a new Asset object

Properties

• ProductType (String) - The type of product (for example: "User Product").
• AssetId (Integer) - The asset ID.
• ProductId (Integer) - The product ID.
• Name (String) - The asset name.
• Description (String) - The asset description.
• AssetTypeId (Integer) - The asset type ID.
• Creator (String) - The creator of the asset.
• CreatorId (Integer) - The creator's ID.
• CreatorType (String) - The creator's type.
• Created (String) - The date when the asset was created.
• Updated (String) - The date when the asset was recently updated.
• PriceInRobux (Integer) - The robux price of the asset.
• Sales (Integer) - The sales of the asset.
• IsNew (Boolean) - Whether the asset is new or not.
• IsForSale (Boolean) - Whether the asset is on for sale or not.
• IsPublicDomain (Boolean) - Whether the asset is public domain or not.
• IsLimited (Boolean) - Whether the asset is a limited or not.
• IsLimitedUnique (Boolean) - Whether the asset is limited unique or not.

Parameters

• assetId (Integer)

Example

Asset(12345)

Groups

Properties

• None

Static Methods

• GetUsersGroups
• GetUsersGroupIds
• GetGroup
• GetGroupName
• GetGroupOwner
• HasOwner
• GetGroupDescription
• GetGroupRoles
• GetGroupRoleNames
• GetGroupRoleNumbers
• GetGroupAllies
• GetGroupAllyNames
• GetRecentAllyOfGroup
• GetGroupEnemies
• GetGroupEnemyNames
• GetRecentEnemyOfGroup

Groups.GetUsersGroups

Gets a list of the User's groups

Parameters

• userId (Integer)

Returns

• Python List

Example

.GetUsersGroups(12345)

Groups.GetUsersGroupIds

Gets a list of the User's groups' IDs

Parameters

• userId (Integer)

Returns

• Python List

Example

.GetUsersGroupIds(12345)

Groups.GetGroup

Gets the group's information

Parameters

• groupId (Integer)

Returns

• JSON Object / Python Dictionary

Example

.GetGroup(12345)

Groups.GetGroupName

Gets the group's name

Parameters

• groupId (Integer)

Returns

• String

Example

.GetGroupName(12345)

Groups.GetGroupOwner

Gets the group's owner

Parameters

• groupId (Integer)

Returns

• String (Returns None if no owner)

Example

.GetGroupOwner(12345)

Groups.HasOwner

Whether the group has an owner or not

Parameters

• groupId (Integer)

Returns

• Boolean

Example

.HasOwner(12345)

Groups.GetGroupDescription

Gets the group's description

Parameters

• groupId (Integer)

Returns

• String

Example

.GetGroupDescription(12345)

Groups.GetGroupRoles

Gets the group's roles

Parameters

• groupId (Integer)

Returns

• JSON Object / Python List and Dictionary

Example

.GetGroupRoles(12345)

Groups.GetGroupRoleNames

Gets the group's role names

Parameters

• groupId (Integer)

Returns

• Python List

Example

.GetGroupRoleNames(12345)

Groups.GetGroupRoleNumbers

Gets the group's role numbers

Parameters

• groupId (Integer)

Returns

• Python List

Example

.GetGroupRoleNumbers(12345)

Groups.GetGroupAllies

Gets the group's allies

Parameters

• groupId (Integer)

Returns

• JSON Object / Python Dictionary

Example

.GetGroupAllies(12345)

Groups.GetGroupAllyNames

Gets the group's ally names

Parameters

• groupId (Integer)

Returns

• Python List

Example

.GetGroupAllyNames(12345)

Groups.GetRecentAllyOfGroup

Gets the group's recent ally

Parameters

• groupId (Integer)

Returns

• JSON Object / Python Dictionary

Example

.GetRecentAllyOfGroup(12345)

Groups.GetGroupEnemies

Gets the group's enemies

Parameters

• groupId (Integer)

Returns

• JSON Object / Python Dictionary

Example

.GetGroupEnemies(12345)

Groups.GetGroupEnemyNames

Gets the group's enemy names

Parameters

• groupId (Integer)

Returns

• Python List

Example

.GetGroupEnemyNames(12345)

Groups.GetRecentEnemyOfGroup

Gets the group's recent enemy

Parameters

• groupId (Integer)

Returns

• JSON Object / Python Dictionary

Example

.GetRecentEnemyOfGroup(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.
• OwnerName (String) - The group's owner name. Returns None if no owner.
• OwnerId (Integer) - The group's owner ID. Returns None if no owner.
• EmblemUrl (String) - The group's emblem url.
• Description (String) - The group's description.
• Roles (JSON Object / Python Dictionary) - The group's roles.

Parameters

• groupId (Integer)

Example

Group(12345)