Skip to content

Module: client/apis/FriendsAPI

Table of contents

Classes

Type aliases

Type aliases

AcceptFriendRequest

Ƭ AcceptFriendRequest: unknown

Defined in: client/apis/FriendsAPI.ts:143

AcceptFriendRequestOptions

Ƭ AcceptFriendRequestOptions: object

Type declaration:

Name Type
userId number

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

CheckSessionHealth

Ƭ CheckSessionHealth: unknown

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

DeclineAllFriendRequests

Ƭ DeclineAllFriendRequests: unknown

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

DeclineFriendRequest

Ƭ DeclineFriendRequest: unknown

Defined in: client/apis/FriendsAPI.ts:145

DeclineFriendRequestOptions

Ƭ DeclineFriendRequestOptions: AcceptFriendRequestOptions

Defined in: client/apis/FriendsAPI.ts:144

DeleteQRCodeSession

Ƭ DeleteQRCodeSession: unknown

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

DeleteSession

Ƭ DeleteSession: unknown

Defined in: client/apis/FriendsAPI.ts:21

FindFriendByCode

Ƭ FindFriendByCode: object

Type declaration:

Name Type
friendshipStatus NoFriendship | string
userId number
username string

Defined in: client/apis/FriendsAPI.ts:11

FindFriendByCodeOptions

Ƭ FindFriendByCodeOptions: object

Type declaration:

Name Type
code string

Defined in: client/apis/FriendsAPI.ts:8

FollowUser

Ƭ FollowUser: object

Type declaration:

Name Type
isCaptchaRequired boolean
success boolean

Defined in: client/apis/FriendsAPI.ts:149

FollowUserOptions

Ƭ FollowUserOptions: object

Type declaration:

Name Type
userId number

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

GetMetaData

Ƭ GetMetaData: object

Type declaration:

Name Type
isFriendFinderEnabled boolean
isFriendsUserDataStoreCacheEnabled boolean
isNearbyUpsellEnabled boolean
userName string

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

GetMetaDataOptions

Ƭ GetMetaDataOptions: object

Type declaration:

Name Type
targetUserId number

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

GetOrCreateNearbySession

Ƭ GetOrCreateNearbySession: object

Type declaration:

Name Type
code string
expires number

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

GetOrCreateQRCodeSession

Ƭ GetOrCreateQRCodeSession: GetOrCreateNearbySession

Defined in: client/apis/FriendsAPI.ts:34

GetSelfFriendRequests

Ƭ GetSelfFriendRequests: object

Type declaration:

Name Type
data { created: string ; description: string ; isBanned: boolean ; userId: number ; username: string }[]
nextPageCursor string
previousPageCursor string

Defined in: client/apis/FriendsAPI.ts:52

GetSelfFriendRequestsCount

Ƭ GetSelfFriendRequestsCount: object

Type declaration:

Name Type
count number

Defined in: client/apis/FriendsAPI.ts:63

GetSelfFriendRequestsOptions

Ƭ GetSelfFriendRequestsOptions: object

Type declaration:

Name Type
cursor? string
limit? 10 | 25 | 50 | 100
sortOrder? Desc | Asc

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

GetSelfFriendsCount

Ƭ GetSelfFriendsCount: object

Type declaration:

Name Type
count number

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

GetSelfRecommendedUsers

Ƭ GetSelfRecommendedUsers: { presenceType: EnumUserPresence ; profileUrl: string ; user: PartialUser }[]

Defined in: client/apis/FriendsAPI.ts:167

GetUserFollowers

Ƭ GetUserFollowers: object

Type declaration:

Name Type
data { created: string ; description: string ; id: number ; isBanned: boolean ; isDeleted: boolean ; isOnline: boolean ; name: string }[]
nextPageCursor string
previousPageCursor string

Defined in: client/apis/FriendsAPI.ts:72

GetUserFollowersCount

Ƭ GetUserFollowersCount: object

Type declaration:

Name Type
count number

Defined in: client/apis/FriendsAPI.ts:88

GetUserFollowersCountOptions

Ƭ GetUserFollowersCountOptions: object

Type declaration:

Name Type
userId number

Defined in: client/apis/FriendsAPI.ts:85

GetUserFollowersOptions

Ƭ GetUserFollowersOptions: object

Type declaration:

Name Type
cursor? string
limit? 10 | 25 | 50 | 100
sortOrder? Asc | Desc
userId number

Defined in: client/apis/FriendsAPI.ts:66

GetUserFollowing

Ƭ GetUserFollowing: GetUserFollowers

Defined in: client/apis/FriendsAPI.ts:92

GetUserFollowingCount

Ƭ GetUserFollowingCount: GetUserFollowersCount

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

GetUserFollowingCountOptions

Ƭ GetUserFollowingCountOptions: GetUserFollowersCountOptions

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

GetUserFollowingOptions

Ƭ GetUserFollowingOptions: GetUserFollowersOptions

Defined in: client/apis/FriendsAPI.ts:91

GetUserFriends

Ƭ GetUserFriends: object

Type declaration:

Name Type
data { created: string ; description: string ; id: number ; isBanned: boolean ; isDeleted: boolean ; isOnline: boolean ; name: string }[]

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

GetUserFriendsOptions

Ƭ GetUserFriendsOptions: object

Type declaration:

Name Type
cursor? string
limit? 10 | 25 | 50 | 100
userId number

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

GetUserFriendsWithStatuses

Ƭ GetUserFriendsWithStatuses: object

Type declaration:

Name Type
data { id: number ; status: NotFriends | string }[]

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

GetUserFriendsWithStatusesOptions

Ƭ GetUserFriendsWithStatusesOptions: object

Type declaration:

Name Type
userId number
withUserIds number[]

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

GetUserOnlineFriends

Ƭ GetUserOnlineFriends: object

Type declaration:

Name Type
data { presence: { UserLocationType: string | null ; UserPresenceType: UserPresence | null ; gameInstanceId: string | null ; lastLocation: string | null ; lastOnline: string | null ; placeId: number | null ; universeId: number | null } ; userId: number ; username: string }[]

Defined in: client/apis/FriendsAPI.ts:114

GetUserOnlineFriendsOptions

Ƭ GetUserOnlineFriendsOptions: object

Type declaration:

Name Type
userId number

Defined in: client/apis/FriendsAPI.ts:111

RedeemNearbyFriendCode

Ƭ RedeemNearbyFriendCode: unknown

Defined in: client/apis/FriendsAPI.ts:20

RedeemNearbyFriendCodeOptions

Ƭ RedeemNearbyFriendCodeOptions: object

Type declaration:

Name Type
code string

Defined in: client/apis/FriendsAPI.ts:17

RedeemQRCode

Ƭ RedeemQRCode: object

Type declaration:

Name Type
userId number
username string

Defined in: client/apis/FriendsAPI.ts:29

RedeemQRCodeOptions

Ƭ RedeemQRCodeOptions: object

Type declaration:

Name Type
code string

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

SendFriendRequest

Ƭ SendFriendRequest: object

Type declaration:

Name Type
isCaptchaRequired boolean
success boolean

Defined in: client/apis/FriendsAPI.ts:157

SendFriendRequestOptions

Ƭ SendFriendRequestOptions: object

Type declaration:

Name Type
source? Unknown | string
userId number

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

UnFollowUser

Ƭ UnFollowUser: FollowUser

Defined in: client/apis/FriendsAPI.ts:162

UnFollowUserOptions

Ƭ UnFollowUserOptions: FollowUserOptions

Defined in: client/apis/FriendsAPI.ts:161

UnfriendUser

Ƭ UnfriendUser: unknown

Defined in: client/apis/FriendsAPI.ts:166

UnfriendUserOptions

Ƭ UnfriendUserOptions: object

Type declaration:

Name Type
userId number

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