Class: GetStream::Generated::Models::KickUserRequest

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

Overview

KickUserRequest is the payload for kicking a user from a call. Optionally block the user as well.

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 = {}) ⇒ KickUserRequest

Initialize with attributes



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

def initialize(attributes = {})
  super(attributes)
  @user_id = attributes[:user_id] || attributes['user_id']
  @block = attributes[:block] || attributes['block'] || nil
  @kicked_by_id = attributes[:kicked_by_id] || attributes['kicked_by_id'] || nil
  @kicked_by = attributes[:kicked_by] || attributes['kicked_by'] || nil
end

Instance Attribute Details

#block ⇒ Boolean

Returns If true, also block the user from rejoining the call.

Returns:

  • (Boolean) —

    If true, also block the user from rejoining the call



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

def block
  @block
end

#kicked_by ⇒ UserRequest

Returns:



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

def kicked_by
  @kicked_by
end

#kicked_by_id ⇒ String

Returns Server-side: ID of the user performing the action.

Returns:

  • (String) —

    Server-side: ID of the user performing the action



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

def kicked_by_id
  @kicked_by_id
end

#user_id ⇒ String

Returns The user to kick.

Returns:

  • (String) —

    The user to kick



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

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/kick_user_request.rb', line 35

def self.json_field_mappings
  {
    user_id: 'user_id',
    block: 'block',
    kicked_by_id: 'kicked_by_id',
    kicked_by: 'kicked_by'
  }
end