Interface IWebInspectorApi

Namespace: iMobileDevice.WebInspector

Assembly: iMobileDevice-net.dll

Syntax

public interface IWebInspectorApi

Properties

| Improve this Doc View Source

Parent

Gets or sets the which owns this iMobileDevice.WebInspector.

Declaration

ILibiMobileDevice Parent { get; }

Property Value

Type	Description
ILibiMobileDevice

Methods

| Improve this Doc View Source

webinspector_client_free(IntPtr)

Disconnects a webinspector client from the device and frees up the webinspector client data.

Declaration

WebInspectorError webinspector_client_free(IntPtr client)

Parameters

Type	Name	Description
System.IntPtr	client	The webinspector client to disconnect and free.

Returns

Type	Description
WebInspectorError	WEBINSPECTOR_E_SUCCESS on success, WEBINSPECTOR_E_INVALID_ARG when client is NULL, or an WEBINSPECTOR_E_* error code otherwise.

| Improve this Doc View Source

webinspector_client_new(iDeviceHandle, LockdownServiceDescriptorHandle, out WebInspectorClientHandle)

Connects to the webinspector service on the specified device.

Declaration

WebInspectorError webinspector_client_new(iDeviceHandle device, LockdownServiceDescriptorHandle service, out WebInspectorClientHandle client)

Parameters

Type	Name	Description
iDeviceHandle	device	The device to connect to.
LockdownServiceDescriptorHandle	service	The service descriptor returned by lockdownd_start_service.
WebInspectorClientHandle	client	Pointer that will point to a newly allocated webinspector_client_t upon successful return. Must be freed using webinspector_client_free() after use.

Returns

Type	Description
WebInspectorError	WEBINSPECTOR_E_SUCCESS on success, WEBINSPECTOR_E_INVALID_ARG when client is NULL, or an WEBINSPECTOR_E_* error code otherwise.

| Improve this Doc View Source

webinspector_client_start_service(iDeviceHandle, out WebInspectorClientHandle, String)

Starts a new webinspector service on the specified device and connects to it.

Declaration

WebInspectorError webinspector_client_start_service(iDeviceHandle device, out WebInspectorClientHandle client, string label)

Parameters

Type	Name	Description
iDeviceHandle	device	The device to connect to.
WebInspectorClientHandle	client	Pointer that will point to a newly allocated webinspector_client_t upon successful return. Must be freed using webinspector_client_free() after use.
System.String	label	The label to use for communication. Usually the program name. Pass NULL to disable sending the label in requests to lockdownd.

Returns

Type	Description
WebInspectorError	WEBINSPECTOR_E_SUCCESS on success, or an WEBINSPECTOR_E_* error code otherwise.

| Improve this Doc View Source

webinspector_receive(WebInspectorClientHandle, out PlistHandle)

Receives a plist from the service.

Declaration

WebInspectorError webinspector_receive(WebInspectorClientHandle client, out PlistHandle plist)

Parameters

Type	Name	Description
WebInspectorClientHandle	client	The webinspector client
PlistHandle	plist	The plist to store the received data

Returns

Type	Description
WebInspectorError	DIAGNOSTICS_RELAY_E_SUCCESS on success, DIAGNOSTICS_RELAY_E_INVALID_ARG when client or plist is NULL

| Improve this Doc View Source

webinspector_receive_with_timeout(WebInspectorClientHandle, out PlistHandle, UInt32)

Receives a plist using the given webinspector client.

Declaration

WebInspectorError webinspector_receive_with_timeout(WebInspectorClientHandle client, out PlistHandle plist, uint timeoutMs)

Parameters

Type	Name	Description
WebInspectorClientHandle	client	The webinspector client to use for receiving
PlistHandle	plist	pointer to a plist_t that will point to the received plist upon successful return
System.UInt32	timeoutMs

Returns

Type	Description
WebInspectorError	WEBINSPECTOR_E_SUCCESS on success, WEBINSPECTOR_E_INVALID_ARG when client or *plist is NULL, WEBINSPECTOR_E_PLIST_ERROR when the received data cannot be converted to a plist, WEBINSPECTOR_E_MUX_ERROR when a communication error occurs, or WEBINSPECTOR_E_UNKNOWN_ERROR when an unspecified error occurs.

| Improve this Doc View Source

webinspector_send(WebInspectorClientHandle, PlistHandle)

Sends a plist to the service.

Declaration

WebInspectorError webinspector_send(WebInspectorClientHandle client, PlistHandle plist)

Parameters

Type	Name	Description
WebInspectorClientHandle	client	The webinspector client
PlistHandle	plist	The plist to send

Returns

Type	Description
WebInspectorError	DIAGNOSTICS_RELAY_E_SUCCESS on success, DIAGNOSTICS_RELAY_E_INVALID_ARG when client or plist is NULL