Skip to main content

Leaderboard.CreateOptions

Class

The options for the leaderboard to be made.

  • 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

name

name: string

The name of the leaderboard.

Default Value

""

orderingType

orderingType: OrderingType

How the leaderboard should be ordered.

Default Value

Leaderboard.OrderingType.Descending

ttlSeconds

ttlSeconds: number

How long the leaderboard should last.

Default Value

0

Methods

create()

static create(): CreateOptions

Create the option.

Returns

CreateOptions


getTypeName()

static getTypeName(): TypeName<CreateOptions>

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

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