UBConnection

Members

serverUrl: string readonly

baseURL: String readonly

appName: String readonly

channelEncryptor: UBNativeDSTUCrypto

lastLoginName: String

useCacheForXHR: Boolean|String

Type:

• Boolean|String

recorderEnabled: Boolean

Methods

isPKIReady() → boolean protected

isAuthorized() → boolean

userLogin() → String

userLang() → String

userData(keyopt) → *

 $App.connection.userData('lang');
 // or the same but dedicated alias
 $App.connection.userLang()

Arguments:

1. [key] (String)  Optional key

authorize(isRepeatopt) → Promise

Arguments:

1. [isRepeat] (boolean)  in case user provide wrong credential - we must show logon window

authHandshakeUBIP(authParams) → Promise

Arguments:

1. authParams

authHandshakeOpenIDConnect(authParams) → *

Arguments:

1. authParams

authHandshakeUB(authParams) → Promise

Arguments:

1. authParams

authHandshakeCERT(authParams) → Promise

Arguments:

1. authParams

initCache(userDbVersion) → Promise

Arguments:

1. userDbVersion (Number)  Indexed DB database version required for current application

cacheKeyCalculate(root, attributesopt) → String

Arguments:

1. root (String)  This is usually entity name
2. [attributes] (Array.<string>)  if present - add attributes hash. This is usually array of entity attributes we want to put inside cache

cacheOccurrenceRefresh(root, cacheType) → Promise

Arguments:

1. root (String)  Root part of cache key. The same as in UBConnection#cacheKeyCalculate
2. cacheType (String)  One of UBCache#cacheTypes

cacheOccurrenceRemove(root, cacheType) → Promise

Arguments:

1. root (String)  Root part of cache key. The same as in UBConnection#cacheKeyCalculate
2. cacheType (String)  One of UBCache#cacheTypes

cacheClearAll() → Promise

pki() → UBNativeIITCrypto

exchangeKeys(session) → Promise

Arguments:

1. session

get(url, configopt) → Promise

Arguments:

1. url (string)  Relative or absolute URL specifying the destination of the request
2. [config] (Object)  Optional configuration object as in UB.xhr

post(url, data, configopt) → Promise

Arguments:

1. url (string)  Relative or absolute URL specifying the destination of the request
2. data (*)  Request content
3. [config] (Object)  Optional configuration object as in UB.xhr

xhr(config) → Promise

Arguments:

1. config (Object)  Request configuration as described in UB.xhr

getAppInfo() → Promise

getDomainInfo(callBackopt) → Promise

Arguments:

1. [callBack] (function)  This parameter will be deleted in next version

initEncriptionIfNeed() → Promise

query(ubq, allowBufferopt) → Promise

Arguments:

1. ubq (Object)  Request to execute

   Properties

   1. entity (String)  Entity to execute the method
   2. method (String)  Method of entity to executed
   3. [fieldList] (Array.<String>)
   4. [whereList] (Object)
   5. [execParams] (Object)
   6. [ID] (Number)
   7. [options] (Object)
   8. [lockType] (String)
   9. [__skipOptimisticLock] (Boolean)  In case this parameter true and in the buffered
   10. [__nativeDatasetFormat] (Boolean)
2. [allowBuffer] (Boolean)  Allow buffer this request to single runList. False by default

convertResponseDataToJsTypes(serverResponse) → *

 // convert all string representation of date/dateTime to Date object, integer representation of bool to Boolean
 return me.query({entity: 'my_entity', method: 'select'}, true)
     .then(me.convertResponseDataToJsTypes.bind(me));

Arguments:

1. serverResponse

doFilterAndSort(cachedData, ubRequest) → Object protected

Arguments:

1. cachedData (TubCachedData)
2. ubRequest (TubSelectRequest)

addNew(serverRequest) → Promise

 $App.connection.addNew({entity: 'uba_user', fieldList: ['*']}).done(UB.logDebug);

Arguments:

1. serverRequest (Object)  Request to execute

   Properties

   1. entity (String)  Entity to execute the method
   2. [method] (String)  Method of entity to executed. Default to 'select'
   3. fieldList (Array.<string>)
   4. [execParams] (Object)
   5. [options] (Object)
   6. [lockType] (String)
   7. [alsNeed] (Boolean)

update(serverRequest, allowBufferopt) → Promise

 $App.connection.update({entity: 'uba_user', fieldList: ['ID','name'], execParams: {ID: 1, name:'newName'}}).done(UB.logDebug);

Arguments:

1. serverRequest (Object)  Request to execute

   Properties

   1. entity (String)  Entity to execute the method
   2. [method] (String)  Method of entity to executed. Default to 'update'
   3. fieldList (Array.<string>)
   4. [execParams] (Object)
   5. [options] (Object)
   6. [lockType] (String)
   7. [alsNeed] (Boolean)
2. [allowBuffer] (Boolean)  Default - false. Allow several "in the same time" request to be buffered to one transaction.

insert(serverRequest, allowBufferopt) → Promise

Arguments:

1. serverRequest (Object)  Request to execute

   Properties

   1. entity (String)  Entity to execute the method
   2. [method] (String)  Method of entity to executed. Default to 'insert'
   3. fieldList (Array.<string>)
   4. [execParams] (Object)
   5. [options] (Object)
   6. [lockType] (String)
   7. [alsNeed] (Boolean)
2. [allowBuffer] (Boolean)  Default - false. Allow several "in the same time" request to be buffered to one transaction.

doDelete(serverRequest, allowBufferopt) → Promise

Arguments:

1. serverRequest (Object)  Request to execute

   Properties

   1. entity (String)  Entity to execute the method
   2. [method] (String)  Method of entity to executed. Default to 'delete'
   3. [execParams] (Object)
   4. [options] (Object)
   5. [lockType] (String)
   6. [alsNeed] (Boolean)
2. [allowBuffer] (Boolean)  Default - false. Allow several "in the same time" request to be buffered to one transaction.

select(serverRequest, bypassCacheopt) → Promise

Arguments:

1. serverRequest (Object)  Request to execute

   Properties

   1. entity (String)  Entity to execute the method
   2. [method] (String)  Method of entity to executed. Default to 'select'
   3. [ID] (Number)  if passed - request bypass cache, where & order list is ignored. Can be used to load single record from server
   4. fieldList (Array.<string>)
   5. [whereList] (Object)
   6. [execParams] (Object)
   7. [options] (Object)
   8. [lockType] (String)
   9. [alsNeed] (Boolean)
   10. [__skipOptimisticLock] (Boolean)  In case this parameter true and in the buffered
2. [bypassCache=false] (Boolean)  Do not use cache while request even if entity cached. If __mip_disablecache: true is passed in serverRequest cache is also disabled.

runTrans(ubRequestArray) → Promise

 $App.connection.runTrans([
      { entity: 'my_entity', method: 'update', ID: 1, execParams: {code: 'newCode'} },
      { entity: 'my_entity', method: 'update', ID: 2, execParams: {code: 'newCodeforElementWithID=2'} },
  ]).done(UB.logDebug);

Arguments:

1. ubRequestArray (Array.<ubRequest>)

getDocument(params, optionsopt) → Promise

 //Retrieve content of document as string using GET
 $App.connection.getDocument({
     entity:'ubm_form',
     attribute: 'formDef',
     ID: 100000232003
  }).done(function(result){console.log(typeof result)}); // string

 //The same, but using POST for bypass cache
 $App.connection.getDocument({
     entity:'ubm_form',
     attribute: 'formDef',
     ID: 100000232003
  }, {
     bypassCache: true
  }).done(function(result){console.log(typeof result)}); // string


 //Retrieve content of document as ArrayBuffer and bypass cache
 $App.connection.getDocument({
     entity:'ubm_form',
     attribute: 'formDef',
     ID: 100000232003
  }, {
     bypassCache: true, resultIsBinary: true
  }).done(function(result){
     console.log('Result is', typeof result, 'of length' , result.byteLength, 'bytes'); //output: Result is object of length 2741 bytes
  });

Arguments:

1. params (Object)

   Properties

   1. entity (String)  Code of entity to retrieve from
   2. attribute (String)  document type attribute code
   3. id (Number)  Instance ID
   4. [forceMime] (String)  If passed and server support transformation from source MIME type to forceMime server perform transformation and return documenRt representation in the passed MIME
   5. [revision] (Number)  Optional revision of the documnet (if supported by server-side store configuration). Default is current revision.
   6. [fileName] (String)  ????
   7. [isDirty=false] (Boolean)  Optional ability to retrieve document in dirty state
   8. [store] (String)  ????
2. [options] (Object)  Additional request options

   Properties

   1. [resultIsBinary=false] (Boolean)  if true - return document content as arrayBuffer
   2. [bypassCache] (Boolean)  HTTP POST verb will be used instead of GET for bypass browser cache

logout()

serverErrorByCode(errorNum) → String

Arguments:

1. errorNum (Number)

listenerCount(emitter, type) → Number

Arguments:

1. emitter (EventEmitter)
2. type (String)

Mixes In:

• EventEmitter.listenerCount