Class: GetStream::Generated::Models::QueryActivitiesRequest

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

Initialize with attributes



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

def initialize(attributes = {})
  super(attributes)
  @enrich_own_fields = attributes[:enrich_own_fields] || attributes['enrich_own_fields'] || nil
  @include_expired_activities = attributes[:include_expired_activities] || attributes['include_expired_activities'] || nil
  @include_private_activities = attributes[:include_private_activities] || attributes['include_private_activities'] || nil
  @include_soft_deleted_activities = attributes[:include_soft_deleted_activities] || attributes['include_soft_deleted_activities'] || nil
  @limit = attributes[:limit] || attributes['limit'] || nil
  @next = attributes[:next] || attributes['next'] || nil
  @prev = attributes[:prev] || attributes['prev'] || nil
  @user_id = attributes[:user_id] || attributes['user_id'] || nil
  @sort = attributes[:sort] || attributes['sort'] || nil
  @filter = attributes[:filter] || attributes['filter'] || nil
  @user = attributes[:user] || attributes['user'] || nil
end

Instance Attribute Details

#enrich_own_fields ⇒ Boolean

Returns:

  • (Boolean) 


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

def enrich_own_fields
  @enrich_own_fields
end

#filter ⇒ Object

Returns Filters to apply to the query. Supports location-based queries with ‘near’ and ‘within_bounds’ operators.

Returns:

  • (Object) —

    Filters to apply to the query. Supports location-based queries with ‘near’ and ‘within_bounds’ operators.



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

def filter
  @filter
end

#include_expired_activities ⇒ Boolean

Returns When true, include both expired and non-expired activities in the result.

Returns:

  • (Boolean) —

    When true, include both expired and non-expired activities in the result.



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

def include_expired_activities
  @include_expired_activities
end

#include_private_activities ⇒ Boolean

Returns:

  • (Boolean) 


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

def include_private_activities
  @include_private_activities
end

#include_soft_deleted_activities ⇒ Boolean

Returns When true, include soft-deleted activities in the result.

Returns:

  • (Boolean) —

    When true, include soft-deleted activities in the result.



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

def include_soft_deleted_activities
  @include_soft_deleted_activities
end

#limit ⇒ Integer

Returns:

  • (Integer) 


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

def limit
  @limit
end

#next ⇒ String

Returns:

  • (String) 


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

def next
  @next
end

#prev ⇒ String

Returns:

  • (String) 


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

def prev
  @prev
end

#sort ⇒ Array<SortParamRequest>

Returns Sorting parameters for the query.

Returns:



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

def sort
  @sort
end

#user ⇒ UserRequest

Returns:



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

def user
  @user
end

#user_id ⇒ String

Returns:

  • (String) 


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

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

def self.json_field_mappings
  {
    enrich_own_fields: 'enrich_own_fields',
    include_expired_activities: 'include_expired_activities',
    include_private_activities: 'include_private_activities',
    include_soft_deleted_activities: 'include_soft_deleted_activities',
    limit: 'limit',
    next: 'next',
    prev: 'prev',
    user_id: 'user_id',
    sort: 'sort',
    filter: 'filter',
    user: 'user'
  }
end