Class: GetStream::Generated::Models::UserDeletedEvent

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

Overview

This event is sent when a user gets deleted. The event contains information about the user that was deleted and the deletion options that were used.

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

Initialize with attributes



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

def initialize(attributes = {})
  super(attributes)
  @created_at = attributes[:created_at] || attributes['created_at']
  @delete_conversation = attributes[:delete_conversation] || attributes['delete_conversation']
  @delete_conversation_channels = attributes[:delete_conversation_channels] || attributes['delete_conversation_channels']
  @delete_messages = attributes[:delete_messages] || attributes['delete_messages']
  @delete_user = attributes[:delete_user] || attributes['delete_user']
  @hard_delete = attributes[:hard_delete] || attributes['hard_delete']
  @mark_messages_deleted = attributes[:mark_messages_deleted] || attributes['mark_messages_deleted']
  @custom = attributes[:custom] || attributes['custom']
  @user = attributes[:user] || attributes['user']
  @type = attributes[:type] || attributes['type'] || "user.deleted"
  @received_at = attributes[:received_at] || attributes['received_at'] || nil
end

Instance Attribute Details

#created_at ⇒ DateTime

Returns Date/time of creation.

Returns:

  • (DateTime) —

    Date/time of creation



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

def created_at
  @created_at
end

#custom ⇒ Object

Returns:

  • (Object) 


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

def custom
  @custom
end

#delete_conversation ⇒ String

Returns The type of deletion that was used for the user’s conversations. One of: hard, soft, pruning, (empty string).

Returns:

  • (String) —

    The type of deletion that was used for the user’s conversations. One of: hard, soft, pruning, (empty string)



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

def delete_conversation
  @delete_conversation
end

#delete_conversation_channels ⇒ Boolean

Returns Whether the user’s conversation channels were deleted.

Returns:

  • (Boolean) —

    Whether the user’s conversation channels were deleted



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

def delete_conversation_channels
  @delete_conversation_channels
end

#delete_messages ⇒ String

Returns The type of deletion that was used for the user’s messages. One of: hard, soft, pruning, (empty string).

Returns:

  • (String) —

    The type of deletion that was used for the user’s messages. One of: hard, soft, pruning, (empty string)



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

def delete_messages
  @delete_messages
end

#delete_user ⇒ String

Returns The type of deletion that was used for the user. One of: hard, soft, pruning, (empty string).

Returns:

  • (String) —

    The type of deletion that was used for the user. One of: hard, soft, pruning, (empty string)



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

def delete_user
  @delete_user
end

#hard_delete ⇒ Boolean

Returns Whether the user was hard deleted.

Returns:

  • (Boolean) —

    Whether the user was hard deleted



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

def hard_delete
  @hard_delete
end

#mark_messages_deleted ⇒ Boolean

Returns Whether the user’s messages were marked as deleted.

Returns:

  • (Boolean) —

    Whether the user’s messages were marked as deleted



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

def mark_messages_deleted
  @mark_messages_deleted
end

#received_at ⇒ DateTime

Returns:

  • (DateTime) 


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

def received_at
  @received_at
end

#type ⇒ String

Returns The type of event: “user.deleted” in this case.

Returns:

  • (String) —

    The type of event: “user.deleted” in this case



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

def type
  @type
end

#user ⇒ UserResponseCommonFields

Returns:



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

def user
  @user
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/user_deleted_event.rb', line 63

def self.json_field_mappings
  {
    created_at: 'created_at',
    delete_conversation: 'delete_conversation',
    delete_conversation_channels: 'delete_conversation_channels',
    delete_messages: 'delete_messages',
    delete_user: 'delete_user',
    hard_delete: 'hard_delete',
    mark_messages_deleted: 'mark_messages_deleted',
    custom: 'custom',
    user: 'user',
    type: 'type',
    received_at: 'received_at'
  }
end