class
ScriptSvnCommonServices.
SvnCommonServices
Bases: object
Contains all services which work with local and remote SVN Objects.
CreateRevision
time
Factory function for ISvnRevision instances.
time (DateTime) – The time.
SvnRevision
The ISvnRevision instance.
CreateRevisionRange
startRevision
endRevision
Factory function for ISvnRevisionRange instances. :type startRevision: SvnRevision :param startRevision: The start revision.
endRevision (SvnRevision) – The end revision.
SvnRevisionRange
The ISvnRevisionRange instance.
GetObjectInfo
id
Gets the object info for a given object.
id (SvnObjectId) – The id.
SvnObjectInfo
The ISvnObjectInfo instance.
CreatePropertyValue
value
Factory for a binary ISvnPropertyValue instances.
value (list[int]) – The value.
SvnPropertyValue
The ISvnProperty value
property
IsAuthenticationDataExisting
Gets a value indicating whether cached authentication data is existing.
bool
True if this instance has existing authentication data; otherwise, False.
SvnCommonServices.ExistingAuthenticationDataLocations
property
OfflineMode
Gets a value indicating whether the offline mode is active. Currently, the offline mode disables implicit locking, and deactivates all commands which need online access. (Only the commands will be deactivated, the API functions are still available!)
over time, we plan to abandon implicit locking eventually. This will allow us to get rid of the offline mode, or at least weaken its semantics by dropping the implicit locking (or limiting it to some specific types of objects).
bool
True if [offline mode]; otherwise, False.
SetOfflineMode
bOffline
Sets the offline mode.
bOffline (bool) – if set to True [b offline].
GetSiblings
id
Gets the Siblings for an object.
id (SvnObjectId) – The object we’re interested in.
list[SvnObjectInfo]
The list of siblings.
GetChildren
parentId
Gets the Children for an object. You can pass the result of CreateObjectID(nProjectHandle, Guid.Empty) for the project top level nodes.
parentId (SvnObjectId) – The parent we’re interested in.
list[SvnObjectInfo]
The list of children.
GetParentUrl
url
Gets the parent Url. Handles subversion PEG revisions.
url (Uri) – The Url.
Uri
The parent Url, or null if the URL has no local path.
CleanObjectAtRevisionContext
objectRevisionContext
Cleans the temporary projects used for the object at revision context. This is used in SvnProjectServices.GetObjectAtRevision and SvnRemoteServices.GetObjectAtRevision.
objectRevisionContext (Guid) – The object revision context.
GetObjectIdType
id
Gets the type of the object id.
id (SvnObjectId) – The id.
SvnItemType
GetAnchorType
id
Gets the type of the anchor.
id (SvnObjectId) – The id.
SvnObjectIdAnchorType
GetObjectGuid
id
bResolve=False
Gets the object GUID for a given object ID.
id (SvnObjectId) – The id.
bResolve (bool) – if set to True, allows resolving the object ID for SvnObjectIdAnchorType.Location.
Guid
The GUID of the object ID, or Guid.Empty for the Root, or null.
GetPsNode
id
bResolve=False
Gets the PS Node for a given object ID.
id (SvnObjectId) – The id.
bResolve (bool) – if set to True, allows resolving the object ID for SvnObjectIdAnchorType.Location.
PSNode
The PS Node (possibly SvnRemotePSNode) or null.
GetObjectPath
id
bResolve=False
Gets the object path.
id (SvnObjectId) – The id.
bResolve (bool) – if set to True, allows resolution of the path for SvnObjectIdAnchorType.Node.
str
The local relative path of the object ID within the working copy, or the url for remote PS nodes, or the empty string for the Root, or null.
GetOnDiskPathes
id
bResolve=False
Gets the on disk pathes.
id (SvnObjectId) – The id.
bResolve (bool) – if set to True [b resolve].
list[str]
The list of on-disk pathes.
CreateObjectId
nProjectHandle
stRelPath
type
Creates an object id anchored at the given rel path using the given type.
nProjectHandle (int) – The project handle.
stRelPath (str) – The rel path.
type (SvnItemType) – The type.
SvnObjectId
The object ID.
IsLocal
id
Determines whether the specified id is local.
id (SvnObjectId) – The id.
bool
True if the specified id is local; otherwise, False.
GetParent
id
Gets the parent.
id (SvnObjectId) – The id.
SvnObjectId
The parent Id, or null if the ID is a root ID.
GetItemType
id
Gets the type of the id.
id (SvnObjectId) – The id.
SvnItemType
GetAnchorTypes
id
Gets the anchor types.
id (SvnObjectId) – The id.
SvnObjectIdAchorType
ConsolidateStatusInfos
infos
bKeepOriginalInfos=False
Consolidates the status infos into exactly one per object. It merges Directory and file infos for the node, and removes infos for other artifacts (like conflict files). Use it for user display.
infos (list[SvnStatusInfo]) – The list of status infos. This list may be enumerated multiple times.
bKeepOriginalInfos (bool) – if set to True, the original status infos which are used during synthesizing are not deleted, but returned together with the synthesized ones.
list[SvnStatusInfo]
The consolidated list of status infos.
CreateSynthesized
id
Creates the synthesized object ID for SvnItemType.ObjectData and SvnItemType.ObjectDirectory IDs.
id (SvnObjectId) – The id.
SvnObjectId
The synthesized object ID.
CreateSvnTarget
urlWithoutPeg
revision=None
Creates a new SVN target out of the given urlWithoutPeg and revision.
urlWithoutPeg (Uri) – The URL without peg.
revision (SvnRevision) – The revision. This is optional, if it is omitted, SvnRevisionType.None is used.
SvnUrlTarget
The SVN target.
ParseUrlWithPegRevision
stUrlWithPeg
Parses the URL with peg revision.
stUrlWithPeg (str) – The URL string with peg.
SvnUrlTarget
A SvnUrlTarget object.
ClearAuthenticationData
locations
Clears the subversion authentication data from your machine. The next time the plugin contacts the Subversion repository, the credentials will be prompted again.
locations (AuthenticationDataCacheLocations) – The locations of the cache to clear.
property
ExistingAuthenticationDataLocations
Gets a value indicating whether and where cached authentication data exists.
AuthenticationDataCacheLocations
The AuthenticationDataCacheLocations describing whether and where cached authentication data exists