Class ApiActivityFeedChannel

Phoenix channel for real-time activity feed updates. Clients join a topic scoped to an agent or org and receive new_entry events as feed entries are created.

Topics

"api:activity_feed:agent:{agent_user_id}" — entries for a specific agent
"api:activity_feed:org:{org_id}" — entries for an entire org/tenant

Index

Constructors

Properties

Methods

leave listEntries onNewEntry joinAgent joinOrg topicAgent topicOrg

Constructors

constructor

new ApiActivityFeedChannel(
channel: Channel,
joinResponse?: unknown,
): ApiActivityFeedChannel
Parameters
- channel: Channel
- OptionaljoinResponse: unknown
Returns ApiActivityFeedChannel
- Defined in packages/sdk/src/channels/api_activity_feed_channel.ts:17

Properties

`Optional` `Readonly`joinResponse

joinResponse?: unknown

Methods

leave

leave(): Promise<void>
Leave the underlying channel.

Returns Promise<void>
- Defined in packages/sdk/src/channels/api_activity_feed_channel.ts:46

listEntries

listEntries(payload: Record<string, unknown>): Promise<unknown>
List activity feed entries with cursor-based pagination
Parameters
- payload: Record<string, unknown>
Returns Promise<unknown>
- Defined in packages/sdk/src/channels/api_activity_feed_channel.ts:51

onNewEntry

onNewEntry(callback: (payload: unknown) => void): () => void
Parameters
- callback: (payload: unknown) => void
Returns () => void
- Defined in packages/sdk/src/channels/api_activity_feed_channel.ts:55

`Static`joinAgent

joinAgent(socket: Socket, agentId: string): Promise<ApiActivityFeedChannel>
Join an agent-scoped activity feed
Parameters
- socket: Socket
- agentId: string
Returns Promise<ApiActivityFeedChannel>
- Defined in packages/sdk/src/channels/api_activity_feed_channel.ts:25

`Static`joinOrg

joinOrg(socket: Socket, orgId: string): Promise<ApiActivityFeedChannel>
Join an org-scoped activity feed
Parameters
- socket: Socket
- orgId: string
Returns Promise<ApiActivityFeedChannel>
- Defined in packages/sdk/src/channels/api_activity_feed_channel.ts:38

`Static`topicAgent

topicAgent(agentId: string): string
Join an agent-scoped activity feed
Parameters
- agentId: string
Returns string
- Defined in packages/sdk/src/channels/api_activity_feed_channel.ts:20

`Static`topicOrg

topicOrg(orgId: string): string
Join an org-scoped activity feed
Parameters
- orgId: string
Returns string
- Defined in packages/sdk/src/channels/api_activity_feed_channel.ts:33