Class: GetStream::Generated::Feed

Inherits:
Object
  • Object
show all
Defined in:
lib/getstream_ruby/generated/feed.rb

Overview

Feed-specific API methods

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client, feed_group_id, feed_id) ⇒ Feed

Returns a new instance of Feed.



11
12
13
14
15
 
# File 'lib/getstream_ruby/generated/feed.rb', line 11

def initialize(client, feed_group_id, feed_id)
  @client = client
  @feed_group_id = feed_group_id
  @feed_id = feed_id
end

Instance Attribute Details

#client ⇒ Object (readonly)

Returns the value of attribute client.



9
10
11
 
# File 'lib/getstream_ruby/generated/feed.rb', line 9

def client
  @client
end

#feed_group_id ⇒ Object (readonly)

Returns the value of attribute feed_group_id.



9
10
11
 
# File 'lib/getstream_ruby/generated/feed.rb', line 9

def feed_group_id
  @feed_group_id
end

#feed_id ⇒ Object (readonly)

Returns the value of attribute feed_id.



9
10
11
 
# File 'lib/getstream_ruby/generated/feed.rb', line 9

def feed_id
  @feed_id
end

Instance Method Details

#accept_feed_member_invite(accept_feed_member_invite_request) ⇒ Models::AcceptFeedMemberInviteResponse

Accepts a pending feed member request

Parameters:

  • accept_feed_member_invite_request (AcceptFeedMemberInviteRequest)

Returns:



119
120
121
122
123
 
# File 'lib/getstream_ruby/generated/feed.rb', line 119

def accept_feed_member_invite(accept_feed_member_invite_request)

  # Delegate to the FeedsClient
  @client.feeds.accept_feed_member_invite(@feed_group_id, @feed_id, accept_feed_member_invite_request)
end

#change_feed_visibility(change_feed_visibility_request) ⇒ Models::ChangeFeedVisibilityResponse

Changes the visibility of an existing feed. Follow reconciliation (rewriting pending follows on loosening, or removing disallowed follows/members on tightening) runs asynchronously in the background; the response returns optimistically with the intended visibility.

Parameters:

  • change_feed_visibility_request (ChangeFeedVisibilityRequest)

Returns:



99
100
101
102
103
 
# File 'lib/getstream_ruby/generated/feed.rb', line 99

def change_feed_visibility(change_feed_visibility_request)

  # Delegate to the FeedsClient
  @client.feeds.change_feed_visibility(@feed_group_id, @feed_id, change_feed_visibility_request)
end

#delete_feed(hard_delete = nil, purge_user_activities = nil) ⇒ Models::DeleteFeedResponse

Delete a single feed by its ID

Parameters:

  • hard_delete (Boolean) (defaults to: nil)
  • purge_user_activities (Boolean) (defaults to: nil)

Returns:



22
23
24
25
26
27
28
29
30
 
# File 'lib/getstream_ruby/generated/feed.rb', line 22

def delete_feed(hard_delete = nil, purge_user_activities = nil)
  # Build query parameters
  query_params = {}
  query_params['hard_delete'] = hard_delete unless hard_delete.nil?
  query_params['purge_user_activities'] = purge_user_activities unless purge_user_activities.nil?

  # Delegate to the FeedsClient
  @client.feeds.delete_feed(@feed_group_id, @feed_id, query_params)
end

#get_or_create_feed(get_or_create_feed_request, language = nil, translate_text = nil) ⇒ Models::GetOrCreateFeedResponse

Create a single feed for a given feed group

Parameters:

  • get_or_create_feed_request (GetOrCreateFeedRequest)
  • language (String) (defaults to: nil)
  • translate_text (Boolean) (defaults to: nil)

Returns:



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

def get_or_create_feed(get_or_create_feed_request, language = nil, translate_text = nil)
  # Build query parameters
  query_params = {}
  query_params['language'] = language unless language.nil?
  query_params['translate_text'] = translate_text unless translate_text.nil?

  # Delegate to the FeedsClient
  @client.feeds.get_or_create_feed(@feed_group_id, @feed_id, get_or_create_feed_request, query_params)
end

#mark_activity(mark_activity_request) ⇒ Models::Response

Mark activities as read/seen/watched. Can mark by timestamp (seen), activity IDs (read), or all as read.

Parameters:

  • mark_activity_request (MarkActivityRequest)

Returns:



62
63
64
65
66
 
# File 'lib/getstream_ruby/generated/feed.rb', line 62

def mark_activity(mark_activity_request)

  # Delegate to the FeedsClient
  @client.feeds.mark_activity(@feed_group_id, @feed_id, mark_activity_request)
end

#pin_activity(activity_id, pin_activity_request) ⇒ Models::PinActivityResponse

Pin an activity to a feed. Pinned activities are typically displayed at the top of a feed.

Parameters:

  • activity_id (String)
  • pin_activity_request (PinActivityRequest)

Returns:



89
90
91
92
93
 
# File 'lib/getstream_ruby/generated/feed.rb', line 89

def pin_activity(activity_id, pin_activity_request)

  # Delegate to the FeedsClient
  @client.feeds.pin_activity(@feed_group_id, @feed_id, activity_id, pin_activity_request)
end

#query_feed_members(query_feed_members_request) ⇒ Models::QueryFeedMembersResponse

Query feed members based on filters with pagination and sorting options

Parameters:

  • query_feed_members_request (QueryFeedMembersRequest)

Returns:



129
130
131
132
133
 
# File 'lib/getstream_ruby/generated/feed.rb', line 129

def query_feed_members(query_feed_members_request)

  # Delegate to the FeedsClient
  @client.feeds.query_feed_members(@feed_group_id, @feed_id, query_feed_members_request)
end

#query_pinned_activities(query_pinned_activities_request, language = nil, translate_text = nil) ⇒ Models::QueryPinnedActivitiesResponse

Query pinned activities for a feed with filter query

Parameters:

  • query_pinned_activities_request (QueryPinnedActivitiesRequest)
  • language (String) (defaults to: nil)
  • translate_text (Boolean) (defaults to: nil)

Returns:



151
152
153
154
155
156
157
158
159
 
# File 'lib/getstream_ruby/generated/feed.rb', line 151

def query_pinned_activities(query_pinned_activities_request, language = nil, translate_text = nil)
  # Build query parameters
  query_params = {}
  query_params['language'] = language unless language.nil?
  query_params['translate_text'] = translate_text unless translate_text.nil?

  # Delegate to the FeedsClient
  @client.feeds.query_pinned_activities(@feed_group_id, @feed_id, query_pinned_activities_request, query_params)
end

#reject_feed_member_invite(reject_feed_member_invite_request) ⇒ Models::RejectFeedMemberInviteResponse

Rejects a pending feed member request

Parameters:

  • reject_feed_member_invite_request (RejectFeedMemberInviteRequest)

Returns:



139
140
141
142
143
 
# File 'lib/getstream_ruby/generated/feed.rb', line 139

def reject_feed_member_invite(reject_feed_member_invite_request)

  # Delegate to the FeedsClient
  @client.feeds.reject_feed_member_invite(@feed_group_id, @feed_id, reject_feed_member_invite_request)
end

#unpin_activity(activity_id, enrich_own_fields = nil, user_id = nil) ⇒ Models::UnpinActivityResponse

Unpin an activity from a feed. This removes the pin, so the activity will no longer be displayed at the top of the feed.

Parameters:

  • activity_id (String)
  • enrich_own_fields (Boolean) (defaults to: nil)
  • user_id (String) (defaults to: nil)

Returns:



74
75
76
77
78
79
80
81
82
 
# File 'lib/getstream_ruby/generated/feed.rb', line 74

def unpin_activity(activity_id, enrich_own_fields = nil, user_id = nil)
  # Build query parameters
  query_params = {}
  query_params['enrich_own_fields'] = enrich_own_fields unless enrich_own_fields.nil?
  query_params['user_id'] = user_id unless user_id.nil?

  # Delegate to the FeedsClient
  @client.feeds.unpin_activity(@feed_group_id, @feed_id, activity_id, query_params)
end

#update_feed(update_feed_request) ⇒ Models::UpdateFeedResponse

Update an existing feed

Parameters:

  • update_feed_request (UpdateFeedRequest)

Returns:



52
53
54
55
56
 
# File 'lib/getstream_ruby/generated/feed.rb', line 52

def update_feed(update_feed_request)

  # Delegate to the FeedsClient
  @client.feeds.update_feed(@feed_group_id, @feed_id, update_feed_request)
end

#update_feed_members(update_feed_members_request) ⇒ Models::UpdateFeedMembersResponse

Add, remove, or set members for a feed

Parameters:

  • update_feed_members_request (UpdateFeedMembersRequest)

Returns:



109
110
111
112
113
 
# File 'lib/getstream_ruby/generated/feed.rb', line 109

def update_feed_members(update_feed_members_request)

  # Delegate to the FeedsClient
  @client.feeds.update_feed_members(@feed_group_id, @feed_id, update_feed_members_request)
end