Class LeaderboardsService

Inheritance

Object

LeaderboardsService

EventLeaderboardsService

Implements

ILeaderboardsService

IService

ITimerListener

Namespace: IdleKit.Gameplay

Assembly: cs.temp.dll.dll

Syntax

public class LeaderboardsService : ServiceBase, ILeaderboardsService, IService, ITimerListener

Fields

_actionService

Declaration

protected IActionService _actionService

Field Value

Type	Description
IActionService

_beamable

Declaration

protected Beamable _beamable

Field Value

Type	Description
Beamable

_beamableLeaderboards

Declaration

protected LeaderboardService _beamableLeaderboards

Field Value

Type	Description
LeaderboardService

_currencyDifferenceSinceLastChange

Declaration

protected double _currencyDifferenceSinceLastChange

Field Value

Type	Description
Double

_entityResolver

Declaration

protected IEntityResolver _entityResolver

Field Value

Type	Description
IEntityResolver

_eventService

Declaration

protected IEventService _eventService

Field Value

Type	Description
IEventService

_leaderboardTools

Declaration

protected LeaderboardsTools _leaderboardTools

Field Value

Type	Description
LeaderboardsTools

_progress

Declaration

protected float _progress

Field Value

Type	Description
Single

_timerService

Declaration

protected ITimerService _timerService

Field Value

Type	Description
ITimerService

_timerSubscription

Declaration

protected TimerSubscription _timerSubscription

Field Value

Type	Description
TimerSubscription

_userSavedData

Declaration

protected IUserSavedData _userSavedData

Field Value

Type	Description
IUserSavedData

_userStatsService

Declaration

protected IUserStatsService _userStatsService

Field Value

Type	Description
IUserStatsService

Properties

CurrencyDifferenceSinceLastChange

Declaration

public virtual double CurrencyDifferenceSinceLastChange { get; }

Property Value

Type	Description
Double

LeaderboardUpdateInterval

Declaration

protected virtual int LeaderboardUpdateInterval { get; }

Property Value

Type	Description
Int32

Progress

Declaration

public virtual float Progress { get; }

Property Value

Type	Description
Single

TimerSubscription

Declaration

public virtual ITimerSubscription TimerSubscription { get; }

Property Value

Type	Description
ITimerSubscription

USERNAME_KEY

Declaration

protected virtual string USERNAME_KEY { get; }

Property Value

Type	Description
String

Methods

AssertProfanity(String)

Declaration

protected virtual Task<bool> AssertProfanity(string username)

Parameters

Type	Name	Description
String	username

Returns

Type	Description
Task<Boolean>

CleanupService()

Declaration

protected override void CleanupService()

GetLeaderboard(String, Int32, Action<List<LeaderboardEntry>>, Int32, Nullable<Int64>, Nullable<Int64>)

Declaration

public virtual void GetLeaderboard(string leaderboardId, int maxEntryNumber, Action<List<LeaderboardEntry>> onLeaderboardRetrieved, int startEntryNumber = 0, long? focusUid = default(long? ), long? appendUid = default(long? ))

Parameters

Type	Name	Description
String	leaderboardId
Int32	maxEntryNumber
Action<List<LeaderboardEntry>>	onLeaderboardRetrieved
Int32	startEntryNumber
Nullable<Int64>	focusUid
Nullable<Int64>	appendUid

GetLeaderboardAsync(String, Int32, Action<List<LeaderboardEntry>>, Int32, Nullable<Int64>, Nullable<Int64>)

Declaration

protected virtual Task GetLeaderboardAsync(string leaderboardId, int maxEntryNumber, Action<List<LeaderboardEntry>> onLeaderboardRetrieved, int startEntryNumber = 0, long? focusUid = default(long? ), long? appendUid = default(long? ))

Parameters

Type	Name	Description
String	leaderboardId
Int32	maxEntryNumber
Action<List<LeaderboardEntry>>	onLeaderboardRetrieved
Int32	startEntryNumber
Nullable<Int64>	focusUid
Nullable<Int64>	appendUid

Returns

Type	Description
Task

GetLeaderboardUsername(String, Action<String>)

Declaration

public virtual void GetLeaderboardUsername(string leaderboardId, Action<string> onComplete)

Parameters

Type	Name	Description
String	leaderboardId
Action<String>	onComplete

GetUsernameKey(String)

Declaration

public virtual string GetUsernameKey(string leaderboardId)

Parameters

Type	Name	Description
String	leaderboardId

Returns

Type	Description
String

IncrementLeaderboardScore(String, Double, Dictionary<String, Object>)

Declaration

public virtual void IncrementLeaderboardScore(string leaderboardId, double incrementAmount, Dictionary<string, object> optionalParameters = null)

Parameters

Type	Name	Description
String	leaderboardId
Double	incrementAmount
Dictionary<String, Object>	optionalParameters

IncrementLeaderboardScoreAsync(String, Double, Dictionary<String, Object>)

Declaration

protected virtual Task IncrementLeaderboardScoreAsync(string leaderboardId, double incrementAmount, Dictionary<string, object> optionalParameters = null)

Parameters

Type	Name	Description
String	leaderboardId
Double	incrementAmount
Dictionary<String, Object>	optionalParameters

Returns

Type	Description
Task

InitializeService()

Declaration

protected override void InitializeService()

Inject(IResolver)

Declaration

public override void Inject(IResolver resolver)

Parameters

Type	Name	Description
IResolver	resolver

OnContentSetStateAction(SetContentStateAction)

Declaration

protected virtual void OnContentSetStateAction(SetContentStateAction setContentStateAction)

Parameters

Type	Name	Description
SetContentStateAction	setContentStateAction

OnCurrencyChangedAction(CurrencyChangedAction)

Declaration

protected virtual void OnCurrencyChangedAction(CurrencyChangedAction action)

Parameters

Type	Name	Description
CurrencyChangedAction	action

OnTimerEnded(Int64)

Declaration

public virtual void OnTimerEnded(long count)

Parameters

Type	Name	Description
Int64	count

SetLeaderboardScore(String, Double, Dictionary<String, Object>)

Declaration

public virtual void SetLeaderboardScore(string leaderboardId, double score, Dictionary<string, object> optionalParameters = null)

Parameters

Type	Name	Description
String	leaderboardId
Double	score
Dictionary<String, Object>	optionalParameters

SetLeaderboardScoreAsync(String, Double, IDictionary<String, Object>)

Declaration

protected virtual Task SetLeaderboardScoreAsync(string leaderboardId, double score, IDictionary<string, object> optionalParameters = null)

Parameters

Type	Name	Description
String	leaderboardId
Double	score
IDictionary<String, Object>	optionalParameters

Returns

Type	Description
Task

SetLeaderboardUsername(String, String, Action<String>)

Declaration

public virtual void SetLeaderboardUsername(string leaderboardId, string username, Action<string> onUsernameSet = null)

Parameters

Type	Name	Description
String	leaderboardId
String	username
Action<String>	onUsernameSet

SetLeaderboardUsernameAsync(String, String, Action<String>)

Declaration

protected virtual Task SetLeaderboardUsernameAsync(string leaderboardId, string username, Action<string> onUsernameSet = null)

Parameters

Type	Name	Description
String	leaderboardId
String	username
Action<String>	onUsernameSet

Returns

Type	Description
Task

SubscribeTimerListener()

Declaration

protected virtual void SubscribeTimerListener()

UnsubscribeTimerListener()

Declaration

protected virtual void UnsubscribeTimerListener()

UpdateCurrentLeaderboardWithDifference()

Declaration

protected virtual void UpdateCurrentLeaderboardWithDifference()

UpdateProgression(Single)

Declaration

public virtual void UpdateProgression(float progression)

Parameters

Type	Name	Description
Single	progression

Implements

ILeaderboardsService

IService

ITimerListener