com.google.firebase.messaging.WebpushNotification Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of firebase-admin Show documentation

This is the official Firebase Admin Java SDK. Build extraordinary native JVM apps in minutes with Firebase. The Firebase platform can power your app’s backend, user authentication, static hosting, and more.

There is a newer version: 9.3.0

Show newest version

/*
 * Copyright 2018 Google Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.google.firebase.messaging;

import com.google.api.client.util.Key;
import com.google.firebase.internal.Nullable;

/**
 * Represents the Webpush-specific notification options that can be included in a {@link Message}.
 * Instances of this class are thread-safe and immutable.
 */
public class WebpushNotification {

  @Key("title")
  private final String title;

  @Key("body")
  private final String body;

  @Key("icon")
  private final String icon;

  /**
   * Creates a new notification with the given title and body. Overrides the options set via
   * {@link Notification}.
   *
   * @param title Title of the notification.
   * @param body Body of the notification.
   */
  public WebpushNotification(String title, String body) {
    this(title, body, null);
  }

  /**
   * Creates a new notification with the given title, body and icon. Overrides the options set via
   * {@link Notification}.
   *
   * @param title Title of the notification.
   * @param body Body of the notification.
   * @param icon URL to the notifications icon.
   */
  public WebpushNotification(String title, String body, @Nullable String icon) {
    this.title = title;
    this.body = body;
    this.icon = icon;
  }
}