Class: GetStream::Generated::Models::FollowBatchRequest

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

Initialize with attributes



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

def initialize(attributes = {})
  super(attributes)
  @follows = attributes[:follows] || attributes['follows']
  @create_users = attributes[:create_users] || attributes['create_users'] || nil
  @enrich_own_fields = attributes[:enrich_own_fields] || attributes['enrich_own_fields'] || nil
end

Instance Attribute Details

#create_users ⇒ Boolean

Returns If true, auto-creates users referenced by source/target FIDs in the batch when they don’t already exist. Server-side only. Defaults to false. This top-level field is the only supported batch/upsert create_users control.

Returns:

  • (Boolean) —

    If true, auto-creates users referenced by source/target FIDs in the batch when they don’t already exist. Server-side only. Defaults to false. This top-level field is the only supported batch/upsert create_users control.



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

def create_users
  @create_users
end

#enrich_own_fields ⇒ Boolean

Returns If true, enriches the follow’s source_feed and target_feed with own_* fields (own_follows, own_followings, own_capabilities, own_membership). Defaults to false for performance.

Returns:

  • (Boolean) —

    If true, enriches the follow’s source_feed and target_feed with own_* fields (own_follows, own_followings, own_capabilities, own_membership). Defaults to false for performance.



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

def enrich_own_fields
  @enrich_own_fields
end

#follows ⇒ Array<FollowRequest>

Returns List of follow relationships to create.

Returns:

  • (Array<FollowRequest>) —

    List of follow relationships to create



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

def follows
  @follows
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/follow_batch_request.rb', line 31

def self.json_field_mappings
  {
    follows: 'follows',
    create_users: 'create_users',
    enrich_own_fields: 'enrich_own_fields'
  }
end