Interface SnapchatUser

Description

Represents a Snapchat user in order to pass to other APIs or to retrieve certain details about the user like display name.

interface SnapchatUser {
    birthday: SnapchatUserBirthday;
    displayName: string;
    friendInfo: SnapchatFriendUserInfo;
    hasBitmoji: boolean;
    userName: string;
    zodiac: Zodiac;
    getTypeName(): string;
    isOfType(type): boolean;
    isSame(other): boolean;
}

Hierarchy (view full)

Properties

birthday displayName friendInfo hasBitmoji userName zodiac

Methods

getTypeName isOfType isSame

Properties

Readonly birthday

birthday: SnapchatUserBirthday

Description

User's birth month and day. The month and day will start with the index of 1.

Readonly displayName

displayName: string

Description

Name a Snapchat user has chosen to be shown as. Note that not all users set their display name, so you should treat this value as such.

Readonly friendInfo

friendInfo: SnapchatFriendUserInfo

Description

Information about friendship between this friend and the active user like start date and streak.

Readonly hasBitmoji

hasBitmoji: boolean

Description

Whether this user has a bitmoji that can be retireved via BitmojiModule.

Readonly userName

userName: string

Description

Snapchat user's unique userName. Should not be relied on as a key because it can be changed.

Readonly zodiac

zodiac: Zodiac

Description

This user's zodiac.

Methods

getTypeName

  • getTypeName(): string

  • Returns string

    Description

    Returns the name of this object's type.

isOfType

  • isOfType(type): boolean

  • Parameters

    • type: string

    Returns boolean

    Description

    Returns true if the object matches or derives from the passed in type.

isSame

  • isSame(other): boolean

  • Parameters

    Returns boolean

    Description

    Returns true if this object is the same as other. Useful for checking if two references point to the same thing.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc