jenkins.plugins.htmlaudio.app

Interface NotificationService

All Known Implementing Classes:

DefaultNotificationService

public interface NotificationService

Author:

Lars Hvile

Method Summary

Methods

Modifier and Type	Method and Description
void	recordBuildCompletion(String buildDetails, hudson.model.Result result, hudson.model.Result previousResult) Records the completion of a build, which may turn out to generate a notification.
NewNotificationsResult	waitForNewNotifications(NotificationId previous, long timeoutMs) Returns every Notification that has been registered after the previously encountered notification, or waits for new ones to arrive.

Method Detail

waitForNewNotifications

NewNotificationsResult waitForNewNotifications(NotificationId previous,
                                             long timeoutMs)

Returns every Notification that has been registered after the previously encountered notification, or waits for new ones to arrive.

Parameters:

previous - the last encountered NotificationId or null to list all each one

timeoutMs - the number of milliseconds to wait for new notifications before returning an empty result

Returns:

a NewNotificationsResult

recordBuildCompletion

void recordBuildCompletion(String buildDetails,
                         hudson.model.Result result,
                         hudson.model.Result previousResult)

Records the completion of a build, which may turn out to generate a notification.

Parameters:

buildDetails - a simple string-representation of the build that completed

result - the outcome of the build

previousResult - the outcome of the previous build or null