Skip to content

Class: default

client/apis/GeneralAPI.default

Hierarchy

↳ default

Table of contents

Constructors

Properties

Methods

Constructors

constructor

+ new default(client: default): default

Parameters:

Name Type
client default

Returns: default

Inherited from: default

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

Properties

client

• client: default

Inherited from: default.client

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

options

• options: BaseAPIOptions

Inherited from: default.options

Defined in: client/apis/BaseAPI.ts:26

Methods

acceptFriendRequest

▸ acceptFriendRequest(options: AcceptFriendRequestOptions): Promise<boolean>

Parameters:

Name Type
options AcceptFriendRequestOptions

Returns: Promise<boolean>

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

awardBadge

▸ awardBadge(options: AwardBadgeOptions): Promise<boolean>

Parameters:

Name Type
options AwardBadgeOptions

Returns: Promise<boolean>

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

blockUser

▸ blockUser(options: BlockUserOptions): Promise<boolean>

Parameters:

Name Type
options BlockUserOptions

Returns: Promise<boolean>

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

declineFriendRequest

▸ declineFriendRequest(options: DeclineFriendRequestOptions): Promise<boolean>

Parameters:

Name Type
options DeclineFriendRequestOptions

Returns: Promise<boolean>

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

followUser

▸ followUser(options: FollowUserOptions): Promise<boolean>

Parameters:

Name Type
options FollowUserOptions

Returns: Promise<boolean>

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

getAssetVersions

▸ getAssetVersions(options: number): Promise<GetAssetVersions>

Parameters:

Name Type
options number

Returns: Promise<GetAssetVersions>

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

getBalance

▸ getBalance(): Promise<GetBalance>

Returns: Promise<GetBalance>

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

getDeviceInfo

▸ getDeviceInfo(): Promise<GetDeviceInfo>

Returns: Promise<GetDeviceInfo>

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

getGamePassProductInfo

▸ getGamePassProductInfo(options: GetGamePassProductInfoOptions): Promise<ProductOptions>

Parameters:

Name Type
options GetGamePassProductInfoOptions

Returns: Promise<ProductOptions>

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

getGroup

▸ getGroup(options: GetGroupOptions): Promise<GetGroup>

Parameters:

Name Type
options GetGroupOptions

Returns: Promise<GetGroup>

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

getGroupAllies

▸ getGroupAllies(options: GetGroupAlliesOptions): Promise<GetGroupAllies>

Parameters:

Name Type
options GetGroupAlliesOptions

Returns: Promise<GetGroupAllies>

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

getGroupEnemies

▸ getGroupEnemies(options: GetGroupEnemiesOptions): Promise<GetGroupAllies>

Parameters:

Name Type
options GetGroupEnemiesOptions

Returns: Promise<GetGroupAllies>

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

getIncomingItems

▸ getIncomingItems(): Promise<GetIncomingItems>

Returns: Promise<GetIncomingItems>

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

getProductInfo

▸ getProductInfo(options: GetProductInfoOptions): Promise<ProductOptions>

Parameters:

Name Type
options GetProductInfoOptions

Returns: Promise<ProductOptions>

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

getUserById

▸ getUserById(options: GetUserByIdOptions): Promise<GetUserById>

Parameters:

Name Type
options GetUserByIdOptions

Returns: Promise<GetUserById>

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

getUserByUsername

▸ getUserByUsername(options: GetUserByUsernameOptions): Promise<GetUserById>

Parameters:

Name Type
options GetUserByUsernameOptions

Returns: Promise<GetUserById>

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

getUserFriends

▸ getUserFriends(options: GetUserFriendsOptions): Promise<GetUserFriends>

Parameters:

Name Type
options GetUserFriendsOptions

Returns: Promise<GetUserFriends>

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

getUserFriendsCount

▸ getUserFriendsCount(options: GetUserFriendsCountOptions): Promise<GetUserFriendsCount>

Parameters:

Name Type
options GetUserFriendsCountOptions

Returns: Promise<GetUserFriendsCount>

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

getUserGroups

▸ getUserGroups(options: GetUserGroupsOptions): Promise<GetUserGroups>

Parameters:

Name Type
options GetUserGroupsOptions

Returns: Promise<GetUserGroups>

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

isUserFollowing

▸ isUserFollowing(options: IsUserFollowingOptions): Promise<boolean>

Parameters:

Name Type
options IsUserFollowingOptions

Returns: Promise<boolean>

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

request

▸ request(options: BaseAPIRequestOptions): Promise<RESTResponseDataType>

Parameters:

Name Type
options BaseAPIRequestOptions

Returns: Promise<RESTResponseDataType>

Inherited from: default

Defined in: client/apis/BaseAPI.ts:33

sendFriendRequest

▸ sendFriendRequest(options: SendFriendRequestOptions): Promise<boolean>

Parameters:

Name Type
options SendFriendRequestOptions

Returns: Promise<boolean>

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

unblockUser

▸ unblockUser(options: UnblockUserOptions): Promise<boolean>

Parameters:

Name Type
options UnblockUserOptions

Returns: Promise<boolean>

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

unfollowUser

▸ unfollowUser(options: UnfollowUserOptions): Promise<boolean>

Parameters:

Name Type
options UnfollowUserOptions

Returns: Promise<boolean>

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

unfriendUser

▸ unfriendUser(options: UnfriendUserOptions): Promise<boolean>

Parameters:

Name Type
options UnfriendUserOptions

Returns: Promise<boolean>

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

userCanManageAsset

▸ userCanManageAsset(options: UserCanManageAssetOptions): Promise<boolean>

Parameters:

Name Type
options UserCanManageAssetOptions

Returns: Promise<boolean>

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

userOwnsAsset

▸ userOwnsAsset(options: UserOwnsAssetOptions): Promise<boolean>

Parameters:

Name Type
options UserOwnsAssetOptions

Returns: Promise<boolean>

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