/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

#ifndef DEFAULT_BROWSER_NOTIFICATION_H_
#define DEFAULT_BROWSER_NOTIFICATION_H_

#include <string>

#include "nsStringFwd.h"

namespace mozilla::default_agent {

enum class NotificationType {
  Initial,
  Followup,
};

enum class NotificationShown {
  NotShown,
  Shown,
  Error,
};

enum class NotificationAction {
  DismissedByTimeout,
  DismissedToActionCenter,
  DismissedByButton,
  DismissedByApplicationHidden,
  RemindMeLater,
  MakeFirefoxDefaultButton,
  ToastClicked,
  NoAction,  // Should not be used with NotificationShown::Shown
};

struct NotificationActivities {
  NotificationType type;
  NotificationShown shown;
  NotificationAction action;
};

// These take enum values and get strings suitable for telemetry
std::string GetStringForNotificationType(NotificationType type);
std::string GetStringForNotificationShown(NotificationShown shown);
NotificationShown GetNotificationShownFromString(const nsAString& shown);
std::string GetStringForNotificationAction(NotificationAction action);
NotificationAction GetNotificationActionFromString(const nsAString& action);

// If actionString is a valid action string (i.e. corresponds to one of the
// NotificationAction values), this function has no effect. If actionString is
// not a valid action string, its value will be replaced with the string for
// NotificationAction::NoAction.
void EnsureValidNotificationAction(std::string& actionString);

}  // namespace mozilla::default_agent

#endif  // DEFAULT_BROWSER_NOTIFICATION_H_