skuid.debug

This API provides debugging tools for those working with Nintex Apps pages using the v2 API. Because published pages can have several Nintex Apps pages, and thus several runtime contexts, within them, the debug API is used to query and search a variety of elements across all pages in the window context, i.e. all Nintex Apps pages within the current browser window.

This API is intended only to be used from a web browser's JavaScript console. It should not be used in production code, whether through snippets or other custom code. This API is likely to change, and there is no guaranteed level of support.

skuid.debug.pages(filter)

Queries all Page APIs (effectively, all Nintex Apps pages) in the current window context and returns an array of the results.

Arguments:	Returns:	Return type:
filter ( string ) -- If a filter is supplied, then only APIs that match the filter will be returned. The filter is applied to Page names, Page Component IDs and Page Record IDs. The filter is case-insensitive and partial matches are included in the result. For example, the filter value "host" will match a Page named "CORE-2228-Host"	All skuid page APIs in the window	Array

skuid.debug.page(filter)

Queries all Page APIs (effectively, all Nintex Apps pages) in the current window context and returns only the first result. A summary card is also printed to the console.

Arguments:	Returns:	Return type:
filter ( string ) -- If a filter is supplied, then only APIs that match the filter will be returned. The filter is applied to Page names, Page Component IDs and Page Record IDs. The filter is case-insensitive and partial matches are included in the result. For example, the filter value "host" will match a Page named "CORE-2228-Host"	The first skuid page API that matches the filter parameter	Object

skuid.debug.pageMap(filter)

Queries all Page APIs (effectively, all Nintex Apps pages) in the current window context and returns a dictionary object with page names as the keys.

Arguments:	Returns:	Return type:
filter ( string ) -- If a filter is supplied, then only APIs that match the filter will be returned. The filter is applied to Page names, Page Component IDs and Page Record IDs. The filter is case-insensitive and partial matches are included in the result. For example, the filter value "host" will match a Page named "CORE-2228-Host"	All skuid page APIs in the window	Object

skuid.debug.models(filter)

Queries all Models in the current window context and returns an array of the results.

Arguments:	Returns:	Return type:
filter ( string ) -- If a filter is supplied, then only Models that match the filter will be returned. A simple filter may include just a Model name. The filter is case-insensitive and partial matches are included in the results. The filter also supports a Page name filter prefix like so: PageName:ModelName . To return all child Models for a specific Page, leave the Model name blank: PageName:	All skuid.model.Model objects within all pages in the window	Array

skuid.debug.modelMap(filter)

Queries all Models in the current window context and returns a dictionary object with model ids as the keys.

Arguments:	Returns:	Return type:
filter ( string ) -- If a filter is supplied, then only Models that match the filter will be returned. A simple filter may include just a Model name. The filter is case-insensitive and partial matches are included in the results. The filter also supports a Page name filter prefix like so: PageName:ModelName . To return all child Models for a specific Page, leave the Model name blank: PageName:	All skuid.model.Model objects within all pages in the window	Array

skuid.debug.model(filter)

Queries all Models in the current window context and returns only the first result. A summary card is also printed to the console.

Arguments:	Returns:	Return type:
filter ( string ) -- If a filter is supplied, then only Models that match the filter will be returned. A simple filter may include just a Model name. The filter is case-insensitive and partial matches are included in the results. The filter also supports a Page name filter prefix like so: PageName:ModelName . To return all child Models for a specific Page, leave the Model name blank: PageName:	The first skuid.model.Model that matches the filter parameter	Object

skuid.debug.components(filter)

Queries all Components in the current window context and returns an array of the results.

Arguments:	Returns:	Return type:
filter ( string ) -- If a filter is supplied, then only Components that match the filter will be returned. A simple filter may include just a Component id. The filter is case-insensitive and partial matches are included in the results. The filter also supports a Page name filter prefix like so: PageName:ComponentId . To return all child Components for a specific Page, leave the Component id blank: PageName: . You may also include a Component Type filter as a postfix, like so: PageName:ComponentId:ComponentType . To return all components of a particular type you may leave the Page name and Component id filters blank, like so: ::ComponentType .	All skuid.component.Component objects within all pages in the window	Array

skuid.debug.componentMap(filter)

Queries all Components in the current window context and returns a dictionary object with component ids as the keys.

Arguments:	Returns:	Return type:
filter ( string ) -- If a filter is supplied, then only Components that match the filter will be returned. A simple filter may include just a Component id. The filter is case-insensitive and partial matches are included in the results. The filter also supports a Page name filter prefix like so: PageName:ComponentId . To return all child Components for a specific Page, leave the Component id blank: PageName: . You may also include a Component Type filter as a postfix, like so: PageName:ComponentId:ComponentType . To return all components of a particular type you may leave the Page name and Component id filters blank, like so: ::ComponentType .	All skuid.component.Component objects within all pages in the window	Object

skuid.debug.component(filter)

Queries all Models in the current window context and returns only the first result. A summary card is also printed to the console.

Arguments:	Returns:	Return type:
filter ( string ) -- If a filter is supplied, then only Components that match the filter will be returned. A simple filter may include just a Component id. The filter is case-insensitive and partial matches are included in the results. The filter also supports a Page name filter prefix like so: PageName:ComponentId . To return all child Components for a specific Page, leave the Component id blank: PageName: . You may also include a Component Type filter as a postfix, like so: PageName:ComponentId:ComponentType . To return all components of a particular type you may leave the Page name and Component id filters blank, like so: ::ComponentType .	The first skuid.component.Component that matches the filter parameter	Object

skuid.debug.actions

A namespace for Action Framework debugging functions. These functions are meant to be used at runtime from the browser console, and their result logs will be output to the console.

skuid.debug.actions.loggingOn()

Enables action logging in the browser console for the running user. If the user is using a browser that has Session Storage enabled, logging will remain enabled until the session is over, or the user disables it.

skuid.debug.actions.loggingOff()

Disables action logging in the browser console for the running user.

skuid.debug.actions.setTimeThreshold(milliseconds)

Sets the amount of time (in milliseconds) an action sequence is allowed to run before being considered "long running."

Arguments:
milliseconds ( number ) -- The number of milliseconds an action sequence is allowed to run before being considered "long running."