Skip to content

Module: client/apis/GeneralAPI

Table of contents

Classes

Type aliases

Type aliases

AcceptFriendRequest

Ƭ AcceptFriendRequest: boolean

Defined in: client/apis/GeneralAPI.ts:93


AcceptFriendRequestOptions

Ƭ AcceptFriendRequestOptions: object

Type declaration:

Name Type
userId number

Defined in: client/apis/GeneralAPI.ts:16


AwardBadge

Ƭ AwardBadge: boolean

Defined in: client/apis/GeneralAPI.ts:82


AwardBadgeOptions

Ƭ AwardBadgeOptions: object

Type declaration:

Name Type
badgeId number
placeId number
userId number

Defined in: client/apis/GeneralAPI.ts:7


BlockUser

Ƭ BlockUser: boolean

Defined in: client/apis/GeneralAPI.ts:146


BlockUserOptions

Ƭ BlockUserOptions: object

Type declaration:

Name Type
userId number

Defined in: client/apis/GeneralAPI.ts:65


DeclineFriendRequest

Ƭ DeclineFriendRequest: boolean

Defined in: client/apis/GeneralAPI.ts:94


DeclineFriendRequestOptions

Ƭ DeclineFriendRequestOptions: object

Type declaration:

Name Type
userId number

Defined in: client/apis/GeneralAPI.ts:19


FollowUser

Ƭ FollowUser: boolean

Defined in: client/apis/GeneralAPI.ts:101


FollowUserOptions

Ƭ FollowUserOptions: object

Type declaration:

Name Type
userId number

Defined in: client/apis/GeneralAPI.ts:35


GetAssetVersionOptions

Ƭ GetAssetVersionOptions: number

Defined in: client/apis/GeneralAPI.ts:6


GetAssetVersions

Ƭ GetAssetVersions: AssetVersionOptions[]

Defined in: client/apis/GeneralAPI.ts:81


GetBalance

Ƭ GetBalance: object

Type declaration:

Name Type
robux number

Defined in: client/apis/GeneralAPI.ts:83


GetDeviceInfo

Ƭ GetDeviceInfo: object

Type declaration:

Name Type
deviceType string
operatingSystemType string
platformType string

Defined in: client/apis/GeneralAPI.ts:141


GetGamePassProductInfo

Ƭ GetGamePassProductInfo: ProductOptions

Defined in: client/apis/GeneralAPI.ts:139


GetGamePassProductInfoOptions

Ƭ GetGamePassProductInfoOptions: object

Type declaration:

Name Type
gamePassId number

Defined in: client/apis/GeneralAPI.ts:58


GetGroup

Ƭ GetGroup: object

Type declaration:

Name Type
Description string
EmblemUrl string
Id number
Name string
Owner object
Owner.Id number
Owner.Name string
Roles { Name: string ; Rank: number }[]

Defined in: client/apis/GeneralAPI.ts:115


GetGroupAllies

Ƭ GetGroupAllies: object

Type declaration:

Name Type
FinalPage boolean
Groups GetGroup[]

Defined in: client/apis/GeneralAPI.ts:129


GetGroupAlliesOptions

Ƭ GetGroupAlliesOptions: object

Type declaration:

Name Type
groupId number
page number

Defined in: client/apis/GeneralAPI.ts:47


GetGroupEnemies

Ƭ GetGroupEnemies: GetGroupAllies

Defined in: client/apis/GeneralAPI.ts:133


GetGroupEnemiesOptions

Ƭ GetGroupEnemiesOptions: object

Type declaration:

Name Type
groupId number
page number

Defined in: client/apis/GeneralAPI.ts:51


GetGroupOptions

Ƭ GetGroupOptions: object

Type declaration:

Name Type
groupId number

Defined in: client/apis/GeneralAPI.ts:44


GetIncomingItems

Ƭ GetIncomingItems: object

Type declaration:

Name Type
friendRequestsCount number
unreadMessageCount number

Defined in: client/apis/GeneralAPI.ts:134


GetProductInfo

Ƭ GetProductInfo: ProductOptions

Defined in: client/apis/GeneralAPI.ts:138


GetProductInfoOptions

Ƭ GetProductInfoOptions: object

Type declaration:

Name Type
assetId number

Defined in: client/apis/GeneralAPI.ts:55


GetUserById

Ƭ GetUserById: object

Type declaration:

Name Type
id number
name string

Defined in: client/apis/GeneralAPI.ts:148


GetUserByIdOptions

Ƭ GetUserByIdOptions: object

Type declaration:

Name Type
userId number

Defined in: client/apis/GeneralAPI.ts:78


GetUserByUsername

Ƭ GetUserByUsername: GetUserById

Defined in: client/apis/GeneralAPI.ts:152


GetUserByUsernameOptions

Ƭ GetUserByUsernameOptions: object

Type declaration:

Name Type
username string

Defined in: client/apis/GeneralAPI.ts:71


GetUserFriends

Ƭ GetUserFriends: { AvatarFinal: boolean ; AvatarUri: string ; Id: number ; IsOnline: boolean ; Username: string }[]

Defined in: client/apis/GeneralAPI.ts:86


GetUserFriendsCount

Ƭ GetUserFriendsCount: object

Type declaration:

Name Type
count number

Defined in: client/apis/GeneralAPI.ts:96


GetUserFriendsCountOptions

Ƭ GetUserFriendsCountOptions: object

Type declaration:

Name Type
userId number

Defined in: client/apis/GeneralAPI.ts:25


GetUserFriendsOptions

Ƭ GetUserFriendsOptions: object

Type declaration:

Name Type
page number
userId number

Defined in: client/apis/GeneralAPI.ts:12


GetUserGroups

Ƭ GetUserGroups: { emblemId: number | null ; emblemUrl: string | null ; id: number ; inClan: boolean ; name: string ; primary: boolean ; role: { name: string ; rank: number } }[]

Defined in: client/apis/GeneralAPI.ts:103


GetUserGroupsOptions

Ƭ GetUserGroupsOptions: object

Type declaration:

Name Type
userId number

Defined in: client/apis/GeneralAPI.ts:41


IsUserFollowing

Ƭ IsUserFollowing: boolean

Defined in: client/apis/GeneralAPI.ts:100


IsUserFollowingOptions

Ƭ IsUserFollowingOptions: object

Type declaration:

Name Type
followUserId number
userId number

Defined in: client/apis/GeneralAPI.ts:31


SendFriendRequest

Ƭ SendFriendRequest: boolean

Defined in: client/apis/GeneralAPI.ts:95


SendFriendRequestOptions

Ƭ SendFriendRequestOptions: object

Type declaration:

Name Type
userId number

Defined in: client/apis/GeneralAPI.ts:22


UnblockUser

Ƭ UnblockUser: boolean

Defined in: client/apis/GeneralAPI.ts:147


UnblockUserOptions

Ƭ UnblockUserOptions: object

Type declaration:

Name Type
userId number

Defined in: client/apis/GeneralAPI.ts:68


UnfollowUser

Ƭ UnfollowUser: boolean

Defined in: client/apis/GeneralAPI.ts:102


UnfollowUserOptions

Ƭ UnfollowUserOptions: object

Type declaration:

Name Type
userId number

Defined in: client/apis/GeneralAPI.ts:38


UnfriendUser

Ƭ UnfriendUser: boolean

Defined in: client/apis/GeneralAPI.ts:99


UnfriendUserOptions

Ƭ UnfriendUserOptions: object

Type declaration:

Name Type
userId number

Defined in: client/apis/GeneralAPI.ts:28


UserCanManageAsset

Ƭ UserCanManageAsset: boolean

Defined in: client/apis/GeneralAPI.ts:153


UserCanManageAssetOptions

Ƭ UserCanManageAssetOptions: object

Type declaration:

Name Type
assetId number
userId number

Defined in: client/apis/GeneralAPI.ts:74


UserOwnsAsset

Ƭ UserOwnsAsset: boolean

Defined in: client/apis/GeneralAPI.ts:140


UserOwnsAssetOptions

Ƭ UserOwnsAssetOptions: object

Type declaration:

Name Type
assetId number
userId number

Defined in: client/apis/GeneralAPI.ts:61