Lens Scripting API

    Class SnapchatUser

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

    Hierarchy (View Summary, Expand)

    Index

    Constructors

    constructor

    Properties

    birthday? displayName? friendInfo? hasBitmoji userName zodiac?

    Methods

    getTypeName isOfType isSame

    Constructors

    Properties

    birthday?: SnapchatUserBirthday

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

    displayName?: string

    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.

    friendInfo?: SnapchatFriendUserInfo

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

    hasBitmoji: boolean

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

    userName: string

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

    zodiac?: Zodiac

    This user's zodiac.

    Methods

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

      Parameters

      • type: string

      Returns boolean

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

      Parameters

      Returns boolean

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    MMNEPVFCICPMFPCPTTAAATR