model-client/org.modelix.model.client2

Package-level declarations

Types

interface BranchJS

JS-API for IBranch. Can be used to read and write model data.

typealias ChangeHandler = (ChangeJS) -> Unit

sealed interface ChangeJS

Represents a change in branch that can be handled by a ChangeHandler. See BranchJS.addListener

ChildrenChanged

data class ChildrenChanged(val node: INodeJS, val role: String?) : ChangeJS

Represents moved, added or removed children.

interface ClientJS

JS-API for ModelClientV2. Can be used to perform operations on the model server and to read and write model data.

data class ConceptChanged(val node: INodeJS) : ChangeJS

Represents the change of the concept of a node.

ContainmentChanged

data class ContainmentChanged(val node: INodeJS) : ChangeJS

Represents the change of the parent of node changed.

interface IModelClientV2

This interface is meant exclusively for model client usage.

IModelClientV2Internal

interface IModelClientV2Internal : IModelClientV2

Should only be used by Modelix components.

class ModelClientV2(httpClient: HttpClient, val baseUrl: String, clientProvidedUserId: String?) : IModelClientV2, IModelClientV2Internal, Closable

ModelClientV2Builder

abstract class ModelClientV2Builder

ModelClientV2PlatformSpecificBuilder

expect class ModelClientV2PlatformSpecificBuilder : ModelClientV2Builder

actual class ModelClientV2PlatformSpecificBuilder : ModelClientV2Builder

actual class ModelClientV2PlatformSpecificBuilder : ModelClientV2Builder

PropertyChanged

data class PropertyChanged(val node: INodeJS, val role: String) : ChangeJS

Represents a changed property value.

ReferenceChanged

data class ReferenceChanged(val node: INodeJS, val role: String) : ChangeJS

Represents a changed reference target.

ReplicatedModel

class ReplicatedModel(val client: IModelClientV2, val branchRef: BranchReference, providedScope: CoroutineScope? = null, initialRemoteVersion: CLVersion? = null)

Dispose should be called on this, as otherwise a regular polling will go on.

ReplicatedModelJS

interface ReplicatedModelJS

Represents a branch two-way live replicated to the model server.

VersionInformationJS

data class VersionInformationJS(val author: String?, val time: Date?)

Contains a subset of version data like in CPVersion.

VersionNotFoundException

class VersionNotFoundException(val versionHash: String) : Exception

Functions

checkObjectHashes

fun VersionDelta.checkObjectHashes()

fun connectClient(url: String, bearerTokenProvider: () -> Promise<String?>? = null): Promise<ClientJS>

Create a client connected to the model server.

fun VersionDelta.getAllObjects(): Map<String, String>

getReplicatedModel

fun IModelClientV2.getReplicatedModel(branchRef: BranchReference): ReplicatedModel

fun IModelClientV2.getReplicatedModel(branchRef: BranchReference, scope: CoroutineScope): ReplicatedModel

lazyLoadVersion

suspend fun IModelClientV2.lazyLoadVersion(branchRef: BranchReference, config: CacheConfiguration = CacheConfiguration()): IVersion

An overload of IModelClientV2.lazyLoadVersion that reads the current version hash of the branch from the server and then loads that version with lazy loading support.

fun IModelClientV2.lazyLoadVersion(repositoryId: RepositoryId, versionHash: String, config: CacheConfiguration = CacheConfiguration()): IVersion

This function loads parts of the model lazily while it is iterated and limits the amount of data that is cached on the client side.

loadModelsFromJson

fun loadModelsFromJson(json: Array<String>): INodeJS

Same as loadModelsFromJsonAsBranch but directly returns the BranchJS.rootNode of the created branch.

loadModelsFromJsonAsBranch

fun loadModelsFromJsonAsBranch(json: Array<String>): BranchJS

Load data from JSON strings into an in-memory branch.

readVersionDelta

suspend fun HttpResponse.readVersionDelta(): VersionDeltaStream

suspend fun <T> IModelClientV2.runWrite(branchRef: BranchReference, body: (INode) -> T): T

Performs a write transaction on the root node of the given branch.

runWriteOnBranch

suspend fun <T> IModelClientV2.runWriteOnBranch(branchRef: BranchReference, body: (IBranch) -> T): T

Performs a write transaction on the root node of the given branch.

useVersionStreamFormat

fun HttpRequestBuilder.useVersionStreamFormat()