Class: GetStream::Generated::Models::DeleteUsersRequest

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

Initialize with attributes



38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/getstream_ruby/generated/models/delete_users_request.rb', line 38

def initialize(attributes = {})
  super(attributes)
  @user_ids = attributes[:user_ids] || attributes['user_ids']
  @calls = attributes[:calls] || attributes['calls'] || nil
  @conversations = attributes[:conversations] || attributes['conversations'] || nil
  @files = attributes[:files] || attributes['files'] || nil
  @messages = attributes[:messages] || attributes['messages'] || nil
  @new_call_owner_id = attributes[:new_call_owner_id] || attributes['new_call_owner_id'] || nil
  @new_channel_owner_id = attributes[:new_channel_owner_id] || attributes['new_channel_owner_id'] || nil
  @user = attributes[:user] || attributes['user'] || nil
end

Instance Attribute Details

#calls ⇒ String

Returns Calls delete mode., Affected calls are those that include exactly two members, one of whom is the user being deleted., * null or empty string - doesn’t delete any calls, * soft - marks user’s calls and their related data as deleted (soft-delete), * hard - deletes user’s calls and their data completely (hard-delete).

Returns:

  • (String) —

    Calls delete mode., Affected calls are those that include exactly two members, one of whom is the user being deleted., * null or empty string - doesn’t delete any calls, * soft - marks user’s calls and their related data as deleted (soft-delete), * hard - deletes user’s calls and their data completely (hard-delete)



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

def calls
  @calls
end

#conversations ⇒ String

Returns Conversation channels delete mode., Conversation channel is any channel which only has two members one of which is the user being deleted., * null or empty string - doesn’t delete any conversation channels, * soft - marks all conversation channels as deleted (same effect as Delete Channels with ‘hard’ option disabled), * hard - deletes channel and all its data completely including messages (same effect as Delete Channels with ‘hard’ option enabled).

Returns:

  • (String) —

    Conversation channels delete mode., Conversation channel is any channel which only has two members one of which is the user being deleted., * null or empty string - doesn’t delete any conversation channels, * soft - marks all conversation channels as deleted (same effect as Delete Channels with ‘hard’ option disabled), * hard - deletes channel and all its data completely including messages (same effect as Delete Channels with ‘hard’ option enabled)



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

def conversations
  @conversations
end

#files ⇒ Boolean

Returns Delete user files., * false or empty string - doesn’t delete any files, * true - deletes all files uploaded by the user, including images and attachments.

Returns:

  • (Boolean) —

    Delete user files., * false or empty string - doesn’t delete any files, * true - deletes all files uploaded by the user, including images and attachments.



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

def files
  @files
end

#messages ⇒ String

Returns Message delete mode., * null or empty string - doesn’t delete user messages, * soft - marks all user messages as deleted without removing any related message data, * pruning - marks all user messages as deleted, nullifies message information and removes some message data such as reactions and flags, * hard - deletes messages completely with all related information.

Returns:

  • (String) —

    Message delete mode., * null or empty string - doesn’t delete user messages, * soft - marks all user messages as deleted without removing any related message data, * pruning - marks all user messages as deleted, nullifies message information and removes some message data such as reactions and flags, * hard - deletes messages completely with all related information



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

def messages
  @messages
end

#new_call_owner_id ⇒ String

Returns:

  • (String) 


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

def new_call_owner_id
  @new_call_owner_id
end

#new_channel_owner_id ⇒ String

Returns:

  • (String) 


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

def new_channel_owner_id
  @new_channel_owner_id
end

#user ⇒ String

Returns User delete mode., * soft - marks user as deleted and retains all user data, * pruning - marks user as deleted and nullifies user information, * hard - deletes user completely. Requires ‘hard’ option for messages and conversations as well.

Returns:

  • (String) —

    User delete mode., * soft - marks user as deleted and retains all user data, * pruning - marks user as deleted and nullifies user information, * hard - deletes user completely. Requires ‘hard’ option for messages and conversations as well



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

def user
  @user
end

#user_ids ⇒ Array<String>

Returns IDs of users to delete.

Returns:

  • (Array<String>) —

    IDs of users to delete



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

def user_ids
  @user_ids
end

Class Method Details

.json_field_mappings ⇒ Object

Override field mappings for JSON serialization



51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/getstream_ruby/generated/models/delete_users_request.rb', line 51

def self.json_field_mappings
  {
    user_ids: 'user_ids',
    calls: 'calls',
    conversations: 'conversations',
    files: 'files',
    messages: 'messages',
    new_call_owner_id: 'new_call_owner_id',
    new_channel_owner_id: 'new_channel_owner_id',
    user: 'user'
  }
end