InterfaceUserRecord

Information for a user who submitted a score to the leaderboard.

interface UserRecord {
    globalExactRank?: number;
    globalRankPercentile: number;
    score: number;
    snapchatUser: SnapchatUser;
    getTypeName(): string;
    isOfType(type: string): boolean;
    isSame(other: ScriptObject): boolean;
}

Hierarchy (view full)

ScriptObject
- UserRecord

Index

Properties

globalExactRank? globalRankPercentile score snapchatUser

Methods

getTypeName isOfType isSame

Properties

`Optional` `Readonly`globalExactRank

globalExactRank?: number

The numerical rank of the user in the global leaderboard.

`Readonly`globalRankPercentile

globalRankPercentile: number

The percentile rank of the user in the global leaderboard.

`Readonly`score

score: number

The exact score of the user.

`Readonly`snapchatUser

snapchatUser: SnapchatUser

The user which submitted the score. Display name and user name will not be available for global users.

Methods

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
- type: string
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
- other: ScriptObject
Returns boolean
Inherited from ScriptObject.isSame