class
ScriptSvnRemoteServices.
SvnRemoteServices
Bases: object
Contains all functionality which works against a server.
The ISvnReporter passed to this calls will be automatically wrapped if the call is not happening on the primary thread, so all calls are scheduled back to the primary thread. The calls which don’t return any values will be scheduled asynchroneously, so they cannot block the operation from proceeding. But SvnReporter.HandleSvnCancel needs a return value, so it will be called synchroneously. The same applies to the Authentication Handler which may prompt the user. This also means that you have to pump the main threads message queue while calling those services in the background thread, or the call will block forever. (However, the ability to pump the message queue is the whole point why one would make this call from a background thread, so this should not be a serious limitation.)
SetRevisionPropertyValue
url
revision
stPropertyName
propertyValue
reporter
Sets a revision property.
url (Uri) – The URL.
revision (SvnRevision) – The revision.
stPropertyName (str) – Name of the property.
propertyValue (SvnPropertyValue) – The property value.
reporter (SvnReporter) – The Reporter.
CreateRemoteNode
url
revision
reporter
Creates a remote node.
url (Uri) – The URL (may contain a peg url).
revision (SvnRevision) – The revision (null allowed).
reporter (SvnReporter) – The Reporter (null allowed).
SvnRemotePSNode
A remote virtual IPSNode instance.
GetObjectAtRevision
objectRevisionContext
url
revision
mode
reporter
Gets the object at a given revision.
objectRevisionContext (Guid) – The object revision context.
url (Uri) – The svn Url of the object.
revision (SvnRevision) – The revision.
mode (SvnObjectRevisionMode) – The mode to create the temporary object context.
reporter (SvnReporter) – The Reporter.
MetaObjectStub
The meta object stub.
To clean the Context after end of the comparision, use SvnCommonServices.CleanObjectAtRevisionContext.
List
url
revision
depth
entryTypes
bRetrieveLocks
bSwallowNonExistingException
reporter
Lists the specified Url on the server.
url (Uri) – The URL.
revision (SvnRevision) – The revision.
depth (SvnDepth) – The depth.
entryTypes (SvnDirEntryItems) – The extended entry types.
bRetrieveLocks (bool) – if set to True, also retrieve locking information.
bSwallowNonExistingException (bool) – If set to True, the exceptions for non existing destination entries are suppressed, and an empty list is returned instead.
reporter (SvnReporter) – The reporter.
list[SvnDirEntry]
The list of SVN entries.
CheckUrlForNewProject
args
Checks whether the url is good for a new project (on svn import) - this is either an empty directory, or a non-existing directory with an existing parent. This check is performed in Head.
args (SvnUrlAcceptFilterArgs) – The filter args.
CheckUrlForCopyDestination
args
Checks whether the url is good as a destination for “svn copy”. Currently, this is a non-existing directory with an existing parent. This check is performed in Head.
args (SvnUrlAcceptFilterArgs) – The filter args.
CheckUrlForExistingProject
args
Checks the URL for existing project. The current heuristics checks for a directory with no CoDeSys data files, but subdirectories that contain data files.
args (SvnUrlAcceptFilterArgs) – The filter args.
CheckUrlByParentFactory
parent
A delegate which checks Urls for being accepted by the given parent. This is used by the svn externals dialog.
parent (SvnObjectId) – The parent where the Url is meant to be inserted, needs to be an ObjectID for an object which is “live” in the current project.
DeleteRevisionPropertyValue
url
revision
stPropertyName
reporter
Deletes a revision property.
url (Uri) – The URL.
revision (SvnRevision) – The revision.
stPropertyName (str) – Name of the property.
reporter (SvnReporter) – The Reporter.
CreateRemoteDirectory
url
stCommitMessage
reporter
Creates a remote directory.
url (Uri) – The URL of the directory to create.
stCommitMessage (str) – The commit message for the directory.
reporter (SvnReporter) – The reporter.
GetLog
url
revisionRanges
nLimit
bStopOnCopy
bRetrieveAllProperties
reporter
Queries subversion log entries.
url (Uri) – The URL.
revisionRanges (list[SvnRevisionRange]) – The revision ranges.
nLimit (int) – The maximum number of log entries.
bStopOnCopy (bool) – if set to True, stop on copy operations.
bRetrieveAllProperties (bool) – if set to True, all revision properties are fetched.
reporter (SvnReporter) – The reporter.
list[SvnLogInfo]
The list of log entries.
Delete
url
logMessage
reporter
Deletes an existing subversion node.
url (Uri) – The URL.
logMessage (str) – The log message.
reporter (SvnReporter) – The reporter.
Rename
url
newName
logMessage
reporter
Renames an existing subversion node.
url (Uri) – The URL.
newName (str) – The new name of the node.
logMessage (str) – The log message.
reporter (SvnReporter) – The reporter.
Copy
sourceUrl
destinationUrl
logMessage
reporter
Copies an existing subversion node.
sourceUrl (Uri) – The URL.
destinationUrl (Uri) – The target URL.
logMessage (str) – The log message.
reporter (SvnReporter) – The reporter.
CheckUrlByObjectUniqueness
nProjectHandle
Returns a delegate which checks Urls for not containing any objects already existing in the project. Object uniqueness is given by the ObjectGuid. This check is used by the svn externals dialog to prevent duplicate inclusion of the same external.
nProjectHandle (int) – The project handle of the project to check the Url objects against.
The return value of this method is to be passed as acceptedUrlFilter delegate e.g. to SvnUIServices.BrowseRepository
CheckUrlByAggregatedUrlCheckers
urlCheckers
Returns a delegate wich checks Urls using all provided Url check delegates in sequence. The check only is passed, if all Url check delegates accept the Url.
urlCheckers (list[SvnUrlAcceptFilterArgs]) – A list of Url check delegates.
The return value of this method is to be passed as acceptedUrlFilter delegate e.g. to SvnUIServices.BrowseRepository