dbus-sdk
Version:
A Node.js SDK for interacting with DBus, enabling seamless service calling and exposure with TypeScript support
36 lines • 1.85 kB
TypeScript
import { LocalInterface } from '../../LocalInterface';
/**
* A class representing the DBus Introspectable interface.
* This interface provides introspection capabilities for DBus objects, allowing clients to query
* the structure (methods, properties, signals) of a DBus object as XML data.
* Implements the 'org.freedesktop.DBus.Introspectable' interface.
*/
export declare class IntrospectableInterface extends LocalInterface {
#private;
/**
* Constructor for the IntrospectableInterface.
* Initializes the interface with the name 'org.freedesktop.DBus.Introspectable'
* and defines the 'Introspect' method to return XML introspection data.
*/
constructor();
/**
* Generates the full introspection XML for a given object path.
* Combines the DOCTYPE header with the formatted XML content for the specified path.
*
* @param path - Optional object path to generate introspection XML for.
* @param inputObjectPaths - Optional list of object paths to consider for introspection.
* @returns The complete introspection XML string, including the DOCTYPE header.
*/
getIntrospectXML(path?: string, inputObjectPaths?: string[]): string;
/**
* Formats the introspection data into XML for a given object path.
* Builds an XML representation of the DBus object's structure, including interfaces,
* methods, properties, signals, and sub-nodes, using the xml2js Builder.
*
* @param path - Optional object path to format introspection XML for.
* @param inputObjectPaths - Optional list of object paths to consider for introspection.
* @returns The formatted introspection XML string (without DOCTYPE header).
*/
formatIntrospectXML(path?: string, inputObjectPaths?: string[]): string;
}
//# sourceMappingURL=IntrospectableInterface.d.ts.map