Interface: InjectPresenceResult\<TPresence\>
@roomful/angular / InjectPresenceResult
Interface: InjectPresenceResult<TPresence>
Section titled “Interface: InjectPresenceResult<TPresence>”Defined in: angular/src/index.ts:114
Describes the return value of injectPresence.
Type Parameters
Section titled “Type Parameters”TPresence
Section titled “TPresence”TPresence extends PresenceData = PresenceData
The room presence shape.
Properties
Section titled “Properties”all:
Signal<Peer<TPresence>[]>
Defined in: angular/src/index.ts:128
Exposes local and remote peers.
others
Section titled “others”others:
Signal<Peer<TPresence>[]>
Defined in: angular/src/index.ts:123
Exposes remote peers only.
replace()
Section titled “replace()”replace: (
this,data) =>void
Defined in: angular/src/index.ts:138
Replaces the local presence payload.
Replaces the local presence payload. Overwrites the existing value.
Parameters
Section titled “Parameters”void
Partial<TPresence>
The partial presence payload to publish for the local peer.
Returns
Section titled “Returns”void
Nothing.
self:
Signal<Peer<TPresence>>
Defined in: angular/src/index.ts:118
Exposes the local peer snapshot.
update()
Section titled “update()”update: (
this,data) =>void
Defined in: angular/src/index.ts:133
Partially updates the local presence payload.
Partially updates the local presence payload. Merges into the existing value.
Parameters
Section titled “Parameters”void
Partial<TPresence>
The partial presence payload to merge into the local peer.
Returns
Section titled “Returns”void
Nothing.