Reference Source
public class | source

BimServerClient

Constructor Summary

Public Constructor
public

Member Summary

Public Members
public

address: *

public

baseUrl: *

public
public

classes: {}

public
public
public

interfaceMapping: {"ServiceInterface": string, "NewServicesInterface": string, "AuthInterface": string, "OAuthInterface": string, "SettingsInterface": string, "AdminInterface": string, "PluginInterface": string, "MetaInterface": string, "LowLevelInterface": string, "NotificationRegistryInterface": string}

public
public

listeners: {}

public
public

schemas: {}

public
public

token: *

public
public

user: *

public

version: *

public
public

Method Summary

Public Methods
public

addExtendedData(roid: *, title: *, schema: *, data: *, success: *, error: *)

public

addSubtypesToSchema(classes: *)

public

call(interfaceName: string, methodName: string, data: Object, callback: Function, errorCallback: Function, showBusy: boolean, showDone: boolean, showError: boolean): *

Call a single method, this method delegates to the multiCall method

public

callWithFullIndication(interfaceName: *, methodName: *, data: *, callback: *): *

public

callWithNoIndication(interfaceName: *, methodName: *, data: *, callback: *, errorCallback: *): *

public

callWithUserErrorAndDoneIndication(action: *, data: *, callback: *): *

public

callWithUserErrorIndication(action: *, data: *, callback: *): *

public

callWithWebsocket(interfaceName: *, methodName: *, data: *): *

public

checkin(topicId: *, project: *, comment: *, file: *, deserializerOid: *, progressListener: *, success: *, error: *)

public
public

createModel(poid: *, callback: *): *

public

createRequest(interfaceName: *, method: *, data: *): *

public
public
public

generateRevisionDownloadUrl(settings: *): *

public

getAllSubTypes(schema: *, typeName: *, callback: *)

public

getJson(address: *, data: *, success: *, error: *)

public

getJsonSerializer(callback: *)

public
public

getMessagingSerializerByPluginClassName(pluginClassName: *, callback: *)

public

getModel(poid: *, roid: *, schema: *, deep: *, callback: *, name: *): *

public

getSerializerByPluginClassName(pluginClassName: *): *

public

init(callback: *): *

public

initiateCheckin(project: *, deserializerOid: *, callback: *, errorCallback: *)

public

isA(schema: *, typeSubject: *, typeName: *): *

public

log(message: *, message2: *)

public

login(username: *, password: *, callback: *, errorCallback: *, options: *)

public

logout(callback: *)

public

multiCall(requests: *, callback: *, errorCallback: *, showBusy: *, showDone: *, showError: *, connectWebSocket: *): *

public

processNotification(message: *)

public

register(interfaceName: *, methodName: *, callback: *, registerCallback: *)

public

registerChangeProgressProjectHandler(poid: *, newHandler: *, closedHandler: *, callback: *)

public

registerChangeProgressRevisionHandler(poid: *, roid: *, newHandler: *, closedHandler: *, callback: *)

public

registerChangeProgressServerHandler(newHandler: *, closedHandler: *, callback: *)

public

registerNewExtendedDataOnRevisionHandler(roid: *, handler: *, callback: *)

public

registerNewProjectHandler(handler: *, callback: *)

public

registerNewRevisionOnSpecificProjectHandler(poid: *, handler: *, callback: *)

public

registerNewUserHandler(handler: *, callback: *)

public

registerProgressHandler(topicId: *, handler: *, callback: *)

public

resolveUser(callback: *)

public

setBinaryDataListener(topicId: *, listener: *)

public

setToken(token: *, callback: *, errorCallback: *)

public

translate(key: *): *

public

unregister(listener: *)

public

unregisterChangeProgressProjectHandler(poid: *, newHandler: *, closedHandler: *, callback: *)

public

unregisterChangeProgressRevisionHandler(roid: *, newHandler: *, closedHandler: *, callback: *)

public

unregisterChangeProgressServerHandler(newHandler: *, closedHandler: *, callback: *)

public

unregisterNewExtendedDataOnRevisionHandler(roid: *, handler: *, callback: *)

public

unregisterNewProjectHandler(handler: *, callback: *)

public

unregisterNewRevisionOnSpecificProjectHandler(poid: *, handler: *, callback: *)

public

unregisterNewUserHandler(handler: *, callback: *)

public

unregisterProgressHandler(topicId: *, handler: *, callback: *)

Public Constructors

public constructor() source

Public Members

public address: * source

public baseUrl: * source

public binaryDataListener: {} source

public classes: {} source

public debug: boolean source

public idCounter: number source

public interfaceMapping: {"ServiceInterface": string, "NewServicesInterface": string, "AuthInterface": string, "OAuthInterface": string, "SettingsInterface": string, "AdminInterface": string, "PluginInterface": string, "MetaInterface": string, "LowLevelInterface": string, "NotificationRegistryInterface": string} source

public lastBusyTimeOut: * source

public listeners: {} source

public notifier: * source

public schemas: {} source

public serializersByPluginClassName: *[] source

public token: * source

public translateOverride: * source

public user: * source

public version: * source

public webSocket: * source

public websocketCalls: * source

Public Methods

public addExtendedData(roid: *, title: *, schema: *, data: *, success: *, error: *) source

Params:

NameTypeAttributeDescription
roid *
title *
schema *
data *
success *
error *

public addSubtypesToSchema(classes: *) source

Params:

NameTypeAttributeDescription
classes *

public call(interfaceName: string, methodName: string, data: Object, callback: Function, errorCallback: Function, showBusy: boolean, showDone: boolean, showError: boolean): * source

Call a single method, this method delegates to the multiCall method

Params:

NameTypeAttributeDescription
interfaceName string

Interface name, e.g. "ServiceInterface"

methodName string

Methodname, e.g. "addProject"

data Object

Object with a field per arument

callback Function

Function to callback, first argument in callback will be the returned object

errorCallback Function

Function to callback on error

showBusy boolean

Whether to show busy indication

showDone boolean

Whether to show done indication

showError boolean

Whether to show errors

Return:

*

public callWithFullIndication(interfaceName: *, methodName: *, data: *, callback: *): * source

Params:

NameTypeAttributeDescription
interfaceName *
methodName *
data *
callback *

Return:

*

public callWithNoIndication(interfaceName: *, methodName: *, data: *, callback: *, errorCallback: *): * source

Params:

NameTypeAttributeDescription
interfaceName *
methodName *
data *
callback *
errorCallback *

Return:

*

public callWithUserErrorAndDoneIndication(action: *, data: *, callback: *): * source

Params:

NameTypeAttributeDescription
action *
data *
callback *

Return:

*

public callWithUserErrorIndication(action: *, data: *, callback: *): * source

Params:

NameTypeAttributeDescription
action *
data *
callback *

Return:

*

public callWithWebsocket(interfaceName: *, methodName: *, data: *): * source

Params:

NameTypeAttributeDescription
interfaceName *
methodName *
data *

Return:

*

public checkin(topicId: *, project: *, comment: *, file: *, deserializerOid: *, progressListener: *, success: *, error: *) source

Params:

NameTypeAttributeDescription
topicId *
project *
comment *
file *
deserializerOid *
progressListener *
success *
error *

public clearBinaryDataListener(topicId: *) source

Params:

NameTypeAttributeDescription
topicId *

public createModel(poid: *, callback: *): * source

Params:

NameTypeAttributeDescription
poid *
callback *

Return:

*

public createRequest(interfaceName: *, method: *, data: *): * source

Params:

NameTypeAttributeDescription
interfaceName *
method *
data *

Return:

*

public downloadViaWebsocket(msg: *) source

Params:

NameTypeAttributeDescription
msg *

public generateExtendedDataDownloadUrl(edid: *): * source

Params:

NameTypeAttributeDescription
edid *

Return:

*

public generateRevisionDownloadUrl(settings: *): * source

Params:

NameTypeAttributeDescription
settings *

Return:

*

public getAllSubTypes(schema: *, typeName: *, callback: *) source

Params:

NameTypeAttributeDescription
schema *
typeName *
callback *

public getJson(address: *, data: *, success: *, error: *) source

Params:

NameTypeAttributeDescription
address *
data *
success *
error *

public getJsonSerializer(callback: *) source

Params:

NameTypeAttributeDescription
callback *

public getJsonStreamingSerializer(callback: *) source

Params:

NameTypeAttributeDescription
callback *

public getMessagingSerializerByPluginClassName(pluginClassName: *, callback: *) source

Params:

NameTypeAttributeDescription
pluginClassName *
callback *

public getModel(poid: *, roid: *, schema: *, deep: *, callback: *, name: *): * source

Params:

NameTypeAttributeDescription
poid *
roid *
schema *
deep *
callback *
name *

Return:

*

public getSerializerByPluginClassName(pluginClassName: *): * source

Params:

NameTypeAttributeDescription
pluginClassName *

Return:

*

public init(callback: *): * source

Params:

NameTypeAttributeDescription
callback *

Return:

*

public initiateCheckin(project: *, deserializerOid: *, callback: *, errorCallback: *) source

Params:

NameTypeAttributeDescription
project *
deserializerOid *
callback *
errorCallback *

public isA(schema: *, typeSubject: *, typeName: *): * source

Params:

NameTypeAttributeDescription
schema *
typeSubject *
typeName *

Return:

*

public log(message: *, message2: *) source

Params:

NameTypeAttributeDescription
message *
message2 *

public login(username: *, password: *, callback: *, errorCallback: *, options: *) source

Params:

NameTypeAttributeDescription
username *
password *
callback *
errorCallback *
options *

public logout(callback: *) source

Params:

NameTypeAttributeDescription
callback *

public multiCall(requests: *, callback: *, errorCallback: *, showBusy: *, showDone: *, showError: *, connectWebSocket: *): * source

Params:

NameTypeAttributeDescription
requests *
callback *
errorCallback *
showBusy *
showDone *
showError *
connectWebSocket *

Return:

*

public processNotification(message: *) source

Params:

NameTypeAttributeDescription
message *

public register(interfaceName: *, methodName: *, callback: *, registerCallback: *) source

Params:

NameTypeAttributeDescription
interfaceName *
methodName *
callback *
registerCallback *

public registerChangeProgressProjectHandler(poid: *, newHandler: *, closedHandler: *, callback: *) source

Params:

NameTypeAttributeDescription
poid *
newHandler *
closedHandler *
callback *

public registerChangeProgressRevisionHandler(poid: *, roid: *, newHandler: *, closedHandler: *, callback: *) source

Params:

NameTypeAttributeDescription
poid *
roid *
newHandler *
closedHandler *
callback *

public registerChangeProgressServerHandler(newHandler: *, closedHandler: *, callback: *) source

Params:

NameTypeAttributeDescription
newHandler *
closedHandler *
callback *

public registerNewExtendedDataOnRevisionHandler(roid: *, handler: *, callback: *) source

Params:

NameTypeAttributeDescription
roid *
handler *
callback *

public registerNewProjectHandler(handler: *, callback: *) source

Params:

NameTypeAttributeDescription
handler *
callback *

public registerNewRevisionOnSpecificProjectHandler(poid: *, handler: *, callback: *) source

Params:

NameTypeAttributeDescription
poid *
handler *
callback *

public registerNewUserHandler(handler: *, callback: *) source

Params:

NameTypeAttributeDescription
handler *
callback *

public registerProgressHandler(topicId: *, handler: *, callback: *) source

Params:

NameTypeAttributeDescription
topicId *
handler *
callback *

public resolveUser(callback: *) source

Params:

NameTypeAttributeDescription
callback *

public setBinaryDataListener(topicId: *, listener: *) source

Params:

NameTypeAttributeDescription
topicId *
listener *

public setToken(token: *, callback: *, errorCallback: *) source

Params:

NameTypeAttributeDescription
token *
callback *
errorCallback *

public translate(key: *): * source

Params:

NameTypeAttributeDescription
key *

Return:

*

public unregister(listener: *) source

Params:

NameTypeAttributeDescription
listener *

public unregisterChangeProgressProjectHandler(poid: *, newHandler: *, closedHandler: *, callback: *) source

Params:

NameTypeAttributeDescription
poid *
newHandler *
closedHandler *
callback *

public unregisterChangeProgressRevisionHandler(roid: *, newHandler: *, closedHandler: *, callback: *) source

Params:

NameTypeAttributeDescription
roid *
newHandler *
closedHandler *
callback *

public unregisterChangeProgressServerHandler(newHandler: *, closedHandler: *, callback: *) source

Params:

NameTypeAttributeDescription
newHandler *
closedHandler *
callback *

public unregisterNewExtendedDataOnRevisionHandler(roid: *, handler: *, callback: *) source

Params:

NameTypeAttributeDescription
roid *
handler *
callback *

public unregisterNewProjectHandler(handler: *, callback: *) source

Params:

NameTypeAttributeDescription
handler *
callback *

public unregisterNewRevisionOnSpecificProjectHandler(poid: *, handler: *, callback: *) source

Params:

NameTypeAttributeDescription
poid *
handler *
callback *

public unregisterNewUserHandler(handler: *, callback: *) source

Params:

NameTypeAttributeDescription
handler *
callback *

public unregisterProgressHandler(topicId: *, handler: *, callback: *) source

Params:

NameTypeAttributeDescription
topicId *
handler *
callback *