mn.foreman.api.endpoints.notifications

Interface Notifications

All Known Implementing Classes:

NotificationsImpl

public interface Notifications

A Notifications provides a handler for interacting with the /api/notifications Foreman API endpoint.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Notifications.Notification A notification.

Method Summary

Modifier and Type	Method and Description
List<Notifications.Notification>	discord(int sinceId, java.time.Instant sinceTimestamp) Obtains the Discord notifications.
List<Notifications.Notification>	googleChat(int sinceId, java.time.Instant sinceTimestamp) Obtains the Google Chat notifications.
List<Notifications.Notification>	slack(int sinceId, java.time.Instant sinceTimestamp) Obtains the Slack notifications.
List<Notifications.Notification>	telegram(int sinceId, java.time.Instant sinceTimestamp) Obtains the Telegram notifications.

Method Detail

discord

List<Notifications.Notification> discord(int sinceId,
                                         java.time.Instant sinceTimestamp)

Obtains the Discord notifications.

Parameters:

sinceId - The previously observed id (-1 to disable).

sinceTimestamp - The cutoff date (null to disable).

Returns:

The Discord notifications.

googleChat

List<Notifications.Notification> googleChat(int sinceId,
                                            java.time.Instant sinceTimestamp)

Obtains the Google Chat notifications.

Parameters:

sinceId - The previously observed id (-1 to disable).

sinceTimestamp - The cutoff date (null to disable).

Returns:

The Google Chat notifications.

slack

List<Notifications.Notification> slack(int sinceId,
                                       java.time.Instant sinceTimestamp)

Obtains the Slack notifications.

Parameters:

sinceId - The previously observed id (-1 to disable).

sinceTimestamp - The cutoff date (null to disable).

Returns:

The Slack notifications.

telegram

List<Notifications.Notification> telegram(int sinceId,
                                          java.time.Instant sinceTimestamp)

Obtains the Telegram notifications.

Parameters:

sinceId - The previously observed id (-1 to disable).

sinceTimestamp - The cutoff date (null to disable).

Returns:

The Telegram notifications.