Activity Feeds v3 is in beta — try it out!

Activities

Creating Activities

The example below shows how to create an activity and add it to a feed.

// Add an activity to 1 feed
val activity: Result<ActivityData> = feed.addActivity(
    request = FeedAddActivityRequest(
        text = "hello world",
        type = "post"
    )
)

// Add an activity to multiple feeds
val multiFeedActivity: Result<ActivityData> = client.addActivity(
    request = AddActivityRequest(
        fids = listOf("user:1", "stock:apple"),
        text = "apple stock will go up",
        type = "post"
    )
)

The above example was quite simple. Here are a few more examples:

Image & Video

val imageActivity: Result<ActivityData> = feed.addActivity(
    request = FeedAddActivityRequest(
        attachments = listOf(
            Attachment(
                imageUrl = "https://example.com/image.jpg",
                type = "image"
            )
        ),
        text = "look at NYC",
        type = "post"
    )
)

Sharing activities

When creating an activity it’s possible to set parent_id, setting this field will increase the share_count of the parent activity. This feature lets you implement “retweets”.

When reading an activity with parent id set, you can access the parent activity with activity.parent.

val activity: Result<ActivityData> = feed.addActivity(
    request = FeedAddActivityRequest(
        text = "Couldn't agree more",
        type = "post",
        parentId = "<activity to share>"
    )
)

Overview of All Activity Fields

Here’s an overview of all the fields you can add when creating an activity:

FieldDescription
idEither set your own id, or let our server generate it. Setting your own ID can be convenient if your activity maps 1 to 1 to something in your database.
typeThe type of activity. Defaults to “post” if not provided.
feedsThe list of feeds (format: “group id:feed id”) to add this activity to
textThe text for this activity
attachmentsA list of attachments. Video, images, location, etc. Also supports custom attachments
customAny custom data you want to add
visibilityVisibility levels for the activity
locationSpecify an activity location. This allows for feeds to show content close to you. Format: ActivityLocation(lat: 40.014984, lng: -105.270546)
expiresAtWhen the activity expires. After this timestamp it’s only visible to the person who created this activity (or server side API calls)
mentionedUserIdsA list of users mentioned in this activity
parentIdThe parent activity. Used for replies/reshares etc
searchDataAny extra data you want to search on for this activity
filterTagsArray of strings that you can filter on when querying the feed
interestTagsEither set the interest tags manually or enable an activity processor to have AI determine the topics for this activity. Used for “for you” style feeds

Adding Many Activities

You can also batch add activities. Here’s an example:

val activities = listOf(
    ActivityRequest(
        feeds = listOf("user:123"),
        id = "1",
        text = "hi",
        type = "post"
    ),
    ActivityRequest(
        feeds = listOf("user:456"),
        id = "2",
        text = "hi",
        type = "post"
    )
)
val upsertedActivities: Result<List<ActivityData>> = client.upsertActivities(activities)

Updating & Deleting Activities

This example shows how to update or delete an activity:

// Update an activity
val updatedActivity: Result<ActivityData> = feed.updateActivity(
    id = "123",
    request = UpdateActivityRequest(
        custom = mapOf("custom" to "custom"),
        text = "Updated text"
    )
)

// Delete an activity
val hardDelete = false // Soft delete sets deleted at but retains the data, hard delete fully removes it
feed.deleteActivity(id = "123", hardDelete = hardDelete)

// Batch delete activities
client.deleteActivities(
    request = DeleteActivitiesRequest(
        ids = listOf("123", "456"),
        hardDelete = false
    )
)

Partial activity updates

A partial update can be used to set and unset specific fields when it is necessary to retain additional custom data fields on the object. AKA a patch style update. Both set and unset can be used in the same request. The dotted-notation is also available for both set and unset for the custom field.

// Partially set some fields
val updatedActivity: Result<ActivityData> = feed.updateActivityPartial(
    id = "123",
    request = UpdateActivityPartialRequest(
        set = mapOf(
            "text" to "Japan has over 6,800 islands.",
            "custom" to mapOf(
                "topic" to "fun facts",
                "color" to "blue",
            ),
        )
    )
)

// Partially unset some fields
val updatedActivity: Result<ActivityData> = feed.updateActivityPartial(
    id = "123",
    request = UpdateActivityPartialRequest(
        unset = listOf("custom.color")
    )
)
© Getstream.io, Inc. All Rights Reserved.