Stream Activity Feeds

https://getstream.io/activity-feeds/docs
Admin
Stream Activity Feeds is an API for building enterprise-ready activity feeds to grow user engagement...
Tokens:624,887
Snippets:4,965
Trust Score:10
Update:1 month ago
Show doc for...
Tokens:
Raw
### Install Go SDK

Source: https://getstream.io/activity-feeds/docs/go-golang/installation.md

Install the specific version of the GetStream Go SDK.

```bash
go get github.com/GetStream/getstream-go/v6@v6.0.0
```

--------------------------------

### Install @stream-io/feeds-client package

Source: https://getstream.io/activity-feeds/docs/javascript/installation.md

Install the client SDK using npm or yarn.

```bash
npm install @stream-io/feeds-client
# or using yarn
yarn add @stream-io/feeds-client
```

--------------------------------

### Install Stream Feeds SDK

Source: https://getstream.io/activity-feeds/docs/react-native/installation.md

Install the core SDK using npm or yarn.

```bash
npm install @stream-io/feeds-react-native-sdk
# or using yarn
yarn add @stream-io/feeds-react-native-sdk
```

--------------------------------

### Install Python SDK

Source: https://getstream.io/activity-feeds/docs/python/installation.md

Command to install the getstream package via pip.

```bash
pip install getstream
```

--------------------------------

### Install Stream Node SDK

Source: https://getstream.io/activity-feeds/docs/node/installation.md

Install the official Node.js SDK using npm or yarn.

```bash
npm install @stream-io/node-sdk
// or using yarn
yarn add @stream-io/node-sdk
```

--------------------------------

### Install getstream-ruby Gem

Source: https://getstream.io/activity-feeds/docs/ruby/installation.md

Command to install the Ruby SDK gem.

```bash
gem install getstream-ruby
```

--------------------------------

### Install PHP SDK via Composer

Source: https://getstream.io/activity-feeds/docs/php/installation.md

Install the latest 6.x PHP SDK using Composer.

```bash
composer require getstream/getstream-php:^6.0.0
```

--------------------------------

### Install Stream CLI and Agent Skills

Source: https://getstream.io/activity-feeds/docs/ios/installation.md

Commands to install the Stream CLI and add the Swift-specific agent skills to your project.

```bash
curl -fsSL https://getstream.io/cli.sh | bash
getstream skills stream-swift
```

--------------------------------

### Install NuGet Package

Source: https://getstream.io/activity-feeds/docs/dotnet-csharp/installation.md

Command to install the getstream-net package using the NuGet Package Manager.

```bash
NuGet\Install-Package getstream-net -Version 11.0.0
```

--------------------------------

### Install Stream CLI and Agent Skills

Source: https://getstream.io/activity-feeds/docs/react/installation.md

Commands to install the Stream CLI and add the stream-react skill for AI coding agents.

```bash
curl -fsSL https://getstream.io/cli.sh | bash
getstream skills stream-react
```

--------------------------------

### Install Stream CLI and initialize Agent Skills

Source: https://getstream.io/activity-feeds/docs.md

Use these commands to install the Stream CLI via curl and initialize the Agent Skills pack for your terminal.

```bash
curl -fsSL https://getstream.io/cli.sh | bash
getstream skills
```

--------------------------------

### Install Stream CLI and Agent Skills

Source: https://getstream.io/activity-feeds/docs/android/installation.md

Use these commands to install the Stream CLI and add the Android-specific agent skills to your project.

```bash
curl -fsSL https://getstream.io/cli.sh | bash
getstream skills stream-android
```

--------------------------------

### Bookmark Folders Queryable Built-In Fields Examples

Source: https://getstream.io/activity-feeds/docs/flutter/bookmarks.md

Examples of filter syntax for querying bookmark folders based on user ID, folder name, and timestamps.

```json
{ user_id: { $eq: 'user_123' } }
```

```json
{ folder_name: { $contains: 'work' } }
```

```json
{ created_at: { $gte: '2023-12-04T09:30:20.45Z' } }
```

```json
{ updated_at: { $gte: '2023-12-04T09:30:20.45Z' } }
```

--------------------------------

### Querying activities with filters

Source: https://getstream.io/activity-feeds/docs/php/query-activities.md

Basic example of querying activities with a limit, type filter, and sorting.

```php
$response = $feedsClient->queryActivities(
    new GeneratedModels\QueryActivitiesRequest(
        limit: 10,
        filter: (object)['activity_type' => 'post'],
        sort: [['field' => 'created_at', 'direction' => -1]]
    )
);
```

--------------------------------

### Initialize Client from .env File

Source: https://getstream.io/activity-feeds/docs/ruby/installation.md

Configure the client using a .env file in your project root.

```bash
STREAM_API_KEY=your_api_key
STREAM_API_SECRET=your_api_secret
```

```ruby
require 'getstream_ruby'

# Initialize client from .env file
client = GetStreamRuby.env
# or
client = GetStreamRuby.client  # defaults to .env

# Get the feeds client
feeds_client = client.feeds
```

--------------------------------

### Configure onNewActivity in React Native

Source: https://getstream.io/activity-feeds/docs/react-native/activities.md

Use the onNewActivity callback to define custom logic for incoming activities. This example filters activities based on the current request configuration and adds them to the start of the list if they belong to the current user.

```js
import { activityFilter } from "@stream-io/feeds-react-native-sdk";

const feed = client.feed("user", userId, {
  onNewActivity: ({ activity, currentUser }) => {
    const requestConfig = feed.currentState.last_get_or_create_request_config;
    if (!activityFilter(activity, requestConfig)) return "ignore";
    return activity.user.id === currentUser?.id ? "add-to-start" : "ignore";
  },
});
```

--------------------------------

### Install Peer Dependencies

Source: https://getstream.io/activity-feeds/docs/react-native/installation.md

Install the mandatory @react-native-community/netinfo dependency.

```bash
npm install @react-native-community/netinfo
# or using yarn
yarn add @react-native-community/netinfo
```

--------------------------------

### Initialize Client from Environment Variables

Source: https://getstream.io/activity-feeds/docs/ruby/installation.md

Configure the client using environment variables set in the shell or via ENV.

```ruby
require 'getstream_ruby'

# Set environment variables (or export them in your shell)
ENV['STREAM_API_KEY'] = 'your_api_key'
ENV['STREAM_API_SECRET'] = 'your_api_secret'

# Initialize client from environment variables
client = GetStreamRuby.env_vars

# Get the feeds client
feeds_client = client.feeds
```

--------------------------------

### Initialize Client from Environment Variables

Source: https://getstream.io/activity-feeds/docs/python/installation.md

Initialize the client using environment variables for API credentials.

```python
import os
import stream

# Set environment variables
os.environ['STREAM_API_KEY'] = 'your_api_key'
os.environ['STREAM_API_SECRET'] = 'your_api_secret'

# Initialize client from environment
client = stream.connect_from_env()

# Get the feeds client
feeds_client = client.feeds
```

--------------------------------

### Initialize Client with Configuration

Source: https://getstream.io/activity-feeds/docs/dotnet-csharp/installation.md

Initialization of the Stream client using Microsoft.Extensions.Configuration to load settings from appsettings.json.

```csharp
using GetStream;
using Microsoft.Extensions.Configuration;

// Using configuration
var configuration = new ConfigurationBuilder()
    .AddJsonFile("appsettings.json")
    .Build();

var builder = new ClientBuilder()
    .ApiKey(configuration["Stream:ApiKey"])
    .ApiSecret(configuration["Stream:Secret"]);

var client = builder.Build();
var feedsClient = builder.BuildFeedsClient();
```

--------------------------------

### Managing Bookmark Folders

Source: https://getstream.io/activity-feeds/docs/ruby/bookmarks.md

Demonstrates adding a bookmark with a new folder, updating an existing folder, and deleting a folder.

```ruby
# Add a bookmark with a new folder
add_response = client.feeds.add_bookmark(
  activity_id,
  GetStream::Generated::Models::AddBookmarkRequest.new(
    user_id: 'user123',
    new_folder: GetStream::Generated::Models::AddFolderRequest.new(
      name: 'Breakfast recipes',
      custom: { icon: '🍳' }
    )
  )
)
folder_id = add_response.bookmark.folder.id

# Update the folder
update_response = client.feeds.update_bookmark_folder(
  folder_id,
  GetStream::Generated::Models::UpdateBookmarkFolderRequest.new(
    name: 'Sweet Breakfast Recipes',
    custom: { icon: '🥞' }
  )
)

# Delete the folder (and all bookmarks in it)
client.feeds.delete_bookmark_folder(update_response.bookmark_folder.id)
```

--------------------------------

### Proximity Activity Selector Example

Source: https://getstream.io/activity-feeds/docs/ios/activity-selectors.md

Placeholder example for the proximity activity selector in Swift.

```swift

```

--------------------------------

### Add and Update Bookmarks in Go

Source: https://getstream.io/activity-feeds/docs/go-golang/bookmarks.md

Examples of adding bookmarks to new or existing folders, and updating bookmarks to move them between folders or add custom data.

```go
// Adding a bookmark to a new folder
_, err = client.Feeds().AddBookmark(context.Background(), activityID, &getstream.AddBookmarkRequest{
  UserID: getstream.PtrTo("john"),
})
if err != nil {
  log.Fatal("Error adding bookmark:", err)
}

// Adding to an existing folder
_, err = client.Feeds().AddBookmark(context.Background(), activityID, &getstream.AddBookmarkRequest{
  FolderID: getstream.PtrTo("folder_456"),
  UserID:   getstream.PtrTo("john"),
})
if err != nil {
  log.Fatal("Error adding bookmark to folder:", err)
}

// Update a bookmark (without a folder initially) - add custom data and move it to a new folder
_, err = client.Feeds().UpdateBookmark(context.Background(), activityID, &getstream.UpdateBookmarkRequest{
  FolderID: getstream.PtrTo("old folder id"),
  NewFolder: &getstream.AddFolderRequest{
    Name: "New folder name",
    Custom: map[string]any{
      "icon": "📂",
    },
  },
  Custom: getstream.PtrTo(map[string]any{
    "color": "blue",
  }),
  UserID: getstream.PtrTo("john"),
})
if err != nil {
  log.Fatal("Error updating bookmark:", err)
}

// Update a bookmark - move it from one existing folder to another existing folder
_, err = client.Feeds().UpdateBookmark(context.Background(), activityID, &getstream.UpdateBookmarkRequest{
  FolderID:    getstream.PtrTo("old folder id"),
  NewFolderID: getstream.PtrTo("new folder id"),
  UserID:      getstream.PtrTo("john"),
})
if err != nil {
  log.Fatal("Error moving bookmark:", err)
}
```

--------------------------------

### Query Syntax Example: option_id

Source: https://getstream.io/activity-feeds/docs/go-golang/polls.md

Example filter for the option_id field using the $in operator.

```json
{ "option_id": { "$in": ["abcd", "defg"] } }
```

--------------------------------

### Query Syntax Example: id

Source: https://getstream.io/activity-feeds/docs/go-golang/polls.md

Example filter for the id field using the $in operator.

```json
{ "id": { "$in": ["abcd", "defg"] } }
```

--------------------------------

### Querying Bookmark Folders

Source: https://getstream.io/activity-feeds/docs/go-golang/bookmarks.md

Demonstrates how to query bookmark folders with pagination and filtering by user ID or folder name.

```go
// Query bookmark folders
firstPage, err := client.Feeds().QueryBookmarkFolders(context.Background(), &getstream.QueryBookmarkFoldersRequest{
  Filter: getstream.PtrTo(map[string]any{
    "user_id": "<user id>",
  }),
  Limit: getstream.PtrTo(2),
})
if err != nil {
  log.Fatal("Error querying bookmark folders:", err)
}
// Get next page
_, err = client.Feeds().QueryBookmarkFolders(context.Background(), &getstream.QueryBookmarkFoldersRequest{
  Filter: getstream.PtrTo(map[string]any{
    "user_id": "<user id>",
  }),
  Limit: getstream.PtrTo(2),
  Next:  firstPage.Data.Next,
})
if err != nil {
  log.Fatal("Error querying bookmark folders second page:", err)
}

// Query with folder name filter
_, err = client.Feeds().QueryBookmarkFolders(context.Background(), &getstream.QueryBookmarkFoldersRequest{
  Filter: getstream.PtrTo(map[string]any{
    "user_id": "<user id>",
    "folder_name": map[string]any{
      "$contains": "project",
    },
  }),
  Limit: getstream.PtrTo(2),
  Next:  firstPage.Data.Next,
})
if err != nil {
  log.Fatal("Error querying bookmark folders with filter:", err)
}
```

--------------------------------

### Upload files and create activities in C#

Source: https://getstream.io/activity-feeds/docs/dotnet-csharp/file-uploads.md

Demonstrates uploading an image with optional resize parameters, uploading a regular file, and creating an activity with the resulting file attachments.

```csharp
// Upload an image file
var imageUploadRequest = new ImageUploadRequest
{
    File = "/path/to/image.jpg",
    User = new OnlyUserID
    {
        ID = "john"
    },
    // Optionally provide resize params
    UploadSizes = new List<ImageSize>
    {
        new ImageSize { Width = 100, Height = 100, Resize = "scale", Crop = "center" }
    }
};
var imageResponse = await client.ImageUploadAsync(imageUploadRequest);
var imageUrl = imageResponse.Data.File;

// Upload a regular file
var fileUploadRequest = new FileUploadRequest
{
    File = "/path/to/document.pdf",
    User = new OnlyUserID
    {
        ID = "john"
    }
};
var fileResponse = await client.FileUploadAsync(fileUploadRequest);
var fileUrl = fileResponse.Data.File;

// Create activity with uploaded attachments
var activity = new AddActivityRequest
{
    Type = "post",
    Text = "Look at this amazing view of NYC!",
    UserID = "john",
    Feeds = new List<string> { "user:john" },
    Attachments = new List<Attachment>
    {
        new Attachment
        {
            ImageUrl = imageUrl,
            Type = "image",
            Title = "NYC Skyline"
        }
    },
    Custom = new Dictionary<string, object>
    {
        ["location"] = "New York City",
        ["camera"] = "iPhone 15 Pro"
    }
};
var response = await feedsClient.AddActivityAsync(activity);
```

--------------------------------

### Create a feed in Swift

Source: https://getstream.io/activity-feeds/docs/ios/feeds.md

Demonstrates how to initialize a feed using a group and ID, and how to use FeedQuery for more complex feed configurations.

```swift
// Feed with no extra fields, of feed group "user"
let feed = client.feed(group: "user", id: "john")
try await feed.getOrCreate()

// More options
let query = FeedQuery(
    group: "user",
    id: "jack",
    data: .init(
        description: "My personal feed",
        name: "jack",
        visibility: "public",
        filterTags: ["tech", "hiking", "cooking"]
    )
)
let feed2 = client.feed(for: query)
try await feed.getOrCreate()
```

--------------------------------

### Membership level filter examples

Source: https://getstream.io/activity-feeds/docs/java/membership-levels.md

Examples of filter objects for various membership level fields.

```json
{ id: { $in: [ 'abc', 'xyz' ] } }
```

```json
{ name: { $in: [ 'abc', 'xyz' ] } }
```

```json
{ description: { $in: [ 'abc', 'xyz' ] } }
```

```json
{ priority: { $gte: 100 } }
```

```json
{ tags: { $in: [ 'premium', 'inner-circle' ] } }
```

```json
{ custom: { $contains: {creator_id: '123' } } }
```

```json
{ created_at: { $gte: '2023-12-04T09:30:20.45Z' } }
```

```json
{ updated_at: { $gte: '2023-12-04T09:30:20.45Z' } }
```

--------------------------------

### Create a Feed in Java

Source: https://getstream.io/activity-feeds/docs/android/feeds.md

Demonstrates initializing feeds and using GetOrCreateFeedRequest to configure feed metadata.

```java
testFeed = new Feed("user", testUserId, feeds);
testFeed2 = new Feed("user", testUserId2, feeds);

GetOrCreateFeedRequest feedRequest1 =
    GetOrCreateFeedRequest.builder().userID(testUserId).filterTags(List.of("tech", "hiking", "cooking")).build();
GetOrCreateFeedRequest feedRequest2 =
    GetOrCreateFeedRequest.builder().userID(testUserId2).filterTags(List.of("tech", "hiking", "cooking")).build();

GetOrCreateFeedResponse feedResponse1 = testFeed.getOrCreate(feedRequest1).getData();
GetOrCreateFeedResponse feedResponse2 = testFeed2.getOrCreate(feedRequest2).getData();
testFeedId = feedResponse1.getFeed().getFeed();
testFeedId2 = feedResponse2.getFeed().getFeed();
```

--------------------------------

### Query Syntax Example: user_id

Source: https://getstream.io/activity-feeds/docs/go-golang/polls.md

Example filter for the user_id field using the $eq operator.

```json
{ "user_id": { "$eq": "abcd" } }
```

--------------------------------

### Query Syntax Example: poll_id

Source: https://getstream.io/activity-feeds/docs/go-golang/polls.md

Example filter for the poll_id field using the $eq operator.

```json
{ poll_id: { $eq: 'poll_123' } }
```

--------------------------------

### Comment queryable field examples

Source: https://getstream.io/activity-feeds/docs/dotnet-csharp/comments.md

Examples of filter syntax for various built-in comment fields.

```text
{ id: { $in: [ 'comment_123', 'comment_456' ] } }
```

```text
{ user_id: { $eq: 'user_123' } }
```

```text
{ object_type: { $in: [ 'activity', 'post' ] } }
```

```text
{ object_id: { $eq: 'activity_123' } }
```

```text
{ parent_id: { $eq: 'comment_parent_123' } }
```

```text
{ comment_text: { $q: 'search terms' } }
```

```text
{ reply_count: { $gte: 5 } }
```

```text
{ upvote_count: { $gte: 10 } }
```

```text
{ downvote_count: { $lt: 5 } }
```

```text
{ score: { $gte: 0 } }
```

```text
{ confidence_score: { $gte: 0.5 } }
```

```text
{ controversy_score: { $lt: 0.8 } }
```

```text
{ created_at: { $gte: '2023-12-04T09:30:20.45Z' } }
```

```text
{ 'custom.priority': { $gte: 10 } }
```

--------------------------------

### Initialize and use Go SDK for Feeds

Source: https://getstream.io/activity-feeds/docs/go-golang.md

Initializes the Go client, retrieves or creates a feed, and adds an activity to that feed.

```go
import (
    "context"
    "log"
    "github.com/GetStream/getstream-go/v6"
)

client, err := getstream.NewClient("api_key", "api_secret")
if err != nil {
    log.Fatal(err)
}

feedsClient := client.Feeds()

feed := feedsClient.Feed("user", "john")

// Get or create the feed
feedResponse, err := feed.GetOrCreate(context.Background(), &getstream.GetOrCreateFeedRequest{
    UserID: getstream.PtrTo("john"),
})

if err != nil {
    log.Fatal("Error getting/creating feed:", err)
}
log.Printf("Response: %+v\n", feedResponse)

// Add activity to the specific feed
response, err := feedsClient.AddActivity(context.Background(), &getstream.AddActivityRequest{
    Feeds: []string{feedResponse.Data.Feed.Feed},
    Type: "post",
    Text: getstream.PtrTo("Hello, Stream Feeds!"),
    UserID: getstream.PtrTo("john"),
})
log.Printf("Response: %+v\n", response)
```

--------------------------------

### Query Syntax Example: is_answer

Source: https://getstream.io/activity-feeds/docs/go-golang/polls.md

Example filter for the is_answer boolean field using the $eq operator.

```json
{ "is_answer": { "$eq": true } }
```

--------------------------------

### Upload images and files in Go

Source: https://getstream.io/activity-feeds/docs/go-golang/file-uploads.md

Demonstrates uploading an image with specific resize dimensions and a regular file, then attaching the image to an activity.

```go
import (
    "context"
    "os"
    "github.com/GetStream/getstream-go/v6"
)

// Upload an image file
tmpFile, err := os.CreateTemp("", "test-image-*.jpg")
if err != nil {
    log.Fatal(err)
}
defer os.Remove(tmpFile.Name())

// Write some test image content (in real usage, use actual image data)
tmpFile.WriteString("fake-image-data")
tmpFile.Close()

uploadReq := &getstream.UploadImageRequest{
    File: getstream.PtrTo(tmpFile.Name()),
    UploadSizes: getstream.PtrTo([]getstream.ImageSize{
        {Width: getstream.PtrTo(100), Height: getstream.PtrTo(100), Resize: getstream.PtrTo("scale"), Crop: getstream.PtrTo("center")},
    }),
    User: &getstream.OnlyUserID{
        ID: "john",
    },
}

imageResponse, err := client.UploadImage(context.Background(), uploadReq)
if err != nil {
    log.Fatal("Error uploading image:", err)
}

// Upload a regular file
tmpFile2, err := os.CreateTemp("", "test-file-*.pdf")
if err != nil {
    log.Fatal(err)
}
defer os.Remove(tmpFile2.Name())

tmpFile2.WriteString("fake-file-data")
tmpFile2.Close()

fileUploadReq := &getstream.UploadFileRequest{
    File: getstream.PtrTo(tmpFile2.Name()),
    User: &getstream.OnlyUserID{
        ID: "john",
    },
}

fileResponse, err := client.UploadFile(context.Background(), fileUploadReq)
if err != nil {
    log.Fatal("Error uploading file:", err)
}

// Use the uploaded file URLs in activity attachments
feedsClient := client.Feeds()
response, err := feedsClient.AddActivity(context.Background(), &getstream.AddActivityRequest{
    Type:   "post",
    Feeds:  []string{"user:john"},
    Text:   getstream.PtrTo("Look at this amazing view of NYC!"),
    UserID: getstream.PtrTo("john"),
    Attachments: getstream.PtrTo([]getstream.Attachment{
        {
            ImageUrl: imageResponse.Data.File,
            Type:     getstream.PtrTo("image"),
            Title:    getstream.PtrTo("NYC Skyline"),
        },
    }),
    Custom: getstream.PtrTo(map[string]any{
        "location": "New York City",
        "camera":   "iPhone 15 Pro",
    }),
})
if err != nil {
    log.Fatal("Error adding activity:", err)
}
```

--------------------------------

### Fetch activity and manage state updates in JavaScript

Source: https://getstream.io/activity-feeds/docs/dotnet-csharp/activities.md

Demonstrates fetching an activity, subscribing to real-time state updates, and watching the associated feed. Includes cleanup steps using dispose and stopWatching.

```javascript
const activityWithStateUpdates =
  client.activityWithStateUpdates(activityId);
await activityWithStateUpdates.get({
  // Optionally fetch comments too
  comments: {
    limit: 10,
    depth: 2,
  },
});

// Subscribe to state updates
activityWithStateUpdates.state.subscribe((state) => {
  console.log(state.activity);
  console.log(state.comments_by_entity_id);
  // True if activity is being fetched
  console.log(state.is_loading);
});
// Comment pagination
activityWithStateUpdates.loadNextPageActivityComments;
activityWithStateUpdates.loadNextPageCommentReplies;

// Optionally start watching the feed
// If activity belongs to multiple feeds, it's up to you to choose which feed to watch
const fid = activityWithStateUpdates.currentState.activity!.feeds[0];
const [group, id] = fid.split(':');
const feed = client.feed(group, id);
let shouldWatch = false;
if (!feed.currentState.watch) {
  await feed.getOrCreate({
    watch: true,
    limit: 0,
    followers_pagination: { limit: 0 },
    following_pagination: { limit: 0 },
  });
}

// When leaving the page...
// Dispose the activity; this avoids refetching the activity if WebSocket reconnects
activityWithStateUpdates.dispose();
// You should stop watching the feed, unless your app has another component that watches the same feed
if (shouldWatch) {
  await feed.stopWatching();
}

// If you don't care about state updates, no need to call activityWithStateUpdates
await client.getActivity({
  id: activityId,
});
```

--------------------------------

### Poll Queryable Built-In Fields Examples

Source: https://getstream.io/activity-feeds/docs/android/polls.md

Examples of JSON filter objects for various poll fields.

```json
{ "id": { "$in": ["abcd", "defg"] } }
```

```json
{ "name": { "$eq": "abcd" } }
```

```json
{ "voting_visibility": { "$eq": "anonymous" } }
```

```json
{ "max_votes_allowed": { "$gte": 5 } }
```

```json
{ "allow_user_suggested_options": { "$eq": false } }
```

```json
{ "allow_answers": { "$eq": false } }
```

```json
{ "is_closed": { "$eq": true } }
```

```json
{ "created_at": { "$gte": "2023-12-04T09:30:20.45Z" } }
```

```json
{ "updated_at": { "$gte": "2023-12-04T09:30:20.45Z" } }
```

```json
{ "created_by_id": { "$in": ["abcd", "defg"] } }
```

--------------------------------

### Install React SDK via Package Manager

Source: https://getstream.io/activity-feeds/docs/react/installation.md

Commands to install the @stream-io/feeds-react-sdk package using npm or yarn.

```bash
npm install @stream-io/feeds-react-sdk
# or using yarn
yarn add @stream-io/feeds-react-sdk
```

--------------------------------

### Follow feeds in Swift

Source: https://getstream.io/activity-feeds/docs/ios/follows.md

Examples of following user and stock feeds, including an example with custom metadata fields.

```swift
// Follow a user
let timeline = client.feed(group: "timeline", id: "john")
_ = try await timeline.follow(FeedId(group: "user", id: "tom"))

// Follow a stock
_ = try await timeline.follow(FeedId(group: "stock", id: "apple"))

// Follow with more fields
_ = try await timeline.follow(
    FeedId(group: "stock", id: "apple"),
    custom: ["reason": "investment"]
)
```

--------------------------------

### Managing Bookmark Folders Lifecycle

Source: https://getstream.io/activity-feeds/docs/go-golang/bookmarks.md

Shows the workflow for adding a bookmark with a new folder, updating that folder's properties, and deleting the folder.

```go
// Add a bookmark with a new folder
addResp, err := client.Feeds().AddBookmark(context.Background(), activityID, &getstream.AddBookmarkRequest{
  UserID: getstream.PtrTo("john"),
  NewFolder: &getstream.AddFolderRequest{
    Name:   "Breakfast recipes",
    Custom: map[string]any{"icon": "🍳"},
  },
})
if err != nil {
  log.Fatal(err)
}
folderID := addResp.Data.Bookmark.Folder.ID

// Update the folder
updateResp, err := client.Feeds().UpdateBookmarkFolder(context.Background(), folderID, &getstream.UpdateBookmarkFolderRequest{
  Name:   getstream.PtrTo("Sweet Breakfast Recipes"),
  Custom: getstream.PtrTo(map[string]any{"icon": "🥞"}),
})
if err != nil {
  log.Fatal(err)
}

// Delete the folder (and all bookmarks in it)
_, err = client.Feeds().DeleteBookmarkFolder(context.Background(), updateResp.Data.BookmarkFolder.ID)
if err != nil {
  log.Fatal(err)
}
```

--------------------------------

### Query Syntax Example: created_at

Source: https://getstream.io/activity-feeds/docs/go-golang/polls.md

Example filter for the created_at field using the $gte operator with an RFC3339 timestamp.

```json
{ "created_at": { "$gte": "2023-12-04T09:30:20.45Z" } }
```

--------------------------------

### client.activity()

Source: https://getstream.io/activity-feeds/docs/android/activities.md

Initializes an activity instance to fetch data and manage state.

```APIDOC
## client.activity(activityId: String, fid: FeedId)

### Description
Creates an activity instance to interact with a specific activity identified by its ID and feed ID.

### Parameters
- **activityId** (String) - Required - The unique identifier of the activity.
- **fid** (FeedId) - Required - The feed identifier the activity belongs to.
```

--------------------------------

### Manage Bookmark Folders in PHP

Source: https://getstream.io/activity-feeds/docs/php/bookmarks.md

Demonstrates adding a bookmark with a new folder, updating an existing folder, and deleting a folder using the PHP SDK.

```php
// Add a bookmark with a new folder
$addResponse = $feedsClient->addBookmark(
    $activityId,
    new GeneratedModels\AddBookmarkRequest(
        userID: 'user_123',
        newFolder: new GeneratedModels\AddFolderRequest(
            name: 'Breakfast recipes',
            custom: (object)['icon' => '🍳']
        )
    )
);
$folderId = $addResponse->getData()->bookmark->folder->id;

// Update the folder
$updateResponse = $feedsClient->updateBookmarkFolder(
    $folderId,
    new GeneratedModels\UpdateBookmarkFolderRequest(
        name: 'Sweet Breakfast Recipes',
        custom: (object)['icon' => '🥞']
    )
);

// Delete the folder (and all bookmarks in it)
$feedsClient->deleteBookmarkFolder($updateResponse->getData()->bookmarkFolder->id);
```

--------------------------------

### Install Stream CLI via shell script

Source: https://getstream.io/activity-feeds/docs/android/hot-feed-cache

Use this command to install the Stream CLI using a shell script.

```bash
curl -fsSL https://getstream.io/cli.sh | bash
```

--------------------------------

### Adding Bookmarks in Kotlin

Source: https://getstream.io/activity-feeds/docs/android/bookmarks.md

Examples of adding bookmarks to new or existing folders, and updating bookmark data or folder locations.

```kotlin
// Adding a bookmark to a new folder
val bookmark: Result<BookmarkData> = feed.addBookmark(activityId = "activity_123")

// Adding to an existing folder
val bookmarkWithFolder: Result<BookmarkData> = feed.addBookmark(
    activityId = "activity_123",
    request = AddBookmarkRequest(folderId = "folder_456")
)

// Update a bookmark (without a folder initially) - add custom data and move it to a new folder
val updatedBookmark: Result<BookmarkData> = feed.updateBookmark(
    activityId = "activity_123",
    request = UpdateBookmarkRequest(
        custom = mapOf("color" to "blue"),
        newFolder = AddFolderRequest(
            custom = mapOf("icon" to "📁"),
            name = "New folder name"
        )
    )
)

// Update a bookmark - move it from one existing folder to another existing folder
val movedBookmark: Result<BookmarkData> = feed.updateBookmark(
    activityId = "activity_123",
    request = UpdateBookmarkRequest(
        folderId = "folder_456",
        newFolderId = "folder_789"
    )
)
```

--------------------------------

### Install Stream CLI and Agent Skills

Source: https://getstream.io/activity-feeds/docs/react-native/installation.md

Commands to install the Stream CLI and add React Native agent skills to your project.

```bash
curl -fsSL https://getstream.io/cli.sh | bash
getstream skills stream-react-native
```

--------------------------------

### Query Bookmark Folders in PHP

Source: https://getstream.io/activity-feeds/docs/php/bookmarks.md

Examples of querying bookmark folders with pagination and partial name matching using the PHP SDK.

```php
// Query bookmark folders
$firstPage = $feedsClient->queryBookmarkFolders(
    new GeneratedModels\QueryBookmarkFoldersRequest(
        limit: 2,
        filter: (object)['user_id' => 'user_123']
    )
);

// Get next page
$secondPage = $feedsClient->queryBookmarkFolders(
    new GeneratedModels\QueryBookmarkFoldersRequest(
        limit: 2,
        next: $firstPage->getData()->next,
        filter: (object)['user_id' => 'user_123']
    )
);

// Query by folder name (partial matching)
$response = $feedsClient->queryBookmarkFolders(
    new GeneratedModels\QueryBookmarkFoldersRequest(
        filter: (object)[
            'user_id' => 'user_123',
            'folder_name' => [
                '$contains' => 'project'
            ]
        ],
        limit: 2
    )
);
```

--------------------------------

### Adding Bookmarks in Java

Source: https://getstream.io/activity-feeds/docs/android/bookmarks.md

Example of adding a bookmark using the Java SDK builder pattern.

```java
AddBookmarkRequest bookmarkRequest =
    AddBookmarkRequest.builder()
        .userID(testUserId)
        .newFolder(AddFolderRequest.builder().name("test-bookmarks1").build())
        .build();

AddBookmarkResponse response =
    feeds.addBookmark(activityId, bookmarkRequest).execute().getData();
```

--------------------------------

### Install Stream CLI and Agent Skills

Source: https://getstream.io/activity-feeds/docs/flutter/installation.md

Use these commands to install the Stream CLI and add the stream-flutter agent skills to your project.

```bash
curl -fsSL https://getstream.io/cli.sh | bash
getstream skills stream-flutter
```

--------------------------------

### Get or Create Feed with Enrichment Options

Source: https://getstream.io/activity-feeds/docs/go-golang/feeds.md

Demonstrates how to initialize a feed and request it with specific enrichment options using GetOrCreateFeedRequest.

```go
feed := client.Feeds().Feed("user", "jack")
request := &getstream.GetOrCreateFeedRequest{
  UserID: stringPtr("<user id>"),
  EnrichmentOptions: &getstream.EnrichmentOptions{
    // Configure enrichment options here
  },
}
response, err := feed.GetOrCreate(context.Background(), request)
```

--------------------------------

### Query Bookmarks in Go

Source: https://getstream.io/activity-feeds/docs/go-golang/bookmarks.md

Examples of querying bookmarks with pagination, filtering by activity ID, and filtering by folder ID.

```go
// Query bookmarks
firstPage, err := client.Feeds().QueryBookmarks(context.Background(), &getstream.QueryBookmarksRequest{
  Filter: getstream.PtrTo(map[string]any{
    "user_id": "john",
  }),
  Limit: getstream.PtrTo(2),
})
if err != nil {
  log.Fatal("Error querying bookmarks:", err)
}

// Get next page
_, err = client.Feeds().QueryBookmarks(context.Background(), &getstream.QueryBookmarksRequest{
  Filter: getstream.PtrTo(map[string]any{
    "user_id": "john",
  }),
  Limit: getstream.PtrTo(2),
  Next:  firstPage.Data.Next,
})
if err != nil {
  log.Fatal("Error querying next page bookmarks:", err)
}

// Query by activity ID
_, err = client.Feeds().QueryBookmarks(context.Background(), &getstream.QueryBookmarksRequest{
  Filter: getstream.PtrTo(map[string]any{
    "user_id":     "john",
    "activity_id": activityID,
  }),
})
if err != nil {
  log.Fatal("Error querying bookmarks by activity ID:", err)
}

// Query by folder ID
_, err = client.Feeds().QueryBookmarks(context.Background(), &getstream.QueryBookmarksRequest{
  Filter: getstream.PtrTo(map[string]any{
    "user_id":   "john",
    "folder_id": folderID,
  }),
})
if err != nil {
  log.Fatal("Error querying bookmarks by folder ID:", err)
}
```

--------------------------------

### Create Video Activity in Java

Source: https://getstream.io/activity-feeds/docs/android/activities.md

Shows how to create a video activity using the Java SDK.

```java
AddActivityRequest activity =
    AddActivityRequest.builder()
        .type("video")
        .feeds(List.of(testFeedId))
        .text("Check out this amazing video!")
        .userID(testUserId)
        .build();

AddActivityResponse response = feeds.addActivity(activity).execute().getData();
```

--------------------------------

### Follows Queryable Built-In Fields Examples

Source: https://getstream.io/activity-feeds/docs/flutter/follows.md

Examples of filter objects for various queryable fields including source_feed, target_feed, status, and created_at.

```json
{ source_feed: { $eq: 'messaging:general' } }
```

```json
{ target_feed: { $in: [ 'sports:news', 'tech:updates' ] } }
```

```json
{ status: { $in: [ 'accepted', 'pending', 'rejected' ] } }
```

```json
{ created_at: { $gte: '2023-12-04T09:30:20.45Z' } }
```

--------------------------------

### Feed Member Query Examples

Source: https://getstream.io/activity-feeds/docs/android/feed-members.md

Examples of filter syntax for various built-in fields including user_id, role, status, created_at, and updated_at.

```json
{ user_id: { $eq: 'user_123' } }
```

```json
{ role: { $in: [ 'admin', 'moderator', 'member' ] } }
```

```json
{ status: { $in: [ 'member', 'pending', 'rejected' ] } }
```

```json
{ created_at: { $gte: '2023-12-04T09:30:20.45Z' } }
```

```json
{ updated_at: { $gte: '2023-12-04T09:30:20.45Z' } }
```

--------------------------------

### Create a Notification Feed in Go

Source: https://getstream.io/activity-feeds/docs/go-golang.md

Shows how to initialize a notification feed for a specific user.

```go
feedsClient := client.Feeds()

// Create a notification feed
feedResponse, err := feedsClient.GetOrCreateFeed(context.Background(), "notification", "john", &getstream.GetOrCreateFeedRequest{
        UserID: getstream.PtrTo("john"),
})
if err != nil {
    log.Fatal(err)
}
log.Printf("Response: %+v\n", feedResponse)
```

--------------------------------

### Ranking Expression Examples

Source: https://getstream.io/activity-feeds/docs/android/activity-metrics.md

Various examples of ranking expressions using metrics, including weighted scores, time decay, and conditional logic.

```go
// Simple view-based ranking
metrics.views

// Weighted engagement score
metrics.views * 2 + metrics.clicks * 3 + metrics.impressions * 0.1

// Combined with popularity and time decay
decay_linear(time) * (popularity + metrics.views * 0.5)

// Conditional boost for popular content
metrics.views > 100 ? popularity * 2 : popularity
```

--------------------------------

### Initialize Client Manually

Source: https://getstream.io/activity-feeds/docs/ruby/installation.md

Create a client instance using your API key and secret directly.

```ruby
require 'getstream_ruby'

# Create client using manual configuration
client = GetStreamRuby.manual(
  api_key: 'your_api_key',
  api_secret: 'your_api_secret'
)

# Get the feeds client
feeds_client = client.feeds

# Your feeds operations here...
```

--------------------------------

### Vote Query Field Examples

Source: https://getstream.io/activity-feeds/docs/node/polls.md

Examples of filter objects for various queryable fields including id, poll_id, user_id, created_at, updated_at, is_answer, and option_id.

```json
{ "id": { "$in": ["abcd", "defg"] } }
```

```json
{ poll_id: { $eq: 'poll_123' } }
```

```json
{ "user_id": { "$eq": "abcd" } }
```

```json
{ "created_at": { "$gte": "2023-12-04T09:30:20.45Z" } }
```

```json
{ updated_at: { $gte: '2023-12-04T09:30:20.45Z' } }
```

```json
{ "is_answer": { "$eq": true } }
```

```json
{ "option_id": { "$in": ["abcd", "defg"] } }
```

--------------------------------

### Querying activities with pagination

Source: https://getstream.io/activity-feeds/docs/ruby/query-activities.md

Demonstrates how to perform an initial query and use the next cursor to fetch the subsequent page of results.

```ruby
require 'getstream_ruby'

client = GetStreamRuby.manual(
  api_key: 'api_key',
  api_secret: 'api_secret'
)

# First page query
first_page = client.feeds.query_activities(
  GetStream::Generated::Models::QueryActivitiesRequest.new(
    limit: 10,
    filter: { activity_type: 'post' },
    sort: [{ field: 'created_at', direction: -1 }]
  )
)

# Second page using next cursor from first page
if first_page.next
  second_page = client.feeds.query_activities(
    GetStream::Generated::Models::QueryActivitiesRequest.new(
      limit: 10,
      filter: { activity_type: 'post' },
      sort: [{ field: 'created_at', direction: -1 }],
      next: first_page.next
    )
  )
end
```

--------------------------------

### Create a collection using client.createCollections

Source: https://getstream.io/activity-feeds/docs/javascript/collections.md

This example demonstrates how to create a new collection with custom data fields like title, genre, and rating.

```js
const response = await client.createCollections({
  collections: [
    {
      name: "movies",
      id: "lord_of_the_rings",
      custom: {
        title: "Lord of the Rings",
        genre: "fantasy",
        rating: 9,
      },
    },
  ],
});
```

--------------------------------

### Perform partial activity updates with set and unset

Source: https://getstream.io/activity-feeds/docs/php/activities.md

Demonstrates using updateActivityPartial to modify specific fields. The first example updates the text field, while the second example removes a custom color field using dotted-notation.

```php
// Partially set some fields
$response = $feedsClient->updateActivityPartial(
    '123',
    new GeneratedModels\UpdateActivityPartialRequest(
        userID: '<user id>',
        set: [
            'text' => 'Japan has over 6,800 islands.',
        ]
    )
);
echo 'Activity edited at: ' . $response->getActivity()->getEditedAt();

// Partially unset some fields
$response = $feedsClient->updateActivityPartial(
    '123',
    new GeneratedModels\UpdateActivityPartialRequest(
        userID: '<user id>',
        unset: ['custom.color']
    )
);
echo 'Activity edited at: ' . $response->getActivity()->getEditedAt();
```

--------------------------------

### Initialize and Add Activity with Python

Source: https://getstream.io/activity-feeds/docs/python.md

Initializes the Stream client with API credentials and adds an activity to a user feed.

```python
from getstream import Stream

client = Stream(api_key="<API key>", api_secret="<API secret>")

# Create a feed (or get its data if exists)
feed = client.feeds.feed("user", "john")
feed.get_or_create(user_id="john")

# Add activity
response = client.feeds.add_activity(
    type="post",
    feeds=[feed.get_feed_identifier()],
    text="Hello, Stream Feeds!",
    user_id="john"
)
```

--------------------------------

### Get Blocked Users

Source: https://getstream.io/activity-feeds/docs/python/moderation.md

Retrieve a list of users you have blocked.

```APIDOC
## Get Blocked Users

### Description
Retrieve a list of users you have blocked.

### Parameters
- **user_id** (string) - The ID of the user whose blocked list to retrieve
```

--------------------------------

### Manage Follow Requests with Go SDK

Source: https://getstream.io/activity-feeds/docs/go-golang/follows.md

Demonstrates creating a follow request, accepting it with a custom follower role, and rejecting a request. Note that setting the follower role is a server-side operation.

```go
ctx := context.Background()

saraFeed := client.Feeds().Feed("user", "sara")
_, err = saraFeed.GetOrCreate(ctx, &getstream.GetOrCreateFeedRequest{
  Data: &getstream.FeedInput{
    Visibility: getstream.PtrTo("followers"),
  },
  UserID: getstream.PtrTo("sara"),
})
if err != nil {
  log.Fatal("Error creating sara feed:", err)
}

adamTimeline := client.Feeds().Feed("timeline", "adam")
_, err = adamTimeline.GetOrCreate(ctx, &getstream.GetOrCreateFeedRequest{
  UserID: getstream.PtrTo("adam"),
})
if err != nil {
  log.Fatal("Error creating adam timeline feed:", err)
}

// Create follow request from adamTimeline to saraFeed
followRequest, err := client.Feeds().Follow(ctx, &getstream.FollowRequest{
  Source: "timeline:adam",
  Target: "user:sara",
})
if err != nil {
  log.Fatal("Error creating follow request:", err)
}
fmt.Printf("Follow request status: %s\n", followRequest.Data.Follow.Status)

// Accept follow request and set follower's role
_, err = client.Feeds().AcceptFollow(ctx, &getstream.AcceptFollowRequest{
  Source:       "timeline:adam",
  Target:       "user:sara",
  FollowerRole: getstream.PtrTo("feed_member_viewer"),
})
if err != nil {
  log.Fatal("Error accepting follow request:", err)
}

// Reject follow request
_, err = client.Feeds().RejectFollow(ctx, &getstream.RejectFollowRequest{
  Source: "timeline:adam",
  Target: "user:sara",
})
if err != nil {
  log.Fatal("Error rejecting follow request:", err)
}
```

--------------------------------

### Create a collection in PHP

Source: https://getstream.io/activity-feeds/docs/php/collections.md

Demonstrates how to instantiate a CollectionRequest and use the feedsClient to create a new collection.

```php
$collection = new GeneratedModels\CollectionRequest(
    name: 'movies',
    id: 'lord_of_the_rings',
    custom: (object)[
        'title' => 'Lord of the Rings',
        'genre' => 'fantasy',
        'rating' => 9,
    ]
);

$response = $feedsClient->createCollections(
    new GeneratedModels\CreateCollectionsRequest(collections: [$collection])
);
```

--------------------------------

### Get Moderation Configuration

Source: https://getstream.io/activity-feeds/docs/dotnet-csharp/moderation.md

Retrieve a specific moderation configuration.

```APIDOC
## Get Moderation Configuration

### Description
Retrieve a specific moderation configuration.

### Parameters
- **key** (string) - Required - The configuration key to retrieve
- **team** (string) - Optional - The team identifier
```

--------------------------------

### Get Moderation Configuration

Source: https://getstream.io/activity-feeds/docs/php/moderation.md

Retrieve a specific moderation configuration by its key.

```php
$response = $moderationClient->getConfig("feeds", "");
```

--------------------------------

### Initialize and Add Activity with Ruby

Source: https://getstream.io/activity-feeds/docs/ruby.md

Initializes the Ruby client with API credentials and adds an activity to a user feed.

```ruby
require 'getstream_ruby'

# Initialize the client
client = GetStreamRuby.manual(
  api_key: 'your_api_key',
  api_secret: 'your_api_secret'
)

# Create a feed (or get its data if exists)
feed_response = client.feeds.get_or_create_feed(
  'user',
  'john',
  GetStream::Generated::Models::GetOrCreateFeedRequest.new(user_id: 'john')
)

# Add activity
activity_request = GetStream::Generated::Models::AddActivityRequest.new(
  type: 'post',
  text: 'Hello, Stream Feeds!',
  user_id: 'john',
  feeds: ['user:john']
)

response = client.feeds.add_activity(activity_request)
```

--------------------------------

### Get Moderation Configuration

Source: https://getstream.io/activity-feeds/docs/node/moderation.md

Retrieve a specific moderation configuration by its key.

```js
client.moderation.getConfig({
  key: "feeds",
});
```

```js
client.moderation.getConfig({
  key: "feeds",
});
```
Tokens:
Raw