Class: default

client/apis/FriendsAPI.default

Hierarchy

• default

↳ default

Table of contents

Constructors

• constructor

Properties

• client
• options

Methods

• acceptFriendRequest
• checkSessionHealth
• declineAllFriendRequests
• declineFriendRequest
• deleteFriendQRSession
• deleteFriendSession
• findFriendByCode
• followUser
• getFriendQRSession
• getMetaData
• getRecommendedUsers
• getSelfFriendRequests
• getSelfFriendRequestsCount
• getSelfFriendsCount
• getSession
• getUserFollowers
• getUserFollowersCount
• getUserFollowing
• getUserFollowingCount
• getUserFriends
• getUserFriendsCount
• getUserFriendsOnline
• getUserFriendsWithStatuses
• redeemFriendCode
• redeemFriendQRCode
• request
• sendFriendRequest
• unFollowUser
• unfriendUser

Constructors

constructor

+ new default(client: default): default

Parameters:

Name	Type
client	default

Returns: default

Inherited from: default

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

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<unknown>

Parameters:

Name	Type
options	AcceptFriendRequestOptions

Returns: Promise<unknown>

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

---

checkSessionHealth

▸ checkSessionHealth(): Promise<unknown>

Returns: Promise<unknown>

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

---

declineAllFriendRequests

▸ declineAllFriendRequests(): Promise<unknown>

Returns: Promise<unknown>

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

---

declineFriendRequest

▸ declineFriendRequest(options: AcceptFriendRequestOptions): Promise<unknown>

Parameters:

Name	Type
options	AcceptFriendRequestOptions

Returns: Promise<unknown>

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

---

deleteFriendQRSession

▸ deleteFriendQRSession(): Promise<unknown>

Returns: Promise<unknown>

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

---

deleteFriendSession

▸ deleteFriendSession(): Promise<unknown>

Returns: Promise<unknown>

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

---

findFriendByCode

▸ findFriendByCode(options: FindFriendByCodeOptions): Promise<FindFriendByCode>

Parameters:

Name	Type
options	FindFriendByCodeOptions

Returns: Promise<FindFriendByCode>

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

---

followUser

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

Parameters:

Name	Type
options	FollowUserOptions

Returns: Promise<FollowUser>

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

---

getFriendQRSession

▸ getFriendQRSession(): Promise<GetOrCreateNearbySession>

Returns: Promise<GetOrCreateNearbySession>

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

---

getMetaData

▸ getMetaData(options: GetMetaDataOptions): Promise<GetMetaData>

Parameters:

Name	Type
options	GetMetaDataOptions

Returns: Promise<GetMetaData>

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

---

getRecommendedUsers

▸ getRecommendedUsers(): Promise<GetSelfRecommendedUsers>

Returns: Promise<GetSelfRecommendedUsers>

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

---

getSelfFriendRequests

▸ getSelfFriendRequests(options: GetSelfFriendRequestsOptions): Promise<GetSelfFriendRequests>

Parameters:

Name	Type
options	GetSelfFriendRequestsOptions

Returns: Promise<GetSelfFriendRequests>

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

---

getSelfFriendRequestsCount

▸ getSelfFriendRequestsCount(): Promise<GetSelfFriendRequestsCount>

Returns: Promise<GetSelfFriendRequestsCount>

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

---

getSelfFriendsCount

▸ getSelfFriendsCount(): Promise<GetSelfFriendsCount>

Returns: Promise<GetSelfFriendsCount>

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

---

getSession

▸ getSession(): Promise<FindFriendByCode>

Returns: Promise<FindFriendByCode>

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

---

getUserFollowers

▸ getUserFollowers(options: GetUserFollowersOptions): Promise<GetUserFollowers>

Parameters:

Name	Type
options	GetUserFollowersOptions

Returns: Promise<GetUserFollowers>

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

---

getUserFollowersCount

▸ getUserFollowersCount(options: GetUserFollowersCountOptions): Promise<GetUserFollowersCount>

Parameters:

Name	Type
options	GetUserFollowersCountOptions

Returns: Promise<GetUserFollowersCount>

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

---

getUserFollowing

▸ getUserFollowing(options: GetUserFollowersOptions): Promise<GetUserFollowers>

Parameters:

Name	Type
options	GetUserFollowersOptions

Returns: Promise<GetUserFollowers>

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

---

getUserFollowingCount

▸ getUserFollowingCount(options: GetUserFollowersCountOptions): Promise<GetUserFollowersCount>

Parameters:

Name	Type
options	GetUserFollowersCountOptions

Returns: Promise<GetUserFollowersCount>

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

---

getUserFriends

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

Parameters:

Name	Type
options	GetUserFriendsOptions

Returns: Promise<GetUserFriends>

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

---

getUserFriendsCount

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

Parameters:

Name	Type
options	GetUserFriendsCountOptions

Returns: Promise<GetUserFriendsCount>

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

---

getUserFriendsOnline

▸ getUserFriendsOnline(options: GetUserOnlineFriendsOptions): Promise<GetUserOnlineFriends>

Parameters:

Name	Type
options	GetUserOnlineFriendsOptions

Returns: Promise<GetUserOnlineFriends>

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

---

getUserFriendsWithStatuses

▸ getUserFriendsWithStatuses(options: GetUserFriendsWithStatusesOptions): Promise<GetUserFriendsWithStatuses>

Parameters:

Name	Type
options	GetUserFriendsWithStatusesOptions

Returns: Promise<GetUserFriendsWithStatuses>

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

---

redeemFriendCode

▸ redeemFriendCode(options: RedeemNearbyFriendCodeOptions): Promise<unknown>

Parameters:

Name	Type
options	RedeemNearbyFriendCodeOptions

Returns: Promise<unknown>

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

---

redeemFriendQRCode

▸ redeemFriendQRCode(options: RedeemQRCodeOptions): Promise<RedeemQRCode>

Parameters:

Name	Type
options	RedeemQRCodeOptions

Returns: Promise<RedeemQRCode>

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

---

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<SendFriendRequest>

Parameters:

Name	Type
options	SendFriendRequestOptions

Returns: Promise<SendFriendRequest>

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

---

unFollowUser

▸ unFollowUser(options: FollowUserOptions): Promise<FollowUser>

Parameters:

Name	Type
options	FollowUserOptions

Returns: Promise<FollowUser>

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

---

unfriendUser

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

Parameters:

Name	Type
options	UnfriendUserOptions

Returns: Promise<unknown>

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