snapcap
API ReferenceInterfaces

FriendsSnapshot

Interface: FriendsSnapshot

Defined in: api/friends/types.ts:235

A point-in-time view of the entire friend graph — mutuals + pending requests in both directions.

Remarks

Returned by IFriendsManager.snapshot (canonical) and the underlying source for IFriendsManager.list, IFriendsManager.receivedRequests, and IFriendsManager.sentRequests. The same object shape is delivered to IFriendsManager.onChange subscribers whenever any of the three slots mutates.

Properties

PropertyTypeDescriptionDefined in
mutualsFriend[]All mutually-confirmed friends.api/friends/types.ts:237
receivedReceivedRequest[]Pending inbound friend requests (others adding the logged-in user).api/friends/types.ts:239
sentSentRequest[]Pending outbound friend requests (the logged-in user's adds).api/friends/types.ts:241

On this page