Class: GetStream::Generated::Models::DeleteFeedsBatchRequest

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

Initialize with attributes



23
24
25
26
27
28
 
# File 'lib/getstream_ruby/generated/models/delete_feeds_batch_request.rb', line 23

def initialize(attributes = {})
  super(attributes)
  @feeds = attributes[:feeds] || attributes['feeds']
  @hard_delete = attributes[:hard_delete] || attributes['hard_delete'] || nil
  @purge_user_activities = attributes[:purge_user_activities] || attributes['purge_user_activities'] || nil
end

Instance Attribute Details

#feeds ⇒ Array<String>

Returns List of fully qualified feed IDs (format: group_id:feed_id) to delete.

Returns:

  • (Array<String>) —

    List of fully qualified feed IDs (format: group_id:feed_id) to delete



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

def feeds
  @feeds
end

#hard_delete ⇒ Boolean

Returns Whether to permanently delete the feeds instead of soft delete.

Returns:

  • (Boolean) —

    Whether to permanently delete the feeds instead of soft delete



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

def hard_delete
  @hard_delete
end

#purge_user_activities ⇒ Boolean

Returns When hard-deleting, also fully delete activities authored by each feed’s owner from every other feed those activities were fanned out to. Default false preserves existing fan-out. Requires ‘hard_delete’ to be true; the request is rejected otherwise. Feeds with no recorded owner (created_by_id is empty) are silently skipped for the purge step — owner-matching against an empty string is a safety guard, not a wildcard.

Returns:

  • (Boolean) —

    When hard-deleting, also fully delete activities authored by each feed’s owner from every other feed those activities were fanned out to. Default false preserves existing fan-out. Requires ‘hard_delete’ to be true; the request is rejected otherwise. Feeds with no recorded owner (created_by_id is empty) are silently skipped for the purge step — owner-matching against an empty string is a safety guard, not a wildcard.



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

def purge_user_activities
  @purge_user_activities
end

Class Method Details

.json_field_mappings ⇒ Object

Override field mappings for JSON serialization



31
32
33
34
35
36
37
 
# File 'lib/getstream_ruby/generated/models/delete_feeds_batch_request.rb', line 31

def self.json_field_mappings
  {
    feeds: 'feeds',
    hard_delete: 'hard_delete',
    purge_user_activities: 'purge_user_activities'
  }
end