public static final class

FirebaseFirestoreSettings.Builder

extends Object
java.lang.Object
   ↳ com.google.firebase.firestore.FirebaseFirestoreSettings.Builder

Class Overview

A Builder for creating FirebaseFirestoreSettings.

Summary

Public Constructors
FirebaseFirestoreSettings.Builder()
Constructs a new FirebaseFirestoreSettings Builder object.
FirebaseFirestoreSettings.Builder(FirebaseFirestoreSettings settings)
Constructs a new FirebaseFirestoreSettings Builder based on an existing FirebaseFirestoreSettings object.
Public Methods
FirebaseFirestoreSettings build()
FirebaseFirestoreSettings.Builder setHost(String host)
Sets the host of the Firestore backend.
FirebaseFirestoreSettings.Builder setPersistenceEnabled(boolean value)
Enables or disables local persistent storage.
FirebaseFirestoreSettings.Builder setSslEnabled(boolean value)
Enables or disables SSL for communication.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public FirebaseFirestoreSettings.Builder ()

Constructs a new FirebaseFirestoreSettings Builder object.

public FirebaseFirestoreSettings.Builder (FirebaseFirestoreSettings settings)

Constructs a new FirebaseFirestoreSettings Builder based on an existing FirebaseFirestoreSettings object.

Parameters
settings FirebaseFirestoreSettings

Public Methods

public FirebaseFirestoreSettings.Builder setHost (String host)

Sets the host of the Firestore backend.

Parameters
host String: The host string
Returns
FirebaseFirestoreSettings.Builder A settings object with the host set.

public FirebaseFirestoreSettings.Builder setPersistenceEnabled (boolean value)

Enables or disables local persistent storage. The default is to use local persistent storage.

Parameters
value boolean
Returns
FirebaseFirestoreSettings.Builder A settings object that uses local persistent storage as specified by the given value.

public FirebaseFirestoreSettings.Builder setSslEnabled (boolean value)

Enables or disables SSL for communication. The default is to use SSL.

Parameters
value boolean
Returns
FirebaseFirestoreSettings.Builder A settings object that uses SSL as specified by the value.