nextspace
    Preparing search index...

    Interface UseConversationSetupReturn

    interface UseConversationSetupReturn {
        agentActive: boolean;
        agentId: string | null;
        agentIds: string[];
        assistantIntroRef: MutableRefObject<PseudonymousMessage[]>;
        botName: string;
        chatIntroRef: MutableRefObject<PseudonymousMessage[]>;
        chatPasscode: string;
        conversationFeatures: { enabled?: boolean; name: string }[];
        eventDescription: string;
        eventName: string;
        eventScheduledTime: string | null;
        eventStatus: "active" | "future" | "ended";
        eventStatusLoaded: boolean;
        feedbackFrequency: number;
        generalError: string | null;
        groupChatChannelName: "chat" | "pregame";
        hasJoinedConvRef: MutableRefObject<boolean>;
        initialJoinComplete: boolean;
        markEventEnded: () => void;
        markEventStarted: () => void;
        moderators: { bio: string; name: string }[];
        paramsError: { header: string; params: string[] } | null;
        setGeneralError: Dispatch<SetStateAction<string | null>>;
        setInitialJoinComplete: Dispatch<SetStateAction<boolean>>;
        setShowEventStatusDialog: Dispatch<SetStateAction<boolean>>;
        showEventStatusDialog: boolean;
        speakers: { bio: string; name: string }[];
        transcriptPasscode: string;
    }
    Index

    Properties

    agentActive agentId agentIds assistantIntroRef botName chatIntroRef chatPasscode conversationFeatures eventDescription eventName eventScheduledTime eventStatus eventStatusLoaded feedbackFrequency generalError groupChatChannelName hasJoinedConvRef initialJoinComplete markEventEnded markEventStarted moderators paramsError setGeneralError setInitialJoinComplete setShowEventStatusDialog showEventStatusDialog speakers transcriptPasscode

    Properties

    agentActive: boolean
    agentId: string | null
    agentIds: string[]
    assistantIntroRef: MutableRefObject<PseudonymousMessage[]>
    botName: string
    chatIntroRef: MutableRefObject<PseudonymousMessage[]>
    chatPasscode: string
    conversationFeatures: { enabled?: boolean; name: string }[]
    eventDescription: string
    eventName: string
    eventScheduledTime: string | null

    The event's scheduled start time, for driving a pre-event countdown. Null until loaded.

    eventStatus: "active" | "future" | "ended"
    eventStatusLoaded: boolean
    feedbackFrequency: number
    generalError: string | null
    groupChatChannelName: "chat" | "pregame"

    Which channel group chat actually uses on the wire: 'pregame' inside the pre-event window (if that channel's passcode is in the URL), 'chat' otherwise. chatPasscode is whichever passcode goes with it, so callers don't need to branch between two passcodes themselves.

    hasJoinedConvRef: MutableRefObject<boolean>
    initialJoinComplete: boolean
    markEventEnded: () => void
    markEventStarted: () => void

    Switches group chat from pregame to chat on the backend's conversation:started event.

    moderators: { bio: string; name: string }[]
    paramsError: { header: string; params: string[] } | null
    setGeneralError: Dispatch<SetStateAction<string | null>>
    setInitialJoinComplete: Dispatch<SetStateAction<boolean>>
    setShowEventStatusDialog: Dispatch<SetStateAction<boolean>>
    showEventStatusDialog: boolean
    speakers: { bio: string; name: string }[]
    transcriptPasscode: string

    Settings

    Member Visibility

    On This Page

    Properties