Class DonationAlertsGoalUpdateEvent

Represents Donation Alerts goal update object.

Hierarchy

DataObject<DonationAlertsGoalUpdateEventData>
- DonationAlertsGoalUpdateEvent

Index

Accessors

currency expiryDate goalAmount id isActive raisedAmount startAmount startDate title

Accessors

currency

get currency(): DonationAlertsInputCurrency
The currency code of the donation goal (ISO 4217 formatted).

Returns DonationAlertsInputCurrency
- Defined in packages/events/src/events/goals/DonationAlertsGoalUpdateEvent.ts:51

expiryDate

get expiryDate(): null | Date
The date and time when donation goal is scheduled to end. Or null if end date is not set.

Returns null | Date
- Defined in packages/events/src/events/goals/DonationAlertsGoalUpdateEvent.ts:86

goalAmount

get goalAmount(): number
Goal amount of the donation goal.

Returns number
- Defined in packages/events/src/events/goals/DonationAlertsGoalUpdateEvent.ts:72

id

get id(): number
The unique donation goal identifier.

Returns number
- Defined in packages/events/src/events/goals/DonationAlertsGoalUpdateEvent.ts:30

isActive

get isActive(): boolean
A flag indicating whether the donation goal is in progress or not.

Returns boolean
- Defined in packages/events/src/events/goals/DonationAlertsGoalUpdateEvent.ts:37

raisedAmount

get raisedAmount(): number
Currently raised amount including the startAmount value.

Returns number
- Defined in packages/events/src/events/goals/DonationAlertsGoalUpdateEvent.ts:65

startAmount

get startAmount(): number
Starting amount of the donation goal.

Returns number
- Defined in packages/events/src/events/goals/DonationAlertsGoalUpdateEvent.ts:58

startDate

get startDate(): Date
The date and time when donation goal was started.

Returns Date
- Defined in packages/events/src/events/goals/DonationAlertsGoalUpdateEvent.ts:79

title

get title(): string
The donation goal title.

Returns string
- Defined in packages/events/src/events/goals/DonationAlertsGoalUpdateEvent.ts:44

Generated using TypeDoc