Skip to main content

Leaderboard.SafeUserRecord

Class

Information for a user who submitted a score to the leaderboard, carrying only non-sensitive user data.

  • Available on all platforms
Platform details: Snapchat, SPECS, Camera Kit Web, Camera Kit Mobile fully supported.

Platform details

  • Snapchat — Fully supported.

  • SPECS — Fully supported.

  • Camera Kit Web — Fully supported.

  • Camera Kit Mobile — Fully supported.

Since Lens Scripting v375

Information for a user who submitted a score to the leaderboard, carrying only non-sensitive user data. Returned by Leaderboard#submitScoreSafeInfo.

Index

Example

function onScoreSubmitted(currentUserInfo) {
print(currentUserInfo.snapchatUser.name + " scored " + currentUserInfo.score);
print("Top " + currentUserInfo.globalRankPercentile + "%");
}

Extends

Properties

globalExactRank

readonly globalExactRank: number

The numerical rank of the user in the global leaderboard.

Since

Lens Scripting Version 375


globalRankPercentile

readonly globalRankPercentile: number

The percentile rank of the user in the global leaderboard.

Since

Lens Scripting Version 375


score

readonly score: number

The exact score of the user.

Since

Lens Scripting Version 375


snapchatUser

readonly snapchatUser: SafeUser

The submitting user, with only non-sensitive information: user id, Bitmoji, and a short name.

Since

Lens Scripting Version 375

Methods

getTypeName()

static getTypeName(): TypeName<SafeUserRecord>

Returns the fully-qualified JavaScript type name for this class (for example, "Component.Camera"). This is a static accessor (no instance required) and returns the same value as the instance getTypeName().

Returns

TypeName<SafeUserRecord>

Since

Lens Scripting Version 375

Overrides

ScriptObject.getTypeName


getTypeName()

getTypeName(): string

Returns the name of this object's type.

Returns

string

Inherited from

ScriptObject.getTypeName


isOfType()

isOfType(type): boolean

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

Parameters

ParameterType
typestring

Returns

boolean

Inherited from

ScriptObject.isOfType


isSame()

isSame(other): boolean

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

Parameters

ParameterType
otherScriptObject

Returns

boolean

Inherited from

ScriptObject.isSame