Class: GetStream::Generated::Models::SearchPayload

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/getstream_ruby/generated/models/search_payload.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 = {}) ⇒ SearchPayload

Initialize with attributes



41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/getstream_ruby/generated/models/search_payload.rb', line 41

def initialize(attributes = {})
  super(attributes)
  @filter_conditions = attributes[:filter_conditions] || attributes['filter_conditions']
  @force_default_search = attributes[:force_default_search] || attributes['force_default_search'] || nil
  @limit = attributes[:limit] || attributes['limit'] || nil
  @next = attributes[:next] || attributes['next'] || nil
  @offset = attributes[:offset] || attributes['offset'] || nil
  @query = attributes[:query] || attributes['query'] || nil
  @sort = attributes[:sort] || attributes['sort'] || nil
  @message_filter_conditions = attributes[:message_filter_conditions] || attributes['message_filter_conditions'] || nil
  @message_options = attributes[:message_options] || attributes['message_options'] || nil
end

Instance Attribute Details

#filter_conditions ⇒ Object

Returns Channel filter conditions.

Returns:

  • (Object) —

    Channel filter conditions



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

def filter_conditions
  @filter_conditions
end

#force_default_search ⇒ Boolean

Returns:

  • (Boolean) 


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

def force_default_search
  @force_default_search
end

#limit ⇒ Integer

Returns Number of messages to return.

Returns:

  • (Integer) —

    Number of messages to return



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

def limit
  @limit
end

#message_filter_conditions ⇒ Object

Returns Message filter conditions.

Returns:

  • (Object) —

    Message filter conditions



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

def message_filter_conditions
  @message_filter_conditions
end

#message_options ⇒ MessageOptions

Returns:



38
39
40
 
# File 'lib/getstream_ruby/generated/models/search_payload.rb', line 38

def message_options
  @message_options
end

#next ⇒ String

Returns Pagination parameter. Cannot be used with non-zero offset.

Returns:

  • (String) —

    Pagination parameter. Cannot be used with non-zero offset.



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

def next
  @next
end

#offset ⇒ Integer

Returns Pagination offset. Cannot be used with sort or next.

Returns:

  • (Integer) —

    Pagination offset. Cannot be used with sort or next.



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

def offset
  @offset
end

#query ⇒ String

Returns Search phrase.

Returns:

  • (String) —

    Search phrase



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

def query
  @query
end

#sort ⇒ Array<SortParamRequest>

Returns Sort parameters. Cannot be used with non-zero offset.

Returns:

  • (Array<SortParamRequest>) —

    Sort parameters. Cannot be used with non-zero offset



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

def sort
  @sort
end

Class Method Details

.json_field_mappings ⇒ Object

Override field mappings for JSON serialization



55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/getstream_ruby/generated/models/search_payload.rb', line 55

def self.json_field_mappings
  {
    filter_conditions: 'filter_conditions',
    force_default_search: 'force_default_search',
    limit: 'limit',
    next: 'next',
    offset: 'offset',
    query: 'query',
    sort: 'sort',
    message_filter_conditions: 'message_filter_conditions',
    message_options: 'message_options'
  }
end