LiveHost
LiveHost =
object
Defined in: react/src/host.tsx:74
Properties
Section titled “Properties”renderShare
Section titled “renderShare”renderShare: ((
args) =>ReactNode) |null
Defined in: react/src/host.tsx:156
Methods
Section titled “Methods”useBrowserFrames()
Section titled “useBrowserFrames()”useBrowserFrames(
args):object
Defined in: react/src/host.tsx:110
Parameters
Section titled “Parameters”disabled?
Section titled “disabled?”boolean
string
Returns
Section titled “Returns”object
frames
Section titled “frames”frames:
BrowserFramesResponse["frames"]
frameUrl
Section titled “frameUrl”frameUrl: (
frameId) =>string
Parameters
Section titled “Parameters”frameId
Section titled “frameId”string
Returns
Section titled “Returns”string
isFramesLoading
Section titled “isFramesLoading”isFramesLoading:
boolean
useComment()
Section titled “useComment()”useComment(
docId): (request) =>Promise<string|null>
Defined in: react/src/host.tsx:99
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”(request) => Promise<string | null>
useConnection()
Section titled “useConnection()”useConnection(
args):object
Defined in: react/src/host.tsx:75
Parameters
Section titled “Parameters”disabled?
Section titled “disabled?”boolean
string | undefined
Returns
Section titled “Returns”object
connection
Section titled “connection”connection:
LiveHostConnection|null
isLiveDocError
Section titled “isLiveDocError”isLiveDocError:
boolean
isLiveDocLoading
Section titled “isLiveDocLoading”isLiveDocLoading:
boolean
useDeleteObject()?
Section titled “useDeleteObject()?”
optionaluseDeleteObject(): ((docName,options?) =>Promise<boolean>) |null
Defined in: react/src/host.tsx:141
Returns
Section titled “Returns”((docName, options?) => Promise<boolean>) | null
useDock()?
Section titled “useDock()?”
optionaluseDock():LiveDockItem[] |null
Defined in: react/src/host.tsx:138
Returns
Section titled “Returns”LiveDockItem[] | null
useDownloadFile()
Section titled “useDownloadFile()”useDownloadFile(
args): (title) =>Promise<void>
Defined in: react/src/host.tsx:106
Parameters
Section titled “Parameters”string
format
Section titled “format”"xlsx" | "pptx"
Returns
Section titled “Returns”(title) => Promise<void>
useFetchBrowserVideo()
Section titled “useFetchBrowserVideo()”useFetchBrowserVideo(
docId): () =>Promise<{token:string;url:string; } |null>
Defined in: react/src/host.tsx:115
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”() => Promise<{ token: string; url: string; } | null>
useFetchMediaToken()
Section titled “useFetchMediaToken()”useFetchMediaToken(
args): () =>Promise<{canPublish:boolean;identity:string;room:string;token:string;url:string; } |null>
Defined in: react/src/host.tsx:118
Parameters
Section titled “Parameters”string
viewer?
Section titled “viewer?”string
Returns
Section titled “Returns”() => Promise<{ canPublish: boolean; identity: string; room: string; token: string; url: string; } | null>
useFetchToken()
Section titled “useFetchToken()”useFetchToken(
docId): () =>Promise<string>
Defined in: react/src/host.tsx:81
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”() => Promise<string>
useFetchTranscribeToken()
Section titled “useFetchTranscribeToken()”useFetchTranscribeToken(): () =>
Promise<{baseUri:string;token:string; } |null>
Defined in: react/src/host.tsx:127
Returns
Section titled “Returns”() => Promise<{ baseUri: string; token: string; } | null>
useFile()?
Section titled “useFile()?”
optionaluseFile(docId):LiveHostFile|null
Defined in: react/src/host.tsx:151
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”LiveHostFile | null
useHistory()
Section titled “useHistory()”useHistory(
args):object
Defined in: react/src/host.tsx:87
Parameters
Section titled “Parameters”disabled?
Section titled “disabled?”boolean
string
Returns
Section titled “Returns”object
history
Section titled “history”history:
HistoryResponse|null
isHistoryError
Section titled “isHistoryError”isHistoryError:
boolean
isHistoryLoading
Section titled “isHistoryLoading”isHistoryLoading:
boolean
mutateHistory
Section titled “mutateHistory”mutateHistory: () =>
Promise<unknown>
Returns
Section titled “Returns”Promise<unknown>
useIsDark()
Section titled “useIsDark()”useIsDark():
boolean
Defined in: react/src/host.tsx:83
Returns
Section titled “Returns”boolean
useLeaveCall()?
Section titled “useLeaveCall()?”
optionaluseLeaveCall(docId): (identity) =>void
Defined in: react/src/host.tsx:135
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”(identity) => void
useLiveDocs()
Section titled “useLiveDocs()”useLiveDocs(
args?):object
Defined in: react/src/host.tsx:84
Parameters
Section titled “Parameters”disabled?
Section titled “disabled?”boolean
Returns
Section titled “Returns”object
liveDocs
Section titled “liveDocs”liveDocs:
LiveHostDoc[]
useOpenDoc()
Section titled “useOpenDoc()”useOpenDoc(): ((
docId) =>void) |null
Defined in: react/src/host.tsx:86
Returns
Section titled “Returns”((docId) => void) | null
usePostMention()
Section titled “usePostMention()”usePostMention(
docId): ((mention) =>Promise<boolean>) |null
Defined in: react/src/host.tsx:103
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”((mention) => Promise<boolean>) | null
usePostTranscriptLine()
Section titled “usePostTranscriptLine()”usePostTranscriptLine(
docId): (line) =>Promise<boolean>
Defined in: react/src/host.tsx:122
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”(line) => Promise<boolean>
useRestore()
Section titled “useRestore()”useRestore(
docId): (uptoId) =>Promise<boolean>
Defined in: react/src/host.tsx:98
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”(uptoId) => Promise<boolean>
useRunner()?
Section titled “useRunner()?”
optionaluseRunner(docId,runKey):LiveHostRunner|null
Defined in: react/src/host.tsx:154
Parameters
Section titled “Parameters”string
runKey
Section titled “runKey”string | null
Returns
Section titled “Returns”LiveHostRunner | null
useServerVoice()?
Section titled “useServerVoice()?”
optionaluseServerVoice():boolean|null
Defined in: react/src/host.tsx:133
Returns
Section titled “Returns”boolean | null
useUploadFiles()?
Section titled “useUploadFiles()?”
optionaluseUploadFiles(): ((files) =>void) |null
Defined in: react/src/host.tsx:149
Returns
Section titled “Returns”((files) => void) | null
useUser()
Section titled “useUser()”useUser():
LiveHostUser|null
Defined in: react/src/host.tsx:82
Returns
Section titled “Returns”LiveHostUser | null
useVersion()
Section titled “useVersion()”useVersion(
args):object
Defined in: react/src/host.tsx:93
Parameters
Section titled “Parameters”string
sinceId
Section titled “sinceId”string | null
uptoId
Section titled “uptoId”string | null
Returns
Section titled “Returns”object
isVersionLoading
Section titled “isVersionLoading”isVersionLoading:
boolean
version
Section titled “version”version:
VersionResponse|null