Interface: UsePresenceResult\<TPresence\>
@roomful/vue / UsePresenceResult
Interface: UsePresenceResult<TPresence>
Section titled “Interface: UsePresenceResult<TPresence>”Defined in: vue/src/index.ts:110
Describes the return value of usePresence.
Type Parameters
Section titled “Type Parameters”TPresence
Section titled “TPresence”TPresence extends PresenceData = PresenceData
The room presence shape.
Properties
Section titled “Properties”all:
ReadonlyRef<Peer<TPresence>[]>
Defined in: vue/src/index.ts:124
Exposes local and remote peers.
others
Section titled “others”others:
ReadonlyRef<Peer<TPresence>[]>
Defined in: vue/src/index.ts:119
Exposes remote peers only.
replace()
Section titled “replace()”replace: (
this,data) =>void
Defined in: vue/src/index.ts:134
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:
ReadonlyRef<Peer<TPresence>>
Defined in: vue/src/index.ts:114
Exposes the local peer snapshot.
update()
Section titled “update()”update: (
this,data) =>void
Defined in: vue/src/index.ts:129
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.