RTSDK
    Preparing search index...

    Interface VisitorInterface

    interface VisitorInterface {
        color?: string;
        credentials?: InteractiveCredentials;
        dataObject?: null | object;
        displayName?: string;
        gestureType?: number;
        hidden?: boolean;
        id?: number;
        isAdmin?: boolean;
        isBackground?: boolean;
        isMobile?: boolean;
        isRecording?: boolean;
        isRecordingBot?: boolean;
        jwt?: string;
        lastUpdate?: number;
        movedOn?: number;
        moveFrom?: object;
        moveTo?: { x?: number; y?: number };
        muted?: boolean;
        performer?: boolean;
        performerNear?: boolean;
        requestOptions: object;
        shareScreen?: boolean;
        sitting?: boolean;
        topia: Topia;
        urlSlug: string;
        username?: string;
        fetchDataObject(
            appPublicKey?: string,
            appJWT?: string,
            sharedAppPublicKey?: string,
            sharedAppJWT?: string,
        ): Promise<void | ResponseType>;
        fetchVisitor(): Promise<void | ResponseType>;
        fireToast(
            __namedParameters: FireToastInterface,
        ): Promise<void | ResponseType>;
        incrementDataObjectValue(
            path: string,
            amount: number,
            options: object,
        ): Promise<void | ResponseType>;
        moveVisitor(
            __namedParameters: MoveVisitorInterface,
        ): Promise<void | ResponseType>;
        openIframe(
            __namedParameters: OpenIframeInterface,
        ): Promise<void | ResponseType>;
        setDataObject(
            dataObject: undefined | null | object,
            options: object,
        ): Promise<void | ResponseType>;
        updateDataObject(
            dataObject: object,
            options: object,
        ): Promise<void | ResponseType>;
    }

    Hierarchy (View Summary)

    Implemented by

    Index

    Properties

    color? credentials? dataObject? displayName? gestureType? hidden? id? isAdmin? isBackground? isMobile? isRecording? isRecordingBot? jwt? lastUpdate? movedOn? moveFrom? moveTo? muted? performer? performerNear? requestOptions shareScreen? sitting? topia urlSlug username?

    Methods

    fetchDataObject fetchVisitor fireToast incrementDataObjectValue moveVisitor openIframe setDataObject updateDataObject

    Properties

    color?: string
    credentials?: InteractiveCredentials
    dataObject?: null | object
    displayName?: string
    gestureType?: number
    hidden?: boolean
    id?: number
    isAdmin?: boolean
    isBackground?: boolean
    isMobile?: boolean
    isRecording?: boolean
    isRecordingBot?: boolean
    jwt?: string
    lastUpdate?: number
    movedOn?: number
    moveFrom?: object
    moveTo?: { x?: number; y?: number }
    muted?: boolean
    performer?: boolean
    performerNear?: boolean
    requestOptions: object
    shareScreen?: boolean
    sitting?: boolean
    topia: Topia
    urlSlug: string
    username?: string

    Methods

    • Parameters

      • OptionalappPublicKey: string
      • OptionalappJWT: string
      • OptionalsharedAppPublicKey: string
      • OptionalsharedAppJWT: string

      Returns Promise<void | ResponseType>

    • Returns Promise<void | ResponseType>

    • Parameters

      • path: string
      • amount: number
      • options: object

      Returns Promise<void | ResponseType>

    • Parameters

      • dataObject: undefined | null | object
      • options: object

      Returns Promise<void | ResponseType>

    • Parameters

      • dataObject: object
      • options: object

      Returns Promise<void | ResponseType>

    Settings

    Member Visibility

    On This Page

    Properties
    Methods