Class ApiObjectChannel

Channel for real-time custom object collaboration. Clients join api:object:{object_id} to receive the current object state and subscribe to field-level updates. Mutations are sent as key:value maps.

Index

Constructors

Properties

Methods

leave onAccessRevoked onObjectCreated onObjectDeleted onObjectUpdated onPresenceLeft onPresenceUpdated presenceUpdate save updateFields joinById joinByRowKey topicById topicByRowKey

Constructors

constructor

new ApiObjectChannel(channel: Channel, joinResponse?: unknown): ApiObjectChannel
Parameters
- channel: Channel
- OptionaljoinResponse: unknown
Returns ApiObjectChannel
- Defined in packages/sdk/src/channels/api_object_channel.ts:14

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_object_channel.ts:39

onAccessRevoked

onAccessRevoked(callback: (payload: unknown) => void): () => void
Parameters
- callback: (payload: unknown) => void
Returns () => void
- Defined in packages/sdk/src/channels/api_object_channel.ts:75

onObjectCreated

onObjectCreated(callback: (payload: unknown) => void): () => void
Parameters
- callback: (payload: unknown) => void
Returns () => void
- Defined in packages/sdk/src/channels/api_object_channel.ts:59

onObjectDeleted

onObjectDeleted(callback: (payload: unknown) => void): () => void
Parameters
- callback: (payload: unknown) => void
Returns () => void
- Defined in packages/sdk/src/channels/api_object_channel.ts:63

onObjectUpdated

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

onPresenceLeft

onPresenceLeft(callback: (payload: unknown) => void): () => void
Parameters
- callback: (payload: unknown) => void
Returns () => void
- Defined in packages/sdk/src/channels/api_object_channel.ts:71

onPresenceUpdated

onPresenceUpdated(callback: (payload: unknown) => void): () => void
Parameters
- callback: (payload: unknown) => void
Returns () => void
- Defined in packages/sdk/src/channels/api_object_channel.ts:67

presenceUpdate

presenceUpdate(payload: Record<string, unknown>): Promise<unknown>
Parameters
- payload: Record<string, unknown>
Returns Promise<unknown>
- Defined in packages/sdk/src/channels/api_object_channel.ts:51

save

save(payload: Record<string, unknown>): Promise<unknown>
Parameters
- payload: Record<string, unknown>
Returns Promise<unknown>
- Defined in packages/sdk/src/channels/api_object_channel.ts:47

updateFields

updateFields(payload: Record<string, unknown>): Promise<unknown>
Parameters
- payload: Record<string, unknown>
Returns Promise<unknown>
- Defined in packages/sdk/src/channels/api_object_channel.ts:43

`Static`joinById

joinById(
    socket: Socket,
    objectId: string,
    payload?: { connection_id?: string; partial_updates?: boolean },
): Promise<ApiObjectChannel>
Parameters
- socket: Socket
- objectId: string
- Optionalpayload: { connection_id?: string; partial_updates?: boolean }
Returns Promise<ApiObjectChannel>
- Defined in packages/sdk/src/channels/api_object_channel.ts:20

`Static`joinByRowKey

joinByRowKey(
    socket: Socket,
    schemaType: string,
    rowKey: string,
    payload?: { connection_id?: string; partial_updates?: boolean },
): Promise<ApiObjectChannel>
Parameters
- socket: Socket
- schemaType: string
- rowKey: string
- Optionalpayload: { connection_id?: string; partial_updates?: boolean }
Returns Promise<ApiObjectChannel>
- Defined in packages/sdk/src/channels/api_object_channel.ts:31

`Static`topicById

topicById(objectId: string): string
Parameters
- objectId: string
Returns string
- Defined in packages/sdk/src/channels/api_object_channel.ts:16

`Static`topicByRowKey

topicByRowKey(schemaType: string, rowKey: string): string
Parameters
- schemaType: string
- rowKey: string
Returns string
- Defined in packages/sdk/src/channels/api_object_channel.ts:27