Show / Hide Table of Contents

Interface IRecurringTransferService

Namespace: Eco.Gameplay.Economy.Jobs
Assembly: Eco.Gameplay.dll
Syntax
public interface IRecurringTransferService : IController, IViewController, IHasUniversalID, IThreadSafeSubscriptions, ISubscriptions<ThreadSafeSubscriptions>, ISubscriptions, INotifyPropertyChanged

Properties

AutoCreateAndUpdateTransferProps

true -> Auto create and update the transfers properties. false -> Whenever we want to update the transfers properties we should call UpdateTransfers(IRecurringTransferService). Sometimes we want to update the properties manually to prevent the transfers from being exploited like in RentForProperty.

Declaration
bool AutoCreateAndUpdateTransferProps { get; }
Property Value
Type Description
System.Boolean

Customers

Declaration
IEnumerable<User> Customers { get; }
Property Value
Type Description
System.Collections.Generic.IEnumerable<User>

IncomeOrExpense

Declaration
IncomeOrExpense IncomeOrExpense { get; }
Property Value
Type Description
IncomeOrExpense

MarkedUpName

Declaration
LocString MarkedUpName { get; }
Property Value
Type Description
LocString

PayAction

Declaration
RecurringPayment PayAction { get; }
Property Value
Type Description
RecurringPayment

RecurringTransferDefinition

Declaration
RecurringTransferDefinition RecurringTransferDefinition { get; }
Property Value
Type Description
RecurringTransferDefinition

RecurringTransferExcludedDeed

Declaration
Deed RecurringTransferExcludedDeed { get; }
Property Value
Type Description
Deed

RecurringTransfers

Declaration
IList<RecurringTransfer> RecurringTransfers { get; }
Property Value
Type Description
System.Collections.Generic.IList<RecurringTransfer>

RecurringTransfersActive

Declaration
bool RecurringTransfersActive { get; }
Property Value
Type Description
System.Boolean

TransferServiceAccount

Declaration
BankAccount TransferServiceAccount { get; }
Property Value
Type Description
BankAccount

TransfersLock

Declaration
object TransfersLock { get; }
Property Value
Type Description
System.Object

TransferType

Declaration
TransferType TransferType { get; }
Property Value
Type Description
TransferType

Methods

OnTransferFailed(RecurringTransfer, LocString)

Declaration
void OnTransferFailed(RecurringTransfer transfer, LocString result)
Parameters
Type Name Description
RecurringTransfer transfer
LocString result

OnTransferPropertiesUpdated()

Whenever customers are added, removed or the active state get changed, this get called to update the transfer properties.

Declaration
virtual void OnTransferPropertiesUpdated()

TransferTitle(User)

Declaration
LocString TransferTitle(User user)
Parameters
Type Name Description
User user
Returns
Type Description
LocString

Extension Methods

TagUtils.TagNames(Object, Boolean)
TagUtils.TagDisplayNames(Object, Boolean)
ClientSetViewExtensions.SetClassOfProperty(Object, Player, String, String, Int32)
RecurringTransferServiceExtensions.RegisterWages(IRecurringTransferService)
RecurringTransferServiceExtensions.DeregisterWages(IRecurringTransferService)
RecurringTransferServiceExtensions.DescribeRecurringChargeDefinitions(IRecurringTransferService)
RecurringTransferServiceExtensions.DescribeCurrentRecurringCharges(IRecurringTransferService)
RecurringTransferServiceExtensions.LeavingCustomers(IRecurringTransferService)
RecurringTransferServiceExtensions.MakeTransferForUser(IRecurringTransferService, User, BankAccount, Boolean)
RecurringTransferServiceExtensions.TryPayAll(IRecurringTransferService, Boolean)
RecurringTransferServiceExtensions.UpdateTransfers(IRecurringTransferService)
RecurringTransferServiceExtensions.UnpaidWages(IRecurringTransferService, User, LocString)
RecurringTransferServiceExtensions.ValidRecurringTransfer(IRecurringTransferService, LocString)
RecurringTransferServiceExtensions.GetRecurringTransferForCustomer(IRecurringTransferService, User)
RecurringTransferServiceExtensions.HasValidRecurringTransfer(IRecurringTransferService)
TypeTooltipExtensions.UILinkGeneric(Object)
EconomyTooltipLibrary.TooltipRecurringCharges(IRecurringTransferService)
☀
☾
In This Article
Back to top
Copyright (c) Strange Loop Games 2021
☀
☾