Interface CustomObjectSubscription<TFields>

interface CustomObjectSubscription<TFields extends object> {
    state: CustomObjectConnectionState;
    close(): void;
    save(): Promise<void>;
    update(fields: DeepPartial<TFields>): Promise<void>;
    updatePresence(presence: CustomObjectPresenceUpdate): Promise<void>;
}

Type Parameters

TFields extends object

Index

Properties

Methods

close save update updatePresence

Properties

`Readonly`state

state: CustomObjectConnectionState

Methods

close

close(): void
Returns void
- Defined in packages/sdk/src/custom-object-subscriptions.ts:97

save

save(): Promise<void>
Returns Promise<void>
- Defined in packages/sdk/src/custom-object-subscriptions.ts:96

update

update(fields: DeepPartial<TFields>): Promise<void>
Parameters
- fields: DeepPartial<TFields>
Returns Promise<void>
- Defined in packages/sdk/src/custom-object-subscriptions.ts:94

updatePresence

updatePresence(presence: CustomObjectPresenceUpdate): Promise<void>
Parameters
- presence: CustomObjectPresenceUpdate
Returns Promise<void>
- Defined in packages/sdk/src/custom-object-subscriptions.ts:95