To get full access to the Kademi Hub existing customers can login here, or new customers can register here.
Flattened, JSON-friendly snapshot of a bid event, broadcast over the auctionBid websocket so connected clients can update an auction's leading bid live without a page reload. Combines fields from the new bid, the previous leading bid it replaced (if any), and the auction's current totals, avoiding the need for the client to hold or dereference the underlying entities. Built and sent by AuctionWebsockets whenever a bid is placed or an auction starts closing.
Properties
| Property | Returns | Description |
|---|---|---|
| action | AuctionBidAction | What kind of bid event this snapshot represents, e.g. a fresh bid, an outbid, or a self-outbid. |
| auctionCurrentBidCount | Integer | Running total of bids placed on the auction, as at the time this bid was placed. |
| auctionCurrentBidValue | BigDecimal | The auction's current leading bid value, as at the time this bid was placed. |
| auctionEndDate | long | When the auction closes. |
| beanType | String | Discriminator identifying the JSON payload shape to websocket clients. |
| bidDate | long | When this bid was placed. |
| bidderFormattedName | String | Display name of the profile who placed the new bid, formatted for presentation. |
| bidderHref | String | Link to the bidder's profile. |
| bidderName | String | Login name of the profile who placed the new bid. |
| bidValue | BigDecimal | The amount bid, in the auction's reward points bucket. |
| id | long | Database identifier of the underlying AuctionBid. |
| oldBidderFormattedName | String | Display name of the profile whose bid was replaced, formatted for presentation. |
| oldBidderHref | String | Link to the profile whose bid was replaced. |
| oldBidderName | String | Login name of the profile whose bid was replaced. |
| oldBidValue | BigDecimal | The value of the bid that was replaced by the new leading bid. |
Methods
getBeanType() · getBidDate() · getBidValue() · getBidderName() · getBidderHref() · getBidderFormattedName() · getOldBidValue() · getOldBidderName() · getOldBidderHref() · getOldBidderFormattedName() · getAuctionCurrentBidCount() · getAuctionEndDate() · getAuctionCurrentBidValue() · getId() · getAction()
getBeanType()
Returns: String
Discriminator identifying the JSON payload shape to websocket clients.
getBidDate()
Returns: long
When this bid was placed.
getBidValue()
Returns: BigDecimal
The amount bid, in the auction's reward points bucket.
getBidderName()
Returns: String
Login name of the profile who placed the new bid.
getBidderHref()
Returns: String
Link to the bidder's profile.
getBidderFormattedName()
Returns: String
Display name of the profile who placed the new bid, formatted for presentation.
getOldBidValue()
Returns: BigDecimal
The value of the bid that was replaced by the new leading bid.
getOldBidderName()
Returns: String
Login name of the profile whose bid was replaced.
getOldBidderHref()
Returns: String
Link to the profile whose bid was replaced.
getOldBidderFormattedName()
Returns: String
Display name of the profile whose bid was replaced, formatted for presentation.
getAuctionCurrentBidCount()
Returns: Integer
Running total of bids placed on the auction, as at the time this bid was placed.
getAuctionEndDate()
Returns: long
When the auction closes.
getAuctionCurrentBidValue()
Returns: BigDecimal
The auction's current leading bid value, as at the time this bid was placed.
getId()
Returns: long
Database identifier of the underlying AuctionBid.
getAction()
Returns: AuctionBidAction
What kind of bid event this snapshot represents, e.g. a fresh bid, an outbid, or a self-outbid.
© 2025 Kademi Ltd