ScriptSvnCachingAsynchroneousAcceptfilter¶

class ScriptSvnCachingAsynchroneousAcceptfilter.SvnAsynchroneousAcceptFilterCache¶

Bases: object

This instance encapsulates an UrlAcceptFilter with caching of results and asynchroneous processing in the background. Currently, the cache has no expiring - it is expected that a dialog window uses this instance as long as it is opened, and then it is garbage collected. Use the componend manager to create a new instance, the default implementation has the typeguid {1cba34cc-848f-451a-a855-01384210de90}.

Instances of this interface are fully thread safe. The URL accept filter is called in a background thread, and the FilterProcessed event is always scheduled to the primary thread.

property UrlAcceptFilter¶

[Delegate] Gets or sets the URL accept filter. If no filter is set, all URLs are denied with a generic error message. Setting a new filter also purges all cache entries.

Return type:: SvnUrlAcceptFilterArgs

TriggerCheck()¶

Sets a new revision to check.

Parameters:: revision (SvnRevision) – The revision.

property CurrentUrl¶

The current url.

Return type:: Uri

property CurrentRevision¶

The current revision.

Return type:: SvnRevision

property InProgress¶

Gets a value indicating whether currently a check is in progress.

Return type:: bool
Returns:: True if the check is in progress; otherwise, False.

property Accepted¶

Gets a value indicating whether this SvnAsynchroneousAcceptFilterCache is accepted.

Return type:: bool
Returns:: True if accepted; otherwise, False.

property Description¶

Gets the description. This is an error message if the url is not accepted, or sometimes some more detailed description when the url is accepted.

Return type:: str

StatusUpdated(AcceptFilterUpdateEventArgs)¶

[Delegate] Occurs whenever the status is updated.

Accepted or Description changes.

property AcceptedTarget¶

Gets the accepted target, or null if either no target was accepted yet, or a check is currently in progress.

Return type:: SvnUrlTarget

class ScriptSvnCachingAsynchroneousAcceptfilter.AcceptFilterUpdateEventArgs¶

Bases: object

Url()¶

The current url.

Return type:: Uri

Revision()¶

The current revision.

Return type:: SvnRevision

InProgress()¶

Gets a value indicating whether currently a check is in progress.

Return type:: bool
Returns:: True if the check is in progress; otherwise, False.

Accepted()¶

Gets a value indicating whether this SvnAsynchroneousAcceptFilterCache is accepted.

Return type:: bool
Returns:: True if accepted; otherwise, False.

Description()¶

Gets the description. This is an error message if the url is not accepted, or sometimes some more detailed description when the url is accepted.

Return type:: str

AcceptFilterUpdateEventArgs(url, revision, bInProgress, bAccepted, stDescription)¶

Initializes a new instance of the AcceptFilterUpdateEventArgs class.

Parameters:

url (Uri) – The URL.
revision (SvnRevision) – The revision.
bInProgress (bool) – if set to True, the check is in progress.
bAccepted (bool) – if set to True, the url was accepted.
stDescription (str) – The description.