Vizel API / vue/src / UseVizelCollaborationResult

Interface: UseVizelCollaborationResult

Defined in: packages/vue/src/composables/useVizelCollaboration.ts:14

Collaboration composable result

Properties

connect

connect: () => void;

Defined in: packages/vue/src/composables/useVizelCollaboration.ts:24

Connect to the collaboration server

Returns

void

---

disconnect

disconnect: () => void;

Defined in: packages/vue/src/composables/useVizelCollaboration.ts:26

Disconnect from the collaboration server

Returns

void

---

error

error: ComputedRef<Error | null>;

Defined in: packages/vue/src/composables/useVizelCollaboration.ts:22

Last error that occurred

---

isConnected

isConnected: ComputedRef<boolean>;

Defined in: packages/vue/src/composables/useVizelCollaboration.ts:16

Whether connected to the collaboration server

---

isSynced

isSynced: ComputedRef<boolean>;

Defined in: packages/vue/src/composables/useVizelCollaboration.ts:18

Whether the initial document sync is complete

---

peerCount

peerCount: ComputedRef<number>;

Defined in: packages/vue/src/composables/useVizelCollaboration.ts:20

Number of currently connected peers (including self)

---

updateUser

updateUser: (user) => void;

Defined in: packages/vue/src/composables/useVizelCollaboration.ts:28

Update the current user's cursor information

Parameters

Parameter	Type
user	VizelCollaborationUser

Returns

void