首页 / dm / oaVCObserver

oaVCObserver

模块: oapy._oa._dm 导入: from oapy._oa import _dm

概览

oaVCObserver 在 oapy 中可用，可通过 _dm 模块访问。

本页汇总 oaVCObserver 当前在 oapy 中可用的 Python 接口。

详细说明

The oaVCObserver class is a base class for version control (VC) observers。 It supports onVCPlugInLoad and onVCMessageOut event notifications。 See oaObserver for information on using Open Access observer classes to derive and instantiate observers in an application。

构造函数

`_dm.oaVCObserver(priorityIn, enabledIn=true)`

obj = _dm.oaVCObserver(priorityIn, enabledIn=true)

方法总览

状态	Python 调用
✅	`obj.onVCPlugInLoad(plugInName)`
✅	`obj.onVCMessageOut(plugInName, object, operation, msgType, text)`

方法说明

`obj.onVCPlugInLoad(plugInName)`

绑定状态: 已绑定

Python 调用: obj.onVCPlugInLoad(plugInName)

This observer function is called after a version control plugin has been loaded。 The application's derived class should implement this function to receive notification after a version control plugin has been loaded。

参数

plugInName: name of the loaded version control plugin。

Python 示例

from oapy._oa import _dm

# assume obj is a oaVCObserver
obj.onVCPlugInLoad(plugInName)

`obj.onVCMessageOut(plugInName, object, operation, msgType, text)`

绑定状态: 已绑定

Python 调用: obj.onVCMessageOut(plugInName, object, operation, msgType, text)

This observer function is called after a version control message has been output to a plugin。 The application's derived class should implement this function to receive notification and message information after a version control message has been output。

参数

plugInName: name of the plug in that was sent the message。
object: the object that the message corresponds to。
operation: the version control operation that was in effect when this message was generated。
msgType: version control message type。
text: the output message string。

oaVCObserverResult this result is used for messages of oacVCMsgTypeQueryOk。 For messages of this type, observers have the opportunity to respond with "ok" or "abort" (see oaVCObserverResultEnum)。

Python 示例

from oapy._oa import _dm

# assume obj is a oaVCObserver
obj.onVCMessageOut(plugInName, object, operation, msgType, text)