DocumentChange.Type

enum DocumentChange.Type


An enumeration of snapshot diff types.

Summary

Enum Values

ADDED

Indicates a new document was added to the set of documents matching the query.

MODIFIED

Indicates a document within the query was modified.

REMOVED

Indicates a document within the query was removed (either deleted or no longer matches the query.

Public functions

java-static DocumentChange.Type!
valueOf(name: String!)

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

java-static Array<DocumentChange.Type!>!

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

Enum Values

ADDED

val DocumentChange.Type.ADDEDDocumentChange.Type

Indicates a new document was added to the set of documents matching the query.

MODIFIED

val DocumentChange.Type.MODIFIEDDocumentChange.Type

Indicates a document within the query was modified.

REMOVED

val DocumentChange.Type.REMOVEDDocumentChange.Type

Indicates a document within the query was removed (either deleted or no longer matches the query.

Public functions

valueOf

java-static fun valueOf(name: String!): DocumentChange.Type!

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
DocumentChange.Type!

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<DocumentChange.Type!>!

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<DocumentChange.Type!>!

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