Skip to main content

Leaderboard.RetrievalOptions

Class

Describes the context for the leaderboard to be requested.

  • 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.

Index

Extends

Properties

usersLimit

usersLimit: number

The number of users to be retrieved. The number should be >= 0.

Default Value

64

usersType

usersType: UsersType

The type of users to be retrieved.

Default Value

Leaderboard.UsersType.Friends

Methods

create()

static create(): RetrievalOptions

Creates the option.

Returns

RetrievalOptions


getTypeName()

static getTypeName(): TypeName<RetrievalOptions>

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<RetrievalOptions>

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