Metabase

Namespace: PP.Mb;

Inheritance hierarchy

Object

PPService

Metabase

Description

The Metabase class is used to create a connection to repository.

Syntax

PP.initClass(PP.Mb.Metabase, PP.Mb.PPService, "Metabase");

Constructor

  Constructor name Brief description
Metabase The Metabase constructor creates a repository connection.

Properties

  Property name Brief description
EnableCaching The EnableCaching property determines whether repository objects are to be cached.
UserCreds The UserCreds property sets user credentials for repository connection.

Methods

  Method name Brief description
changePassword The changePassword method sets a new password for repository user.
clearCache The clearCache method clears query cache to repository service.
close The close method closes connection to repository.
closeObject The closeObject method closes repository object.
createObject The createObject method creates a repository object.
createShortcut The createShortcut method creates a shortcut for repository object.
deleteObjects The deleteObjects method deletes repository objects by their keys.
findObjects The findObjects method finds repository objects by specified parameters.

flushCache

The flushCache method flushes all repository cache.

getConnectionId

The getConnectionId method returns ID of connection to database.

getCustomClasses

The getCustomClasses method sends a request to get custom classes of the repository.

getExportUrl

The getExportUrl method returns the data export URL.

getFullPath

The getFullPath method requests data about parent directories for the specified object.

getImportUrl

The getExportUrl method returns the data import URL.

getMbSec

The getMbSec method requests additional settings for repository.

getObjects

The getObjects method returns repository objects.

getOAuthToken

The getOAuthToken method requests a token for authentication on OAuth server.

getPathToRoot

The getPathToRoot method returns hierarchy to the root of selected object.

getRecentObjects

The getRecentObjects method returns recently opened objects.

getSearch

The getSearch method sends request to server to search for object.

getSessionCookie

The getSessionCookie method returns identification number of cookie.

getStatus

The getStatus method checks the state of repository session.

moveObject

The moveObject method is used to move an object.

open

The open method opens repository.

refresh

The refresh method refreshes repository connection.

saveObject

The saveObject method is used to save an open object.

saveObjectAs

The saveObjectAs method is used to save an object to a new object.

shareMobile

The shareMobile method is used to publish an object to mobile application server.

sharePointShare

The sharePointShare method is used to publish an object to SharePoint.

Events

   Event name Brief description
Closed The Closed event occurs on closing repository connection.
Opened The Opened event occurs on opening a repository.
Refreshed The Refreshed event occurs on refreshing repository connection.

Properties inherited from the class Object

  Property name Brief description

Id

The Id property determines a repository object identifier.

Methods inherited from the class Object

  Method name Brief description
clone The clone method creates an object copy.
dispose The dispose method deletes the component.
getHashCode The getHashCode method returns hash code of repository object.
getSettings The getSettings method returns repository object settings.
getTypeName The getTypeName method returns the name of the object type without the namespace, to which it belongs.
isEqual The isEqual method determines whether the specified object is equal to the current repository object.
isLive The isLive method determines validity of repository object.
removeAllEvents The removeAllEvents method removes all object event handlers by the specified context.
setSettings The setSettings method determines repository object settings.
defineProps The defineProps method creates get and set methods from name array for the specified class.
keys The keys method returns array of methods and properties names for the specified object.

Metabase