Sha256: ec93d54025543e639a5d3a6faef57ac530f65703a52df5056a3ff7190588d55f
Contents?: true
Size: 1.92 KB
Versions: 14
Compression:
Stored size: 1.92 KB
Contents
<?xml version = "1.0"?>
<?xml-stylesheet type="text/xsl" href="pb_help.xsl"?>
<API>
<MODULE name="LogCapture" parent="Rho" productException='eb'>
<HELP_OVERVIEW>The LogCapture class is used for capturing logging events.
</HELP_OVERVIEW>
<MORE_HELP>
## Enabling the API
In order to use this API you must include the following extension in your `build.yml`
:::ruby
extensions: ["logCapture"]
## JavaScript Usage
Be sure to review the [JavaScript API Usage](/guide/api_js) guide for important information about using this API in JavaScript
## Ruby Usage
Be sure to review the [Ruby API Usage](/guide/api_ruby) guide for important information about using this API in Ruby
</MORE_HELP>
<PROPERTIES access="STATIC" generateAccessors="true">
<PROPERTY name="excludeCategories" type="STRING" default="">
<DESC>Comma-separated list of excluded log categories.</DESC>
</PROPERTY>
<PROPERTY name="maxLines" type="INTEGER" default="1024">
<DESC>Maximum number of captured lines.</DESC>
</PROPERTY>
</PROPERTIES>
<METHODS access="STATIC">
<METHOD name="start">
<DESC>Start capture log events.</DESC>
</METHOD>
<METHOD name="stop">
<DESC>Stop capture log events.</DESC>
</METHOD>
<METHOD name="clear">
<DESC>Clear captured events.</DESC>
</METHOD>
<METHOD name="numLines">
<DESC>Return number of captured lines.</DESC>
<RETURN type="INTEGER"/>
</METHOD>
<METHOD name="read">
<DESC>Read captured items.</DESC>
<RETURN type="STRING"/>
</METHOD>
</METHODS>
<VER_INTRODUCED>4.0.0</VER_INTRODUCED>
<PLATFORM>WM, CE, Win32, Android, iOS, WP8</PLATFORM>
</MODULE>
</API>
Version data entries
14 entries across 14 versions & 1 rubygems