Interface MessageSender
-
- All Superinterfaces:
ServerExtension,TeamCityExtension
public interface MessageSender extends ServerExtension
Simple messenger extension point.- Since:
- 5.0
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Stringdescribe()Returns name / description of this message sender (e.g.StringgetAddress(SUser user)Returns address which can be used to send message to the specified uservoidsendMessage(String shortSummary, String message, Set<String> recipients)Sends a message to specified recipients
-
-
-
Method Detail
-
sendMessage
void sendMessage(@Nullable String shortSummary, @NotNull String message, @NotNull Set<String> recipients) throws SendFailedExceptionSends a message to specified recipients- Parameters:
shortSummary- message summary (e.g. subject for email), can be nullmessage- message textrecipients- collection of recipients- Throws:
SendFailedException- if failed to send message
-
getAddress
@Nullable String getAddress(@NotNull SUser user)
Returns address which can be used to send message to the specified user- Parameters:
user- recipient- Returns:
- address or null if message sender can't send message to the specified user
-
describe
@NotNull String describe()
Returns name / description of this message sender (e.g. Email, Jabber and so on)- Returns:
- see above
-
-