Tink Money Manager SDK/com.tink.moneymanagerui.insights.actionhandling/InsightActionHandler

InsightActionHandler

This interface contains a set of methods that you can implement to perform the necessary logic when a user selects an action for an insight that requires more user interaction.

All the methods have a Boolean return type to indicate if the action is handled by this handler or not. If you are overriding a method to perform custom logic for the action, the method should return true.

For methods with a onComplete lambda block parameter, you have to invoke the lambda block when the task related to the requested action has completed or been cancelled. If the action has completed successfully, the block can be invoked with the boolean value set to true. Eg: onComplete.invoke(true) If the action has failed or is cancelled, the block can be invoked with the boolean value set to false. Eg: onComplete.invoke(false) If you don’t invoke the onComplete block, the insight will remain in the list and will not be archived.

Functions

categorizeExpense

open fun categorizeExpense(transactionId: String, onComplete: (isActionDone: Boolean) -> Unit): Boolean

Handle action where the user wants to categorize a transaction matching the id. This corresponds to InsightAction.Type.CATEGORIZE_EXPENSE action type.

categorizeTransactions

open fun categorizeTransactions(transactionIds: List<String>, onComplete: (isActionDone: Boolean) -> Unit): Boolean

Handle action where the user wants to categorize multiple transactions matching a list of ids. This corresponds to InsightAction.Type.CATEGORIZE_TRANSACTIONS action type.

createBudget

open fun createBudget( amount: Amount?, filter: BudgetFilter?, periodicity: BudgetPeriodicity?, onComplete: (isActionDone: Boolean) -> Unit): Boolean

Handle action where the user wants to create a budget. This corresponds to InsightAction.Type.CREATE_BUDGET action type.

initiateTransfer

open fun initiateTransfer( sourceUri: String?, sourceAccountNumber: String?, destinationUri: String?, destinationAccountNumber: String?, amount: Amount?, onComplete: (isActionDone: Boolean) -> Unit): Boolean

Handle action where the user wants to make a transfer. This corresponds to InsightAction.Type.CREATE_TRANSFER action type.

refreshCredentials

open fun refreshCredentials(credentialId: String, onComplete: (isActionDone: Boolean) -> Unit): Boolean

Handle action where the user requests to refresh an aggregated credential. This corresponds to InsightAction.Type.REFRESH_CREDENTIAL action type.

viewAccount

open fun viewAccount(accountId: String): Boolean

Handle action where the user wants to view account matching the id. This corresponds to InsightAction.Type.VIEW_ACCOUNT and InsightAction.Type.VIEW_TRANSACTIONS action types.

viewBudget

open fun viewBudget(budgetId: String, periodStart: String): Boolean

Handle action where the user wants to view information for a budget matching the id and start period. This corresponds to InsightAction.Type.VIEW_BUDGET action type.

viewLeftToSpend

open fun viewLeftToSpend(month: YearMonth): Boolean

Handle action where the user wants to view the Monthly LEFT_TO_SPEND for the corresponding month. This corresponds to InsightAction.Type.VIEW_LEFT_TO_SPEND action type.

viewRecurringCostTooHigh

open fun viewRecurringCostTooHigh(month: YearMonth): Boolean

Handle action where the user wants to view the Monthly RECURRING_EXPENSE_BY_COST for the corresponding month. This corresponds to InsightAction.Type.VIEW_RECURRING_EXPENSE_BY_COST action type.

viewSafeToSpend

open fun viewSafeToSpend(month: YearMonth): Boolean

Handle action where the user wants to view the Monthly SAFE_TO_SPEND for the corresponding month. This corresponds to InsightAction.Type.VIEW_SAFE_TO_SPEND action type.

viewTransactions

open fun viewTransactions(transactionIds: List<String>): Boolean

Handle action where the user wants to view transactions matching the list of ids. This corresponds to InsightAction.Type.VIEW_TRANSACTION and InsightAction.Type.VIEW_TRANSACTIONS action types.

viewTransactionsByCategory

open fun viewTransactionsByCategory(transactionsByCategory: Map<String, List<String>>): Boolean

Handle action where the user wants to view transactions by categories. This corresponds to InsightAction.Type.VIEW_TRANSACTIONS_BY_CATEGORY action type.