Skip to main content

# LoanEvents

    type LoanEvents = {
      loan.applicationselected: LoanApplicationSelectedListener;
      loan.change: LoanChangeListener;
      loan.close: LoanCloseListener;
      loan.committed: LoanCommittedListener;
      loan.editModeChange: LoanEditModeChangeListener;
      loan.externallyModified: LoanExternallyModifiedListener;
      loan.fieldChangeSync: LoanFieldChangeSyncListener;
      loan.milestoneCompleted: LoanMilestoneCompletedListener;
      loan.open: LoanOpenListener;
      loan.precommit: LoanPreCommitListener;
      loan.premilestonecomplete: LoanPreMilestoneCompleteListener;
      loan.sync: LoanSyncListener;
    };

Event types available for loan-related operations.

This type defines all the events that can be emitted during a loan's lifecycle, from opening and editing to committing and closing. Each event type maps to its corresponding listener type that handles the event.

## Remarks​

Events are fired at different stages of loan processing:

- Application selection and opening (`loan.applicationselected`, `loan.open`)
- User interactions and changes (`loan.change`, `loan.fieldChangeSync`, `loan.editModeChange`)
- Pre-commit validation (`loan.precommit`)
- Committing changes (`loan.committed`)
- Milestone operations (`loan.premilestonecomplete`, `loan.milestoneCompleted`)
- Synchronization (`loan.sync`)
- External modifications (`loan.externallyModified`)
- Closing (`loan.close`)

    @see {@link LoanApplicationSelectedListener}
    @see {@link LoanChangeListener}
    @see {@link LoanCommittedListener}
    @see {@link LoanCloseListener}
    @see {@link LoanEditModeChangeListener}
    @see {@link LoanExternallyModifiedListener}
    @see {@link LoanFieldChangeSyncListener}
    @see {@link LoanMilestoneCompletedListener}
    @see {@link LoanOpenListener}
    @see {@link LoanPreCommitListener}
    @see {@link LoanPreMilestoneCompleteListener}
    @see {@link LoanSyncListener}

    ## Properties

    ### loan.applicationselected

    ```ts
    loan.applicationselected: LoanApplicationSelectedListener;

Event is fired when a borrower pair changes

Use LoanApplicationSelectedListener to handle this event

### loan.change​

    loan.change: LoanChangeListener;

Event is fired for each change made by the user in the UI

Use LoanChangeListener to handle this event

### loan.close​

    loan.close: LoanCloseListener;

Event is fired just prior to closing the loan in the UI

Use LoanCloseListener to handle this event

### loan.committed​

    loan.committed: LoanCommittedListener;

Event is fired after pending changes to the loan are committed

Use LoanCommittedListener to handle this event

### loan.editModeChange​

    loan.editModeChange: LoanEditModeChangeListener;

Event is fired when loan edit mode changes

Use LoanEditModeChangeListener to handle this event

### loan.externallyModified​

    loan.externallyModified: LoanExternallyModifiedListener;

Event is fired when the loan is modified outside the current user interface, such as by automation, another user, or developer connect.

This event does not include information about what changed.

Use LoanExternallyModifiedListener to handle this event

### loan.fieldChangeSync​

    loan.fieldChangeSync: LoanFieldChangeSyncListener;

Event is fired when a loan field is changed

Use LoanFieldChangeSyncListener to handle this event

### loan.milestoneCompleted​

    loan.milestoneCompleted: LoanMilestoneCompletedListener;

Event is fired after a milestone is completed by the user and committed to the server

Use LoanMilestoneCompletedListener to handle this event

### loan.open​

    loan.open: LoanOpenListener;

Event is fired after the loan is opened and ready for user interaction

Use LoanOpenListener to handle this event

### loan.precommit​

    loan.precommit: LoanPreCommitListener;

Event is fired prior to saving any pending changes to the loan.

The guest can use this event to perform custom validation and, via the feedback mechanism, prevent the loan from being saved

Use LoanPreCommitListener to handle this event

### loan.premilestonecomplete​

    loan.premilestonecomplete: LoanPreMilestoneCompleteListener;

Event is fired when the user attempts to complete a milestone and allows for custom validation, and cancellation, of the process

Use LoanPreMilestoneCompleteListener to handle this event

### loan.sync​

    loan.sync: LoanSyncListener;

Event is fired after the loan is sync'ed within any saved state made outside of the user's workspace.

use LoanSyncListener to handle this event