org.cdecode.firebase.api.auth.FirebaseToken Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2017 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 org.cdecode.firebase.api.auth;

import java.util.Map;

/**
 * Interface of a Parsed Firebase Token returned by {@link FirebaseAuth#verifyIdToken(String)}. It can used to get the uid and other attributes of the user
 * provided in the Token.
 */
public interface FirebaseToken {
	
	/**
	 * @return the Uid for the this token
	 */
	public String getUid();
	
	/**
	 * @return the Issuer for the this token
	 */
	public String getIssuer();
	
	/**
	 * @return the user's display name
	 */
	public String getName();
	
	/**
	 * @return the Uri string of the user's profile photo
	 */
	public String getPicture();
	
	/**
	 * @return the e-mail address for this user, or {@code null} if it's unavailable
	 */
	public String getEmail();
	
	/**
	 * @return true if the email address returned by {@link #getEmail()} has been verified as good
	 */
	public boolean isEmailVerified();
	
	/**
	 * @return a map of all of the claims on this token
	 */
	public Map getClaims();
	
}