Class: GetStream::Generated::Models::GroupedQueryChannelsRequest

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

Initialize with attributes



26
27
28
29
30
31
32
 
# File 'lib/getstream_ruby/generated/models/grouped_query_channels_request.rb', line 26

def initialize(attributes = {})
  super(attributes)
  @limit = attributes[:limit] || attributes['limit'] || nil
  @user_id = attributes[:user_id] || attributes['user_id'] || nil
  @groups = attributes[:groups] || attributes['groups'] || nil
  @user = attributes[:user] || attributes['user'] || nil
end

Instance Attribute Details

#groups ⇒ Hash<String, GroupedChannelsGroupRequest>

Returns Groups to return, keyed by group name. Each group can define limit, next, or prev. ‘next’ and ‘prev’ cursors are only allowed when the request contains exactly one group; multi-group pagination is rejected.

Returns:

  • (Hash<String, GroupedChannelsGroupRequest>) —

    Groups to return, keyed by group name. Each group can define limit, next, or prev. ‘next’ and ‘prev’ cursors are only allowed when the request contains exactly one group; multi-group pagination is rejected.



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

def groups
  @groups
end

#limit ⇒ Integer

Returns Default max channels per group (default 10).

Returns:

  • (Integer) —

    Default max channels per group (default 10)



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

def limit
  @limit
end

#user ⇒ UserRequest

Returns:



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

def user
  @user
end

#user_id ⇒ String

Returns:

  • (String) 


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

def user_id
  @user_id
end

Class Method Details

.json_field_mappings ⇒ Object

Override field mappings for JSON serialization



35
36
37
38
39
40
41
42
 
# File 'lib/getstream_ruby/generated/models/grouped_query_channels_request.rb', line 35

def self.json_field_mappings
  {
    limit: 'limit',
    user_id: 'user_id',
    groups: 'groups',
    user: 'user'
  }
end