Class: GetStream::Generated::Models::QueryCommentsRequest

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/getstream_ruby/generated/models/query_comments_request.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#==, #inspect, omit_empty_fields, #to_h, #to_json

Constructor Details

#initialize(attributes = {}) ⇒ QueryCommentsRequest

Initialize with attributes



38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/getstream_ruby/generated/models/query_comments_request.rb', line 38

def initialize(attributes = {})
  super(attributes)
  @filter = attributes[:filter] || attributes['filter']
  @id_around = attributes[:id_around] || attributes['id_around'] || nil
  @limit = attributes[:limit] || attributes['limit'] || nil
  @next = attributes[:next] || attributes['next'] || nil
  @prev = attributes[:prev] || attributes['prev'] || nil
  @sort = attributes[:sort] || attributes['sort'] || nil
  @user_id = attributes[:user_id] || attributes['user_id'] || nil
  @user = attributes[:user] || attributes['user'] || nil
end

Instance Attribute Details

#filter ⇒ Object

Returns MongoDB-style filter for querying comments.

Returns:

  • MongoDB-style filter for querying comments



14
15
16
 
# File 'lib/getstream_ruby/generated/models/query_comments_request.rb', line 14

def filter
  @filter
end

#id_around ⇒ String

Returns the comment with the specified ID along with surrounding comments for context

Returns:

  • Returns the comment with the specified ID along with surrounding comments for context



17
18
19
 
# File 'lib/getstream_ruby/generated/models/query_comments_request.rb', line 17

def id_around
  @id_around
end

#limit ⇒ Integer

Returns Maximum number of comments to return.

Returns:

  • Maximum number of comments to return



20
21
22
 
# File 'lib/getstream_ruby/generated/models/query_comments_request.rb', line 20

def limit
  @limit
end

#next ⇒ String

Returns:



23
24
25
 
# File 'lib/getstream_ruby/generated/models/query_comments_request.rb', line 23

def next
  @next
end

#prev ⇒ String

Returns:



26
27
28
 
# File 'lib/getstream_ruby/generated/models/query_comments_request.rb', line 26

def prev
  @prev
end

#sort ⇒ String

Returns first (oldest), last (newest) or top. One of: first, last, top, best, controversial.

Returns:

  • first (oldest), last (newest) or top. One of: first, last, top, best, controversial



29
30
31
 
# File 'lib/getstream_ruby/generated/models/query_comments_request.rb', line 29

def sort
  @sort
end

#user ⇒ UserRequest

Returns:



35
36
37
 
# File 'lib/getstream_ruby/generated/models/query_comments_request.rb', line 35

def user
  @user
end

#user_id ⇒ String

Returns:



32
33
34
 
# File 'lib/getstream_ruby/generated/models/query_comments_request.rb', line 32

def user_id
  @user_id
end

Class Method Details

.json_field_mappings ⇒ Object

Override field mappings for JSON serialization



51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/getstream_ruby/generated/models/query_comments_request.rb', line 51

def self.json_field_mappings
  {
    filter: 'filter',
    id_around: 'id_around',
    limit: 'limit',
    next: 'next',
    prev: 'prev',
    sort: 'sort',
    user_id: 'user_id',
    user: 'user'
  }
end