Class: GetStream::Generated::Models::BanActionRequestPayload

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

Overview

Configuration for ban moderation action

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

Initialize with attributes



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

def initialize(attributes = {})
  super(attributes)
  @channel_ban_only = attributes[:channel_ban_only] || attributes['channel_ban_only'] || nil
  @delete_messages = attributes[:delete_messages] || attributes['delete_messages'] || nil
  @ip_ban = attributes[:ip_ban] || attributes['ip_ban'] || nil
  @reason = attributes[:reason] || attributes['reason'] || nil
  @shadow = attributes[:shadow] || attributes['shadow'] || nil
  @target_user_id = attributes[:target_user_id] || attributes['target_user_id'] || nil
  @timeout = attributes[:timeout] || attributes['timeout'] || nil
end

Instance Attribute Details

#channel_ban_only ⇒ Boolean

Returns Ban only from specific channel.

Returns:

  • (Boolean) —

    Ban only from specific channel



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

def channel_ban_only
  @channel_ban_only
end

#delete_messages ⇒ String

Returns Message deletion mode: soft, pruning, or hard.

Returns:

  • (String) —

    Message deletion mode: soft, pruning, or hard



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

def delete_messages
  @delete_messages
end

#ip_ban ⇒ Boolean

Returns Whether to ban by IP address.

Returns:

  • (Boolean) —

    Whether to ban by IP address



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

def ip_ban
  @ip_ban
end

#reason ⇒ String

Returns Reason for the ban.

Returns:

  • (String) —

    Reason for the ban



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

def reason
  @reason
end

#shadow ⇒ Boolean

Returns Whether this is a shadow ban.

Returns:

  • (Boolean) —

    Whether this is a shadow ban



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

def shadow
  @shadow
end

#target_user_id ⇒ String

Returns Optional: ban user directly without review item.

Returns:

  • (String) —

    Optional: ban user directly without review item



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

def target_user_id
  @target_user_id
end

#timeout ⇒ Integer

Returns Duration of ban in minutes.

Returns:

  • (Integer) —

    Duration of ban in minutes



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

def timeout
  @timeout
end

Class Method Details

.json_field_mappings ⇒ Object

Override field mappings for JSON serialization



47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/getstream_ruby/generated/models/ban_action_request_payload.rb', line 47

def self.json_field_mappings
  {
    channel_ban_only: 'channel_ban_only',
    delete_messages: 'delete_messages',
    ip_ban: 'ip_ban',
    reason: 'reason',
    shadow: 'shadow',
    target_user_id: 'target_user_id',
    timeout: 'timeout'
  }
end