HacksMessageBuilder
@spotify/backstage-plugin-skill-exchange-node/alpha > HacksMessageBuilder
The HacksMessageBuilder interface defines the contract for building messages used for Skill Exchange Hack notifications.
Interface
| Method | Description | Parameters | Type | Parameter Description |
|---|---|---|---|---|
buildInquiryMessage | Builds a message to be sent to the post owner that someone expressed interest in their post | postUrl | string | URL of the post |
postTitle | string | Title of the post | ||
sender | string | Name or user ID of the person expressing interest | ||
customMessage | string (optional) | Custom message from the sender | ||
buildInquiryConfirmationMessage | Builds a confirmation message to be sent to the sender that their interest in the post was sent to the contact person | postUrl | string | URL of the post |
postTitle | string | Title of the post | ||
postContact | string | Name or user ID of the post contact | ||
buildInquiryReminderMessage | Builds a message to remind a post owner about an inquiry they received | postUrl | string | URL of the post |
postTitle | string | Title of the post | ||
sender | string | Name or user ID of the person who sent the inquiry | ||
duration | string | Time duration since the inquiry was sent | ||
buildStopInquiryRemindersConfirmationMessage | Builds a confirmation message that reminders about an inquiry have been stopped | No parameters | ||
buildErrorOnActionMessage | Builds a message to notify user that an error occurred when trying to perform an action | No parameters | ||
buildParticipantAddedMessage | Builds a message to notify a user that they were added as a participant to a post | postUrl | string | URL of the post |
postTitle | string | Title of the post | ||
postContact | string | Name or user ID of the post contact | ||
buildParticipantAddedConfirmationMessage | Builds a confirmation message to notify the post contact that a user was successfully added as a participant | participant | string | Name or user ID of the participant who was added |
buildSavedSearchMatchMessage | Builds a message to notify a user that a new post matches their saved search criteria | postUrl | string | URL of the matching post |
postTitle | string | Title of the matching post | ||
buildHackDigestMessage | Builds a message that summarizes updates of posts that a user is following | args | HackDigestMessageArgs[] | Array of post update information |
Types
HackDigestMessageArgs
| Property | Type | Description |
|---|---|---|
postUrl | string | URL of the post |
postTitle | string | Title of the post |
newComments | number | Number of new comments |
newUpdates | number | Number of new updates |