Class: Google::Cloud::Firestore::QueryListener

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/firestore/query_listener.rb

Overview

QueryListener

An ongoing listen operation on a query. This is returned by calling Google::Cloud::Firestore::Query#listen.

Examples:

require "google/cloud/firestore"

firestore = Google::Cloud::Firestore.new

# Create a query
query = firestore.col(:cities).order(:population, :desc)

listener = query.listen do |snapshot|
  puts "The query snapshot has #{snapshot.docs.count} documents "
  puts "and has #{snapshot.changes.count} changes."
end

# When ready, stop the listen operation and close the stream.
listener.stop

Instance Method Summary collapse

Instance Method Details

#stop ⇒ Object

Stops the client listening for changes.

Examples:

require "google/cloud/firestore"

firestore = Google::Cloud::Firestore.new

# Create a query
query = firestore.col(:cities).order(:population, :desc)

listener = query.listen do |snapshot|
  puts "The query snapshot has #{snapshot.docs.count} documents "
  puts "and has #{snapshot.changes.count} changes."
end

# When ready, stop the listen operation and close the stream.
listener.stop


83
84
85
 
# File 'lib/google/cloud/firestore/query_listener.rb', line 83

def stop
  @listener.stop
end

#stopped? ⇒ Boolean

Whether the client has stopped listening for changes.

Examples:

require "google/cloud/firestore"

firestore = Google::Cloud::Firestore.new

# Create a query
query = firestore.col(:cities).order(:population, :desc)

listener = query.listen do |snapshot|
  puts "The query snapshot has #{snapshot.docs.count} documents "
  puts "and has #{snapshot.changes.count} changes."
end

# Checks if the listener is stopped.
listener.stopped? #=> false

# When ready, stop the listen operation and close the stream.
listener.stop

# Checks if the listener is stopped.
listener.stopped? #=> true

Returns:

  • (Boolean) 


112
113
114
 
# File 'lib/google/cloud/firestore/query_listener.rb', line 112

def stopped?
  @listener.stopped?
end