public class

AndroidApp

extends Object
java.lang.Object
   ↳ com.google.firebase.projectmanagement.AndroidApp

Class Overview

An instance of this class is a reference to an Android App within a Firebase Project; it can be used to query detailed information about the App, modify the display name of the App, or download the configuration file for the App.

Note: the methods in this class make RPCs.

Summary

Public Methods
ShaCertificate createShaCertificate(ShaCertificate certificateToAdd)
Adds the given SHA certificate to this Android app.
ApiFuture<ShaCertificate> createShaCertificateAsync(ShaCertificate certificateToAdd)
Asynchronously adds the given SHA certificate to this Android app.
void deleteShaCertificate(ShaCertificate certificateToRemove)
Removes the given SHA certificate from this Android app.
ApiFuture<Void> deleteShaCertificateAsync(ShaCertificate certificateToRemove)
Asynchronously removes the given SHA certificate from this Android app.
String getConfig()
Retrieves the configuration artifact associated with this Android App.
ApiFuture<String> getConfigAsync()
Asynchronously retrieves the configuration artifact associated with this Android App.
AndroidAppMetadata getMetadata()
Retrieves detailed information about this Android App.
ApiFuture<AndroidAppMetadata> getMetadataAsync()
Asynchronously retrieves information about this Android App.
List<ShaCertificate> getShaCertificates()
Retrieves the entire list of SHA certificates associated with this Android app.
ApiFuture<List<ShaCertificate>> getShaCertificatesAsync()
Asynchronously retrieves the entire list of SHA certificates associated with this Android app.
void setDisplayName(String newDisplayName)
Updates the Display Name attribute of this Android App to the one given.
ApiFuture<Void> setDisplayNameAsync(String newDisplayName)
Asynchronously updates the Display Name attribute of this Android App to the one given.
[Expand]
Inherited Methods
From class java.lang.Object

Public Methods

public ShaCertificate createShaCertificate (ShaCertificate certificateToAdd)

Adds the given SHA certificate to this Android app.

Parameters
certificateToAdd the SHA certificate to be added to this Android app
Returns
  • a ShaCertificate that was created for this Android app, containing resource name, SHA hash, and certificate type
Throws
FirebaseProjectManagementException if there was an error during the RPC

public ApiFuture<ShaCertificate> createShaCertificateAsync (ShaCertificate certificateToAdd)

Asynchronously adds the given SHA certificate to this Android app.

Parameters
certificateToAdd the SHA certificate to be added to this Android app
Returns
  • a ApiFuture of a ShaCertificate that was created for this Android app, containing resource name, SHA hash, and certificate type

public void deleteShaCertificate (ShaCertificate certificateToRemove)

Removes the given SHA certificate from this Android app.

Parameters
certificateToRemove the SHA certificate to be removed from this Android app
Throws
FirebaseProjectManagementException if there was an error during the RPC

public ApiFuture<Void> deleteShaCertificateAsync (ShaCertificate certificateToRemove)

Asynchronously removes the given SHA certificate from this Android app.

Parameters
certificateToRemove the SHA certificate to be removed from this Android app

public String getConfig ()

Retrieves the configuration artifact associated with this Android App.

Returns
  • a modified UTF-8 encoded String containing the contents of the artifact
Throws
FirebaseProjectManagementException if there was an error during the RPC

public ApiFuture<String> getConfigAsync ()

Asynchronously retrieves the configuration artifact associated with this Android App.

Returns
  • an ApiFuture of a UTF-8 encoded String containing the contents of the artifact

public AndroidAppMetadata getMetadata ()

Retrieves detailed information about this Android App.

Returns
Throws
FirebaseProjectManagementException if there was an error during the RPC
Exception

public ApiFuture<AndroidAppMetadata> getMetadataAsync ()

Asynchronously retrieves information about this Android App.

Returns

public List<ShaCertificate> getShaCertificates ()

Retrieves the entire list of SHA certificates associated with this Android app.

Returns
  • a list of ShaCertificate containing resource name, SHA hash and certificate type
Throws
FirebaseProjectManagementException if there was an error during the RPC

public ApiFuture<List<ShaCertificate>> getShaCertificatesAsync ()

Asynchronously retrieves the entire list of SHA certificates associated with this Android app.

Returns
  • an ApiFuture of a list of ShaCertificate containing resource name, SHA hash and certificate type

public void setDisplayName (String newDisplayName)

Updates the Display Name attribute of this Android App to the one given.

Throws
FirebaseProjectManagementException if there was an error during the RPC

public ApiFuture<Void> setDisplayNameAsync (String newDisplayName)

Asynchronously updates the Display Name attribute of this Android App to the one given.