LevlClient
Defined in: core/src/client/client.ts:22
Extends
Section titled “Extends”StoreProvider.SynchronousRequestsDispatcher
Implements
Section titled “Implements”StoreProvider
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new LevlClient(
config):LevlClient
Defined in: core/src/client/client.ts:48
Parameters
Section titled “Parameters”config
Section titled “config”LevlClientConfig
Returns
Section titled “Returns”LevlClient
Inherited from
Section titled “Inherited from”StoreProvider.constructor
Properties
Section titled “Properties”cachedToken
Section titled “cachedToken”cachedToken:
string|undefined
Defined in: core/src/client/client.ts:246
Inherited from
Section titled “Inherited from”SynchronousRequestsDispatcher.cachedToken
documents
Section titled “documents”documents:
Record<string,SharedStore> ={}
Defined in: core/src/client/client.ts:44
isConnected
Section titled “isConnected”isConnected:
Accessor<boolean>
Defined in: core/src/client/client.ts:36
name:
Accessor<string>
Defined in: core/src/client/client.ts:38
onStatelessListeners
Section titled “onStatelessListeners”onStatelessListeners: (
payload) =>boolean[]
Defined in: core/src/client/client.ts:245
Parameters
Section titled “Parameters”payload
Section titled “payload”string
Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”SynchronousRequestsDispatcher.onStatelessListeners
setName()
Section titled “setName()”setName: (
value) =>void
Defined in: core/src/client/client.ts:39
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”void
optionalurl:string
Defined in: core/src/client/client.ts:41
userId
Section titled “userId”userId:
string
Defined in: core/src/client/client.ts:42
Accessors
Section titled “Accessors”allDocumentsLoaded
Section titled “allDocumentsLoaded”Get Signature
Section titled “Get Signature”get allDocumentsLoaded():
boolean
Defined in: core/src/client/client.ts:146
Returns
Section titled “Returns”boolean
providers
Section titled “providers”Get Signature
Section titled “Get Signature”get providers():
Map<string,HocuspocusProvider> |undefined
Defined in: core/src/client/client.ts:206
Returns
Section titled “Returns”Map<string, HocuspocusProvider> | undefined
userStoreProvider
Section titled “userStoreProvider”Get Signature
Section titled “Get Signature”get userStoreProvider():
HocuspocusProvider
Defined in: core/src/client/client.ts:210
Returns
Section titled “Returns”HocuspocusProvider
Methods
Section titled “Methods”configure()
Section titled “configure()”configure(
__namedParameters):void
Defined in: core/src/client/client.ts:153
Parameters
Section titled “Parameters”__namedParameters
Section titled “__namedParameters”Connection
Returns
Section titled “Returns”void
fetchToken()
Section titled “fetchToken()”fetchToken(
this):Promise<string>
Defined in: core/src/client/client.ts:248
Parameters
Section titled “Parameters”LevlClient
Returns
Section titled “Returns”Promise<string>
Inherited from
Section titled “Inherited from”SynchronousRequestsDispatcher.fetchToken
get<
T>(pluginName):LevlPlugin<T>
Defined in: core/src/client/client.ts:214
Type Parameters
Section titled “Type Parameters”T extends PluginDescriptor
Parameters
Section titled “Parameters”pluginName
Section titled “pluginName”T["name"]
Returns
Section titled “Returns”LevlPlugin<T>
onStateless()
Section titled “onStateless()”onStateless(
payload):void
Defined in: core/src/client/client.ts:329
Parameters
Section titled “Parameters”payload
Section titled “payload”onStatelessParameters
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”SynchronousRequestsDispatcher.onStateless
onStatelessOnce()
Section titled “onStatelessOnce()”onStatelessOnce(
handler):void
Defined in: core/src/client/client.ts:324
Parameters
Section titled “Parameters”handler
Section titled “handler”(payload) => boolean
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”SynchronousRequestsDispatcher.onStatelessOnce
sendSync()
Section titled “sendSync()”sendSync(
this,plugin,message,params):Promise<any>
Defined in: core/src/client/client.ts:268
Parameters
Section titled “Parameters”LevlClient
plugin
Section titled “plugin”string
message
Section titled “message”string
params
Section titled “params”any
Returns
Section titled “Returns”Promise<any>
Inherited from
Section titled “Inherited from”SynchronousRequestsDispatcher.sendSync
useObject()
Section titled “useObject()”useObject<
ObjectType>(objType,id,docOverride?):InstanceType<ObjectType>
Defined in: core/src/client/client.ts:135
Type Parameters
Section titled “Type Parameters”ObjectType
Section titled “ObjectType”ObjectType extends SharedObjectType<any, any, any>
Parameters
Section titled “Parameters”objType
Section titled “objType”ObjectType
IDOfSharedObjectType<ObjectType>
docOverride?
Section titled “docOverride?”SharedStore<any>
Returns
Section titled “Returns”InstanceType<ObjectType>
Inherited from
Section titled “Inherited from”StoreProvider.useObject
useStore()
Section titled “useStore()”useStore<
StoreType>(storeType):InstanceType<StoreType>
Defined in: core/src/client/client.ts:78
returns a new SharedStore or a cached one
Type Parameters
Section titled “Type Parameters”StoreType
Section titled “StoreType”StoreType extends SharedStoreType = SharedStoreType
Parameters
Section titled “Parameters”storeType
Section titled “storeType”StoreType
Returns
Section titled “Returns”InstanceType<StoreType>
Inherited from
Section titled “Inherited from”StoreProvider.useStore
useUserStore()
Section titled “useUserStore()”useUserStore():
UserStore
Defined in: core/src/client/client.ts:74
Returns
Section titled “Returns”UserStore