Type Alias: LivelinkConnectParameters
type LivelinkConnectParameters = {
token: string;
LoadingPanel?: React.ComponentType<{
stage: string;
}>;
InactivityWarningPanel?: React.ComponentType<{
warningDuration: number;
onActivityDetected: () => void;
}>;
ConnectionErrorPanel?: React.ComponentType<{
error: string;
}>;
} &
| {
sessionId: UUID;
} & Partial<Record<keyof SessionJoinOrStart | "clientType", never>>
| {
sceneId: UUID;
autoJoinExisting?: boolean;
isTransient?: boolean;
} & Partial<Record<"sessionId" | "clientType", never>>
| {
clientType: "guest";
} & Partial<Record<"sessionId" | keyof SessionJoinOrStart, never>>;
Defined in: livelink.react/sources/components/core/Livelink.tsx:103
Parameters for establishing a Livelink connection.
Extends SessionOpenMode
to define the session behavior and includes additional
options for handling connection lifecycle events, UI components, and settings.
Type declaration
Name | Type | Description |
---|---|---|
token | string | Authentication token required to establish the connection. |
LoadingPanel? | React.ComponentType <{ stage : string ; }> | Optional React component or node displayed while the connection is loading. |
InactivityWarningPanel? | React.ComponentType <{ warningDuration : number ; onActivityDetected : () => void ; }> | Optional React component or node displayed when an inactivity timeout occurs. |
ConnectionErrorPanel? | React.ComponentType <{ error : string ; }> | Optional React component or node displayed when the connection is disconnected. |