Class: GetStream::Generated::Models::ModerationRulesTriggeredEvent

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

Overview

This event is sent automatically whenever a rule builder rule is triggered

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

Initialize with attributes



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

def initialize(attributes = {})
  super(attributes)
  @created_at = attributes[:created_at] || attributes['created_at']
  @entity_id = attributes[:entity_id] || attributes['entity_id']
  @entity_type = attributes[:entity_type] || attributes['entity_type']
  @user_id = attributes[:user_id] || attributes['user_id']
  @triggered_actions = attributes[:triggered_actions] || attributes['triggered_actions']
  @custom = attributes[:custom] || attributes['custom']
  @rule = attributes[:rule] || attributes['rule']
  @type = attributes[:type] || attributes['type'] || "moderation_rule.triggered"
  @received_at = attributes[:received_at] || attributes['received_at'] || nil
  @review_queue_item_id = attributes[:review_queue_item_id] || attributes['review_queue_item_id'] || nil
  @violation_number = attributes[:violation_number] || attributes['violation_number'] || nil
end

Instance Attribute Details

#created_at ⇒ DateTime

Returns:

  • (DateTime) 


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

def created_at
  @created_at
end

#custom ⇒ Object

Returns:

  • (Object) 


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

def custom
  @custom
end

#entity_id ⇒ String

Returns The ID of the entity that triggered the rule.

Returns:

  • (String) —

    The ID of the entity that triggered the rule



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

def entity_id
  @entity_id
end

#entity_type ⇒ String

Returns The type of the entity (call, user, message, etc.).

Returns:

  • (String) —

    The type of the entity (call, user, message, etc.)



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

def entity_type
  @entity_type
end

#received_at ⇒ DateTime

Returns:

  • (DateTime) 


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

def received_at
  @received_at
end

#review_queue_item_id ⇒ String

Returns The review queue item ID if applicable.

Returns:

  • (String) —

    The review queue item ID if applicable



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

def review_queue_item_id
  @review_queue_item_id
end

#rule ⇒ ModerationRuleInfo

Returns:



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

def rule
  @rule
end

#triggered_actions ⇒ Array<String>

Returns Array of action types that were triggered.

Returns:

  • (Array<String>) —

    Array of action types that were triggered



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

def triggered_actions
  @triggered_actions
end

#type ⇒ String

Returns:

  • (String) 


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

def type
  @type
end

#user_id ⇒ String

Returns The ID of the user who triggered the rule.

Returns:

  • (String) —

    The ID of the user who triggered the rule



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

def user_id
  @user_id
end

#violation_number ⇒ Integer

Returns The violation number for call rules (optional).

Returns:

  • (Integer) —

    The violation number for call rules (optional)



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

def violation_number
  @violation_number
end

Class Method Details

.json_field_mappings ⇒ Object

Override field mappings for JSON serialization



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/getstream_ruby/generated/models/moderation_rules_triggered_event.rb', line 63

def self.json_field_mappings
  {
    created_at: 'created_at',
    entity_id: 'entity_id',
    entity_type: 'entity_type',
    user_id: 'user_id',
    triggered_actions: 'triggered_actions',
    custom: 'custom',
    rule: 'rule',
    type: 'type',
    received_at: 'received_at',
    review_queue_item_id: 'review_queue_item_id',
    violation_number: 'violation_number'
  }
end