Class: GetStream::Generated::Models::QueryChannelsRequest

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

Initialize with attributes



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

def initialize(attributes = {})
  super(attributes)
  @limit = attributes[:limit] || attributes['limit'] || nil
  @member_limit = attributes[:member_limit] || attributes['member_limit'] || nil
  @message_limit = attributes[:message_limit] || attributes['message_limit'] || nil
  @offset = attributes[:offset] || attributes['offset'] || nil
  @predefined_filter = attributes[:predefined_filter] || attributes['predefined_filter'] || nil
  @state = attributes[:state] || attributes['state'] || nil
  @user_id = attributes[:user_id] || attributes['user_id'] || nil
  @sort = attributes[:sort] || attributes['sort'] || nil
  @filter_conditions = attributes[:filter_conditions] || attributes['filter_conditions'] || nil
  @filter_values = attributes[:filter_values] || attributes['filter_values'] || nil
  @sort_values = attributes[:sort_values] || attributes['sort_values'] || nil
  @user = attributes[:user] || attributes['user'] || nil
end

Instance Attribute Details

#filter_conditions ⇒ Object

Returns:

  • (Object) 


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

def filter_conditions
  @filter_conditions
end

#filter_values ⇒ Object

Returns Values to interpolate into the predefined filter template.

Returns:

  • (Object) —

    Values to interpolate into the predefined filter template



41
42
43
 
# File 'lib/getstream_ruby/generated/models/query_channels_request.rb', line 41

def filter_values
  @filter_values
end

#limit ⇒ Integer

Returns Number of channels to limit.

Returns:

  • (Integer) —

    Number of channels to limit



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

def limit
  @limit
end

#member_limit ⇒ Integer

Returns Number of members to limit.

Returns:

  • (Integer) —

    Number of members to limit



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

def member_limit
  @member_limit
end

#message_limit ⇒ Integer

Returns Number of messages to limit.

Returns:

  • (Integer) —

    Number of messages to limit



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

def message_limit
  @message_limit
end

#offset ⇒ Integer

Returns Channel pagination offset.

Returns:

  • (Integer) —

    Channel pagination offset



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

def offset
  @offset
end

#predefined_filter ⇒ String

Returns ID of a predefined filter to use instead of filter_conditions.

Returns:

  • (String) —

    ID of a predefined filter to use instead of filter_conditions



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

def predefined_filter
  @predefined_filter
end

#sort ⇒ Array<SortParamRequest>

Returns List of sort parameters.

Returns:



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

def sort
  @sort
end

#sort_values ⇒ Object

Returns:

  • (Object) 


44
45
46
 
# File 'lib/getstream_ruby/generated/models/query_channels_request.rb', line 44

def sort_values
  @sort_values
end

#state ⇒ Boolean

Returns Whether to update channel state or not.

Returns:

  • (Boolean) —

    Whether to update channel state or not



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

def state
  @state
end

#user ⇒ UserRequest

Returns:



47
48
49
 
# File 'lib/getstream_ruby/generated/models/query_channels_request.rb', line 47

def user
  @user
end

#user_id ⇒ String

Returns:

  • (String) 


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

def user_id
  @user_id
end

Class Method Details

.json_field_mappings ⇒ Object

Override field mappings for JSON serialization



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/getstream_ruby/generated/models/query_channels_request.rb', line 67

def self.json_field_mappings
  {
    limit: 'limit',
    member_limit: 'member_limit',
    message_limit: 'message_limit',
    offset: 'offset',
    predefined_filter: 'predefined_filter',
    state: 'state',
    user_id: 'user_id',
    sort: 'sort',
    filter_conditions: 'filter_conditions',
    filter_values: 'filter_values',
    sort_values: 'sort_values',
    user: 'user'
  }
end