DocumentSnapshot.ServerTimestampBehavior

public enum DocumentSnapshot.ServerTimestampBehavior


Controls the return value for server timestamps that have not yet been set to their final value.

Summary

Enum Values

ESTIMATE

Return local estimates for ServerTimestamps that have not yet been set to their final value.

NONE

Return null for ServerTimestamps that have not yet been set to their final value.

PREVIOUS

Return the previous value for ServerTimestamps that have not yet been set to their final value.

Public methods

static DocumentSnapshot.ServerTimestampBehavior

Returns the enum constant of this type with the specified name.

static DocumentSnapshot.ServerTimestampBehavior[]

Returns an array containing the constants of this enum type, in the order they're declared.

Enum Values

ESTIMATE

DocumentSnapshot.ServerTimestampBehavior DocumentSnapshot.ServerTimestampBehavior.ESTIMATE

Return local estimates for ServerTimestamps that have not yet been set to their final value. This estimate will likely differ from the final value and may cause these pending values to change once the server result becomes available.

NONE

DocumentSnapshot.ServerTimestampBehavior DocumentSnapshot.ServerTimestampBehavior.NONE

Return null for ServerTimestamps that have not yet been set to their final value.

PREVIOUS

DocumentSnapshot.ServerTimestampBehavior DocumentSnapshot.ServerTimestampBehavior.PREVIOUS

Return the previous value for ServerTimestamps that have not yet been set to their final value.

Public methods

valueOf

public static DocumentSnapshot.ServerTimestampBehavior valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Returns
DocumentSnapshot.ServerTimestampBehavior

the enum constant with the specified name

Throws
java.lang.IllegalArgumentException java.lang.IllegalArgumentException

if this enum type has no constant with the specified name

values

public static DocumentSnapshot.ServerTimestampBehavior[] values()

Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants.

Returns
DocumentSnapshot.ServerTimestampBehavior[]

an array containing the constants of this enum type, in the order they're declared