DocumentSnapshot.ServerTimestampBehavior

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 functions

java-static DocumentSnapshot.ServerTimestampBehavior!
valueOf(name: String!)

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

java-static Array<DocumentSnapshot.ServerTimestampBehavior!>!

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

Enum Values

ESTIMATE

val DocumentSnapshot.ServerTimestampBehavior.ESTIMATEDocumentSnapshot.ServerTimestampBehavior

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

val DocumentSnapshot.ServerTimestampBehavior.NONEDocumentSnapshot.ServerTimestampBehavior

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

PREVIOUS

val DocumentSnapshot.ServerTimestampBehavior.PREVIOUSDocumentSnapshot.ServerTimestampBehavior

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

Public functions

valueOf

java-static fun valueOf(name: String!): DocumentSnapshot.ServerTimestampBehavior!

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

java-static fun values(): Array<DocumentSnapshot.ServerTimestampBehavior!>!

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
Array<DocumentSnapshot.ServerTimestampBehavior!>!

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