GuidesAPI ReferenceRelease Notes
HomeLog InHome
Guides

Represents an entity that can be followed.


  • entityId - The unique identifier of the followable entity.
  • providerName - Optional. The name of the data provider that sourced this entity (e.g. "stats-perform"), forwarded to User Activity when the follow/unfollow signal is persisted and synced. Not validated by the SDK.
  • entityType - Optional. The category of the entity, as a BlazeFollowedEntityCategory. Forwarded to User Activity alongside providerName.
data class BlazeFollowEntity(
    val entityId: String,
    val providerName: String? = null,
    val entityType: BlazeFollowedEntityCategory? = null
)

Note: Identity is entityId-only — providerName and entityType are carried metadata and aren't part of equality or hashing. Content-driven follow taps (from the Moments player) populate them automatically when the source content has them, and they're reported in onFollowEntityClicked and getFollowedEntities(). Host-seeded setFollowedEntities/insertFollowedEntities/removeFollowedEntities calls can supply them explicitly. Passing an entity with a null providerName or entityType keeps any value the SDK already knows for that id.

BlazeSDK.followEntitiesManager.insertFollowedEntities(
    setOf(BlazeFollowEntity(entityId = "team_456", entityType = BlazeFollowedEntityCategory.TEAM))
)

BlazeFollowedEntityCategory

The category of a followed entity. Use it to tell the SDK what kind of entity a BlazeFollowEntity is, and to restrict the followed entities data source to some categories.

enum class BlazeFollowedEntityCategory {
    TEAM,
    PLAYER,
    PROPERTY // e.g. a competition or a league
}

Note: BlazeFollowedEntityCategory describes what an entity is. BlazeFollowEntityType is a style setting that picks which entity the follow button displays, with fallbacks.


Did this page help you?