Skip to main content

%Atelier.v1.Utils.Extension

Class %Atelier.v1.Utils.Extension Extends %RegisteredObject [ Owner = {%Developer} ]

Methods​

GetMenusExecute​

ClassMethod GetMenusExecute(ByRef qHandle As %Binary, pMenuType As %String = "", pInternalName As %String = "", pSelectedText As %String = "") As %Status

For use from the Query API Through DocDB ExecuteQuery, items (a JSON string) is automatically converted to a nested object.

GetMenusFetch​

ClassMethod GetMenusFetch(ByRef qHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) As %Status [ PlaceAfter = ExtensionMenusExecute ]

GetMenusClose​

ClassMethod GetMenusClose(ByRef qHandle As %Binary) As %Status [ PlaceAfter = ExtensionMenusExecute ]

GetMenuHelper​

ClassMethod GetMenuHelper(pMenuType As %String, pInternalName As %String, pSelectedText As %String, Output pMenuPart As %DynamicObject) As %Status

Core code for getting menus

UserActionExecute​

ClassMethod UserActionExecute(ByRef qHandle As %Binary, pSystem As %Boolean, pAction As %String, pInternalName As %String, pSelectedText As %String) As %Status

For use from the Query API Submits a user action in a Studio Extension

UserActionFetch​

ClassMethod UserActionFetch(ByRef qHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) As %Status [ PlaceAfter = UserActionExecute ]

UserActionClose​

ClassMethod UserActionClose(ByRef qHandle As %Binary) As %Status [ PlaceAfter = UserActionExecute ]

AfterUserActionExecute​

ClassMethod AfterUserActionExecute(ByRef qHandle As %Binary, pSystem As %Boolean, pAction As %String, pInternalName As %String, pAnswer As %Integer, pMessage As %String) As %Status

For use from the Query API Handles a user's response after a user action in a Studio Extension

AfterUserActionFetch​

ClassMethod AfterUserActionFetch(ByRef qHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) As %Status [ PlaceAfter = AfterUserActionExecute ]

AfterUserActionClose​

ClassMethod AfterUserActionClose(ByRef qHandle As %Binary) As %Status [ PlaceAfter = AfterUserActionExecute ]

GetStatusExecute​

ClassMethod GetStatusExecute(ByRef qHandle As %Binary, pInternalNames As %String) As %Status

For use from the Query API Gets status of one or more (comma-separated) items May be multiple items to reduce network traffic if refactoring/etc. would edit many files at the same time.

GetStatusFetch​

ClassMethod GetStatusFetch(ByRef qHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) As %Status [ PlaceAfter = GetStatusExecute ]

GetStatusClose​

ClassMethod GetStatusClose(ByRef qHandle As %Binary) As %Status [ PlaceAfter = GetStatusExecute ]

ExtensionEnabled​

ClassMethod ExtensionEnabled() As %Boolean [ SqlProc ]

Returns 0 if no source control class is configured in the current namespace, and 1 if one is.

InitializeSourceControl​

ClassMethod InitializeSourceControl() As %Status [ Internal, Private ]

Initializes the Source Control object. Returns an error status if there was an error doing so.

ExtensionDocName​

ClassMethod ExtensionDocName(pDocName As %String) As %String [ Internal, Private ]

ExtensionDocName Up cases DocName type, the way Studio extensions expect to deal with.
If there are multiple document names, all extensions are up-cased.
CSP files (those starting with a forward slash) are an exception - the case is unchanged, to match Studio's behavior.

AppendArray​

ClassMethod AppendArray(pTargetArray As %DynamicArray, pSourceArray As %DynamicArray) As %DynamicArray [ Internal, Private ]

Appends a %DynamicArray (pSourceArray) to another (pTargetArray); returns pTargetArray.

AppendDocument​

ClassMethod AppendDocument(pResponseObject As %DynamicObject, pInternalName As %String) As %Status [ Internal, Private ]

Sets the text of the document named by pInternalName as the doc property of pResponseObject.

AppendStatusContent​

ClassMethod AppendStatusContent(pResponseObject As %DynamicObject, pStatus As %Status) [ Internal, Private ]

Sets the error text of pStatus as the errorText property of pResponseObject if pStatus is an error.