// 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"]
)
Activity Feeds V3 is in closed alpha — do not use it in production (just yet).
Follows
Follow & Unfollow
// Follow a user
val timeline = client.feed(group = "timeline", id = "john")
timeline.follow(FeedId(group = "user", id = "tom"))
// Follow a stock
timeline.follow(FeedId(group = "stock", id = "apple"))
// Follow with more fields
timeline.follow(
targetFid = FeedId(group = "stock", id = "apple"),
custom = mapOf("reason" to "investment")
)
const timeline = client.feed("timeline", "john");
await timeline.getOrCreate();
// Follow a user
await timeline.follow("user:tom");
// Follow a stock
await timeline.follow("stock:apple");
// Follow with more fields
await timeline.follow("stock:apple", {
push_preference: "all",
custom: {
reason: "investment",
},
});
const timeline = client.feeds.feed("timeline", "john");
await timeline.getOrCreate({
user_id: "john",
});
// Follow a user
await client.feeds.follow({
source: timeline.feed,
target: "user:tom",
});
// Follow a stock
await client.feeds.follow({
source: timeline.feed,
target: "stock:apple",
});
// Follow with more fields
await client.feeds.follow({
source: timeline.feed,
target: "stock:apple",
push_preference: "all",
custom: {
reason: "investment",
},
});
response, err := feedsClient.Unfollow(ctx, source, target, &getstream.UnfollowRequest{})
UnfollowRequest unfollowRequest = UnfollowRequest.builder().build();
UnfollowResponse response =
feeds
.unfollow(USER_FEED_TYPE + testUserId, USER_FEED_TYPE + testUserId2, unfollowRequest)
.execute()
.getData();
$response = $this->feedsV3Client->unfollow(
self::USER_FEED_TYPE . $this->testUserId,
self::USER_FEED_TYPE . $this->testUserId2
);
var response = await _feedsV3Client.UnfollowAsync(
$"user:{_testFeedId}",
$"user:{_testFeedId3}",
new { user_id = _testUserId }
);
response = self.client.feeds.unfollow(
f"{self.USER_FEED_TYPE}:{self.test_user_id}",
f"{self.USER_FEED_TYPE}:{self.test_user_id_2}",
)
Querying Follows
// Do I follow a list of feeds
// My feed is timeline:john
let followQuery = FollowsQuery(
filter: .and([
.equal(.sourceFeed, "timeline:john"),
.in(.targetFeed, ["user:sara", "user:adam"])
])
)
let followList = client.followList(for: followQuery)
let page1 = try await followList.get()
let page2 = try await followList.queryMoreFollows()
let page1And2 = followList.state.follows
// Paginating through followers for a feed
// My feed is timeline:john
let followerQuery = FollowsQuery(
filter: .equal(.targetFeed, "timeline:john")
)
let followerList = client.followList(for: followerQuery)
let followerPage1 = try await followerList.get()
// Do I follow a list of feeds
// My feed is timeline:john
val followQuery = FollowsQuery(
filter = Filters.and(
Filters.equal("source_feed", "timeline:john"),
Filters.`in`("target_feed", listOf("user:sara", "user:adam"))
)
)
val followList = client.followList(query = followQuery)
val page1: Result<List<FollowData>> = followList.get()
val page2: Result<List<FollowData>> = followList.queryMoreFollows()
val page1And2 = followList.state.follows
// Paginating through followers for a feed
// My feed is timeline:john
val followerQuery = FollowsQuery(
filter = Filters.equal("target_feed", "timeline:john")
)
val followerList = client.followList(query = followerQuery)
val followerPage1: Result<List<FollowData>> = followerList.get()
const myTimeline = client.feed("timeline", "john");
await myTimeline.getOrCreate();
// Do I follow a list of feeds
const response = await client.queryFollows({
filter: {
source_feed: myTimeline.feed,
target_feed: { $in: ["user:sara", "user:adam"] },
},
});
console.log(response.follows);
const userFeed = client.feed("user", "john");
await userFeed.getOrCreate();
// Paginating through followers for a feed - won't store followers in state
const firstPage = await userFeed.queryFollowers({
limit: 20,
});
// Next page - won't store followers in state
const secondPage = await userFeed.queryFollowers({
limit: 20,
next: firstPage.next,
});
// or load when reading feed - will store followers in state
await feed.getOrCreate({
followers_pagination: {
limit: 10,
},
});
// and then load next pages (or first if followers are not yet loaded) - will store followers in state
await feed.loadNextPageFollowers({ limit: 10 });
console.log(feed.state.getLatestValue().followers);
// Filter by source - feeds that I follow - won't store followings in state
await myTimeline.queryFollowing({ limit: 10 });
// or load when reading feed - will store followings in state
await feed.getOrCreate({
following_pagination: {
limit: 10,
},
});
// and then load next pages (or first if followings are not yet loaded) - will store followings in state
await feed.loadNextPageFollowing({ limit: 10 });
console.log(feed.state.getLatestValue().following);
const myTimeline = client.feeds.feed("timeline", "john");
await myTimeline.getOrCreate({
user_id: "john",
});
// Do I follow a list of feeds
const response = await client.feeds.queryFollows({
filter: {
source_feed: myTimeline.feed,
target_feed: { $in: ["user:sara", "user:adam"] },
},
});
console.log(response.follows);
const userFeed = client.feeds.feed("user", "john");
await userFeed.getOrCreate({
user_id: "john",
});
// Paginating through followers for a feed
const firstPage = await client.feeds.queryFollows({
filter: { target_feed: userFeed.feed },
limit: 20,
});
// Next page
const secondPage = await client.feeds.queryFollows({
filter: { target_feed: userFeed.feed },
limit: 20,
next: firstPage.next,
});
// Filter by source - feeds that I follow
await client.feeds.queryFollows({
filter: { source_feed: myTimeline.feed },
limit: 20,
});
source := fmt.Sprintf("%s:%s", userFeedType, testUserID)
target := fmt.Sprintf("%s:%s", userFeedType, testUserID2)
response, err := feedsClient.Follow(ctx, &getstream.FollowRequest{
Source: source,
Target: target,
})
FollowRequest followRequest =
FollowRequest.builder()
.source(USER_FEED_TYPE + testUserId)
.target(USER_FEED_TYPE + testUserId2)
.build();
SingleFollowResponse response = feeds.follow(followRequest).execute().getData();
$response = $this->feedsV3Client->follow(
new GeneratedModels\FollowRequest(
source: self::USER_FEED_TYPE . $this->testUserId,
target: self::USER_FEED_TYPE . $this->testUserId2
)
);
var response = await _feedsV3Client.FollowAsync(
new FollowRequest
{
Source = $"user:{_testFeedId}",
Target = $"user:{_testFeedId2}"
}
);
response = self.client.feeds.follow(
source=f"{self.USER_FEED_TYPE}:{self.test_user_id}",
target=f"{self.USER_FEED_TYPE}:{self.test_user_id_2}",
)
Follow Requests
Some apps require the user’s approval for following them.
// Sara needs to configure the feed with visibility = followers for enabling follow requests
let saraFeed = saraClient.feed(
for: .init(
group: "user",
id: "sara",
data: .init(visibility: .followers)
)
)
try await saraFeed.getOrCreate()
// Adam requesting to follow the feed
let adamTimeline = adamClient.feed(group: "timeline", id: "adam")
try await adamTimeline.getOrCreate()
let followRequest = try await adamTimeline.follow(saraFeed.feed) // user:sara
print(followRequest.status) // .pending
// Sara accepting
try await saraFeed.acceptFollow(
adamTimeline.feed, // timeline:adam
role: "feed_member" // optional
)
// or rejecting the request
try await saraFeed.rejectFollow(adamTimeline.feed) // timeline:adam
// Sara needs to configure the feed with visibility = followers for enabling follow requests
val saraFeed = saraClient.feed(
query = FeedQuery(
group = "user",
id = "sara",
data = FeedInputData(visibility = FeedVisibility.Followers)
)
)
saraFeed.getOrCreate()
// Adam requesting to follow the feed
val adamTimeline = adamClient.feed(group = "timeline", id = "adam")
adamTimeline.getOrCreate()
val followRequest = adamTimeline.follow(saraFeed.fid) // user:sara
println(followRequest.getOrNull()?.status) // FollowStatus.PENDING
// Sara accepting
saraFeed.acceptFollow(
sourceFid = adamTimeline.fid, // timeline:adam
role = "feed_member" // optional
)
// or rejecting the request
saraFeed.rejectFollow(adamTimeline.fid) // timeline:adam
const saraFeed = saraClient.feed("user", uuidv4());
await saraFeed.getOrCreate({
// You need to set followers visibility to have follow requests
data: { visibility: "followers" },
});
const adamTimeline = adamClient.feed("timeline", uuidv4());
await adamTimeline.getOrCreate();
const followRequest = await adamTimeline.follow(saraFeed.feed);
console.log(followRequest.follow.status); // pending
await saraClient.acceptFollow({
source: adamTimeline.feed,
target: saraFeed.feed,
// Optionally provide role
follower_role: "feed_member",
});
await saraClient.rejectFollow({
source: adamTimeline.feed,
target: saraFeed.feed,
});
const saraFeed = client.feeds.feed("user", uuidv4());
await saraFeed.getOrCreate({
// You need to set followers visibility to have follow requests
data: { visibility: "followers" },
user_id: 'sara'
});
const adamTimeline = client.feeds.feed("timeline", uuidv4());
await adamTimeline.getOrCreate({
user_id:
});
const followRequest = await client.feeds.follow({
source: adamTimeline.feed,
target: saraFeed.feed,
});
console.log(followRequest.follow.status); // pending
await client.feeds.acceptFollow({
source: adamTimeline.feed,
target: saraFeed.feed,
// Optionally provide role
follower_role: "feed_member",
});
await client.feeds.rejectFollow({
source: adamTimeline.feed,
target: saraFeed.feed,
});
source := fmt.Sprintf("%s:%s", userFeedType, testUserID)
target := fmt.Sprintf("%s:%s", userFeedType, testUserID2)
response, err := feedsClient.Follow(ctx, &getstream.FollowRequest{
Source: source,
Target: target,
})
FollowRequest followRequest =
FollowRequest.builder()
.source(USER_FEED_TYPE + testUserId)
.target(USER_FEED_TYPE + testUserId2)
.build();
SingleFollowResponse response = feeds.follow(followRequest).execute().getData();
$response = $this->feedsV3Client->follow(
new GeneratedModels\FollowRequest(
source: self::USER_FEED_TYPE . $this->testUserId,
target: self::USER_FEED_TYPE . $this->testUserId2
)
);
var response = await _feedsV3Client.FollowAsync(
new FollowRequest
{
Source = $"user:{_testFeedId}",
Target = $"user:{_testFeedId2}"
}
);
response = self.client.feeds.follow(
source=f"{self.USER_FEED_TYPE}:{self.test_user_id}",
target=f"{self.USER_FEED_TYPE}:{self.test_user_id_2}",
)