Interface VisitorInterface

Hierarchy

Implemented by

Properties

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

Methods

fetchDataObject fetchVisitor fireToast incrementDataObjectValue moveVisitor openIframe setDataObject updateDataObject

Properties

Optional color

color?: string

Optional credentials

credentials?: InteractiveCredentials

Optional dataObject

dataObject?: null | object

Optional displayName

displayName?: string

Optional gestureType

gestureType?: number

Optional hidden

hidden?: boolean

Optional id

id?: number

Optional isAdmin

isAdmin?: boolean

Optional isBackground

isBackground?: boolean

Optional isMobile

isMobile?: boolean

Optional isRecording

isRecording?: boolean

Optional isRecordingBot

isRecordingBot?: boolean

Optional jwt

jwt?: string

Optional lastUpdate

lastUpdate?: number

Optional moveFrom

moveFrom?: object

Optional moveTo

moveTo?: {
    x?: number;
    y?: number;
}

Type declaration

  • Optional x?: number
  • Optional y?: number

Optional movedOn

movedOn?: number

Optional muted

muted?: boolean

Optional performer

performer?: boolean

Optional performerNear

performerNear?: boolean

requestOptions

requestOptions: object

Optional shareScreen

shareScreen?: boolean

Optional sitting

sitting?: boolean

topia

topia: Topia

urlSlug

urlSlug: string

Optional username

username?: string

Methods

fetchDataObject

  • Returns Promise<void | ResponseType>

fetchVisitor

  • Returns Promise<void | ResponseType>

fireToast

incrementDataObjectValue

  • Parameters

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

    Returns Promise<void | ResponseType>

moveVisitor

openIframe

setDataObject

  • Parameters

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

    Returns Promise<void | ResponseType>

updateDataObject

  • Parameters

    • dataObject: object
    • options: object

    Returns Promise<void | ResponseType>

Settings

Member Visibility

Theme