Interface

NM-1.0 ▶ NM ▶ VpnEditorPlugin ▶ Interface

Interface for implementing VpnEditorPlugin. Contains only the virtual methods that need to be implemented.

interface Interface {
    vfunc_export_to_file(path: string, connection: NM.Connection): boolean;
    vfunc_get_capabilities(): NM.VpnEditorPluginCapability;
    vfunc_get_editor(connection: NM.Connection): NM.VpnEditor;
    vfunc_get_suggested_filename(connection: NM.Connection): string;
    vfunc_get_vt(out_vt_size: number): VpnEditorPluginVT;
    vfunc_notify_plugin_info_set(plugin_info: NM.VpnPluginInfo): void;
}

Hierarchy (View Summary)

Interface
- NM.VpnEditorPlugin

Index

Methods

vfunc_export_to_file vfunc_get_capabilities vfunc_get_editor vfunc_get_suggested_filename vfunc_get_vt vfunc_notify_plugin_info_set

Methods

`Virtual`vfunc_export_to_file

vfunc_export_to_file(path: string, connection: NM.Connection): boolean
Export the given connection to the specified path. Return true on success. On error, return false and set error with additional error information. Note that error can be null, in which case no additional error information should be provided.
Parameters
- path: string
- connection: NM.Connection
Returns boolean
- Defined in nm-1.0/nm-1.0.d.ts:42489

`Virtual`vfunc_get_capabilities

vfunc_get_capabilities(): NM.VpnEditorPluginCapability
returns a bitmask of capabilities.

Returns NM.VpnEditorPluginCapability
- Defined in nm-1.0/nm-1.0.d.ts:42494

`Virtual`vfunc_get_editor

vfunc_get_editor(connection: NM.Connection): NM.VpnEditor
returns an NM.VpnEditor, pre-filled with values from connection if non-null.
Parameters
- connection: NM.Connection
  the NM.Connection to be edited
Returns NM.VpnEditor
- Defined in nm-1.0/nm-1.0.d.ts:42501

`Virtual`vfunc_get_suggested_filename

vfunc_get_suggested_filename(connection: NM.Connection): string
For a given connection, return a suggested file name. Returned value will be null or a suggested file name to be freed by the caller.
Parameters
- connection: NM.Connection
Returns string
- Defined in nm-1.0/nm-1.0.d.ts:42509

`Virtual`vfunc_get_vt

vfunc_get_vt(out_vt_size: number): VpnEditorPluginVT
return a virtual function table to implement further functions in the plugin, without requiring to update libnm. Used by nm_vpn_editor_plugin_get_vt().
Parameters
- out_vt_size: number
Returns VpnEditorPluginVT
- Defined in nm-1.0/nm-1.0.d.ts:42516

`Virtual`vfunc_notify_plugin_info_set

vfunc_notify_plugin_info_set(plugin_info: NM.VpnPluginInfo): void
A callback to be called when the plugin info is set.
Parameters
- plugin_info: NM.VpnPluginInfo
Returns void
- Defined in nm-1.0/nm-1.0.d.ts:42522