API ReferenceInterfaces
Friend
Interface: Friend
Defined in: api/friends/types.ts:176
A friend in the logged-in user's social graph.
Superset of User with friend-link metadata and (when surfaced by the server) timestamps.
Extends
Indexable
[k: string]: unknownForward-compat for fields Snap adds to the public-info envelope.
Properties
| Property | Type | Description | Inherited from | Defined in |
|---|---|---|---|---|
addedAt? | Date | When the friend was added (server-side ms timestamp surfaced as a Date). | - | api/friends/types.ts:180 |
bitmojiPublicInfo? | BitmojiPublicInfo | Bitmoji avatar identifiers — see BitmojiPublicInfo. | FriendsUser.bitmojiPublicInfo | api/friends/types.ts:157 |
creatorSubscriptionProductsInfo? | unknown | Creator-subscription products envelope; shape varies, kept untyped. | FriendsUser.creatorSubscriptionProductsInfo | api/friends/types.ts:161 |
displayName? | string | Display name shown in the Snap UI. | FriendsUser.displayName | api/friends/types.ts:145 |
friendType | FriendLinkType | Link state — "mutual" for entries returned by IFriendsManager.list. | - | api/friends/types.ts:178 |
isOfficial? | boolean | true for verified Snap-official accounts. | FriendsUser.isOfficial | api/friends/types.ts:149 |
isPlusSubscriber? | boolean | true if the friend's account has Snapchat+. | - | api/friends/types.ts:184 |
isPopular? | boolean | true for accounts Snap surfaces as popular (high follower count, public profile, etc.). | FriendsUser.isPopular | api/friends/types.ts:151 |
isStoryMuted? | boolean | true if the logged-in user has muted this friend's story. | - | api/friends/types.ts:182 |
mutableUsername? | string | Current handle when the user has changed it (Snap retains the original username). | FriendsUser.mutableUsername | api/friends/types.ts:147 |
notFound? | true | Set only by IFriendsManager.getUsers when the server confirmed no record exists. | FriendsUser.notFound | api/friends/types.ts:164 |
profileLogo? | unknown | Profile-logo envelope; shape varies, kept untyped. | FriendsUser.profileLogo | api/friends/types.ts:159 |
profileTier? | number | Profile-tier int; semantics opaque (observed: 1 for typical accounts). | FriendsUser.profileTier | api/friends/types.ts:155 |
snapProId? | string | Snapchat+ subscription product id; empty string when not subscribed. | FriendsUser.snapProId | api/friends/types.ts:153 |
userId | string | Hyphenated UUID (string view of Snap's userId bytes). | FriendsUser.userId | api/friends/types.ts:140 |
username | string | Snap username (handle). May be empty when populated from a partial source. | FriendsUser.username | api/friends/types.ts:142 |