Function: LivelinkProvider()

function LivelinkProvider(
    params: PropsWithChildren<
        | ({
              token: string;
              LoadingPanel?: ComponentType<{
                  stage: string;
              }>;
              InactivityWarningPanel?: ComponentType<{
                  warningDuration: number;
                  onActivityDetected: () => void;
              }>;
              ConnectionErrorPanel?: ComponentType<{
                  error: string;
              }>;
          } & {
              sessionId: UUID;
          } & Partial<Record<keyof SessionJoinOrStart | "clientType", never>>)
        | ({
              token: string;
              LoadingPanel?: ComponentType<{
                  stage: string;
              }>;
              InactivityWarningPanel?: ComponentType<{
                  warningDuration: number;
                  onActivityDetected: () => void;
              }>;
              ConnectionErrorPanel?: ComponentType<{
                  error: string;
              }>;
          } & {
              sceneId: UUID;
              autoJoinExisting?: boolean;
              isTransient?: boolean;
          } & Partial<Record<"sessionId" | "clientType", never>>)
        | ({
              token: string;
              LoadingPanel?: ComponentType<{
                  stage: string;
              }>;
              InactivityWarningPanel?: ComponentType<{
                  warningDuration: number;
                  onActivityDetected: () => void;
              }>;
              ConnectionErrorPanel?: ComponentType<{
                  error: string;
              }>;
          } & {
              clientType: "guest";
          } & Partial<Record<"sessionId" | keyof SessionJoinOrStart, never>>)
    >,
): Element;

Defined in: livelink.react/sources/components/core/Livelink.tsx:156

Provides the Livelink context and manages the lifecycle of a Livelink connection.

This component initializes and maintains a connection to the Livelink service and supplies relevant connection state and methods to its children via context.

Parameters

Parameter	Type	Description
params	PropsWithChildren< | { token: string; LoadingPanel?: ComponentType<{ stage: string; }>; InactivityWarningPanel?: ComponentType<{ warningDuration: number; onActivityDetected: () => void; }>; ConnectionErrorPanel?: ComponentType<{ error: string; }>; } & { sessionId: UUID; } & Partial<Record<keyof SessionJoinOrStart | "clientType", never>> | { token: string; LoadingPanel?: ComponentType<{ stage: string; }>; InactivityWarningPanel?: ComponentType<{ warningDuration: number; onActivityDetected: () => void; }>; ConnectionErrorPanel?: ComponentType<{ error: string; }>; } & { sceneId: UUID; autoJoinExisting?: boolean; isTransient?: boolean; } & Partial<Record<"sessionId" | "clientType", never>> | { token: string; LoadingPanel?: ComponentType<{ stage: string; }>; InactivityWarningPanel?: ComponentType<{ warningDuration: number; onActivityDetected: () => void; }>; ConnectionErrorPanel?: ComponentType<{ error: string; }>; } & { clientType: "guest"; } & Partial<Record<"sessionId" | keyof SessionJoinOrStart, never>>>

Returns

Element