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

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.2.0

Show newest version

/*
 * 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;

/**
 * Represents the APNS-specific FCM options that can be included in an {@link ApnsConfig}. Instances
 * of this class are thread-safe and immutable.
 */
public final class ApnsFcmOptions {

  @Key("analytics_label")
  private final String analyticsLabel;
  
  @Key("image")
  private final String image;

  private ApnsFcmOptions(Builder builder) {
    FcmOptionsUtil.checkAnalyticsLabel(builder.analyticsLabel);
    this.analyticsLabel = builder.analyticsLabel;
    this.image = builder.image;
  }

  /**
   * Creates a new {@link ApnsFcmOptions} object with the specified analytics label.
   *
   * @param analyticsLabel An analytics label
   * @return An {@link ApnsFcmOptions} object with the analytics label set to the supplied value.
   */
  public static ApnsFcmOptions withAnalyticsLabel(String analyticsLabel) {
    return builder().setAnalyticsLabel(analyticsLabel).build();
  }

  /**
   * Creates a new {@link ApnsFcmOptions.Builder}.
   *
   * @return An {@link ApnsFcmOptions.Builder} instance.
   */
  public static Builder builder() {
    return new Builder();
  }

  public static class Builder {

    private String analyticsLabel;

    private String image;

    private Builder() {}

    /**
     * @param analyticsLabel A string representing the analytics label used for APNS messages.
     * @return This builder
     */
    public Builder setAnalyticsLabel(String analyticsLabel) {
      this.analyticsLabel = analyticsLabel;
      return this;
    }

    /**
     * @param imageUrl URL of the image that is going to be displayed in the notification.
     * @return This builder
     */
    public Builder setImage(String imageUrl) {
      this.image = imageUrl;
      return this;
    }

    /**
     * Creates a new {@link ApnsFcmOptions} instance from the parameters set on this builder.
     *
     * @return A new {@link ApnsFcmOptions} instance.
     * @throws IllegalArgumentException If any of the parameters set on the builder are invalid.
     */
    public ApnsFcmOptions build() {
      return new ApnsFcmOptions(this);
    }
  }
}