Class DiagnosticsRelayApi

Inheritance

System.Object

DiagnosticsRelayApi

Implements

IDiagnosticsRelayApi

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: iMobileDevice.DiagnosticsRelay

Assembly: iMobileDevice-net.dll

Syntax

public class DiagnosticsRelayApi : IDiagnosticsRelayApi

Constructors

| Improve this Doc View Source

DiagnosticsRelayApi(ILibiMobileDevice)

Declaration

public DiagnosticsRelayApi(ILibiMobileDevice parent)

Parameters

Type	Name	Description
ILibiMobileDevice	parent

Properties

| Improve this Doc View Source

Parent

Declaration

public ILibiMobileDevice Parent { get; }

Property Value

Type	Description
ILibiMobileDevice

Methods

| Improve this Doc View Source

diagnostics_relay_client_free(IntPtr)

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

Declaration

public virtual DiagnosticsRelayError diagnostics_relay_client_free(IntPtr client)

Parameters

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

Returns

Type	Description
DiagnosticsRelayError	DIAGNOSTICS_RELAY_E_SUCCESS on success, DIAGNOSTICS_RELAY_E_INVALID_ARG when one of client or client->parent is invalid, or DIAGNOSTICS_RELAY_E_UNKNOWN_ERROR when the was an error freeing the parent property_list_service client.

| Improve this Doc View Source

diagnostics_relay_client_new(iDeviceHandle, LockdownServiceDescriptorHandle, out DiagnosticsRelayClientHandle)

Connects to the diagnostics_relay service on the specified device.

Declaration

public virtual DiagnosticsRelayError diagnostics_relay_client_new(iDeviceHandle device, LockdownServiceDescriptorHandle service, out DiagnosticsRelayClientHandle client)

Parameters

Type	Name	Description
iDeviceHandle	device	The device to connect to.
LockdownServiceDescriptorHandle	service	The service descriptor returned by lockdownd_start_service.
DiagnosticsRelayClientHandle	client	Reference that will point to a newly allocated diagnostics_relay_client_t upon successful return.

Returns

Type	Description
DiagnosticsRelayError	DIAGNOSTICS_RELAY_E_SUCCESS on success, DIAGNOSTICS_RELAY_E_INVALID_ARG when one of the parameters is invalid, or DIAGNOSTICS_RELAY_E_MUX_ERROR when the connection failed.

| Improve this Doc View Source

diagnostics_relay_client_start_service(iDeviceHandle, out DiagnosticsRelayClientHandle, String)

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

Declaration

public virtual DiagnosticsRelayError diagnostics_relay_client_start_service(iDeviceHandle device, out DiagnosticsRelayClientHandle client, string label)

Parameters

Type	Name	Description
iDeviceHandle	device	The device to connect to.
DiagnosticsRelayClientHandle	client	Pointer that will point to a newly allocated diagnostics_relay_client_t upon successful return. Must be freed using diagnostics_relay_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
DiagnosticsRelayError	DIAGNOSTICS_RELAY_E_SUCCESS on success, or an DIAGNOSTICS_RELAY_E_* error code otherwise.

| Improve this Doc View Source

diagnostics_relay_goodbye(DiagnosticsRelayClientHandle)

Sends the Goodbye request signaling the end of communication.

Declaration

public virtual DiagnosticsRelayError diagnostics_relay_goodbye(DiagnosticsRelayClientHandle client)

Parameters

Type	Name	Description
DiagnosticsRelayClientHandle	client	The diagnostics_relay client

Returns

Type	Description
DiagnosticsRelayError	DIAGNOSTICS_RELAY_E_SUCCESS on success, DIAGNOSTICS_RELAY_E_INVALID_ARG when client is NULL, DIAGNOSTICS_RELAY_E_PLIST_ERROR if the device did not acknowledge the request

| Improve this Doc View Source

diagnostics_relay_query_ioregistry_entry(DiagnosticsRelayClientHandle, String, String, out PlistHandle)

Declaration

public virtual DiagnosticsRelayError diagnostics_relay_query_ioregistry_entry(DiagnosticsRelayClientHandle client, string name, string classname, out PlistHandle result)

Parameters

Type	Name	Description
DiagnosticsRelayClientHandle	client
System.String	name
System.String	classname
PlistHandle	result

Returns

Type	Description
DiagnosticsRelayError

| Improve this Doc View Source

diagnostics_relay_query_ioregistry_plane(DiagnosticsRelayClientHandle, String, out PlistHandle)

Declaration

public virtual DiagnosticsRelayError diagnostics_relay_query_ioregistry_plane(DiagnosticsRelayClientHandle client, string plane, out PlistHandle result)

Parameters

Type	Name	Description
DiagnosticsRelayClientHandle	client
System.String	plane
PlistHandle	result

Returns

Type	Description
DiagnosticsRelayError

| Improve this Doc View Source

diagnostics_relay_query_mobilegestalt(DiagnosticsRelayClientHandle, PlistHandle, out PlistHandle)

Declaration

public virtual DiagnosticsRelayError diagnostics_relay_query_mobilegestalt(DiagnosticsRelayClientHandle client, PlistHandle keys, out PlistHandle result)

Parameters

Type	Name	Description
DiagnosticsRelayClientHandle	client
PlistHandle	keys
PlistHandle	result

Returns

Type	Description
DiagnosticsRelayError

| Improve this Doc View Source

diagnostics_relay_request_diagnostics(DiagnosticsRelayClientHandle, String, out PlistHandle)

Shutdown of the device and optionally show a user notification.

Declaration

public virtual DiagnosticsRelayError diagnostics_relay_request_diagnostics(DiagnosticsRelayClientHandle client, string type, out PlistHandle diagnostics)

Parameters

Type	Name	Description
DiagnosticsRelayClientHandle	client	The diagnostics_relay client
System.String	type
PlistHandle	diagnostics

Returns

Type	Description
DiagnosticsRelayError	DIAGNOSTICS_RELAY_E_SUCCESS on success, DIAGNOSTICS_RELAY_E_INVALID_ARG when client is NULL, DIAGNOSTICS_RELAY_E_PLIST_ERROR if the device did not acknowledge the request

| Improve this Doc View Source

diagnostics_relay_restart(DiagnosticsRelayClientHandle, DiagnosticsRelayAction)

Restart the device and optionally show a user notification.

Declaration

public virtual DiagnosticsRelayError diagnostics_relay_restart(DiagnosticsRelayClientHandle client, DiagnosticsRelayAction flags)

Parameters

Type	Name	Description
DiagnosticsRelayClientHandle	client	The diagnostics_relay client
DiagnosticsRelayAction	flags	A binary flag combination of DIAGNOSTICS_RELAY_ACTION_FLAG_WAIT_FOR_DISCONNECT to wait until diagnostics_relay_client_free() disconnects before execution and DIAGNOSTICS_RELAY_ACTION_FLAG_DISPLAY_FAIL to show a "FAIL" dialog or DIAGNOSTICS_RELAY_ACTION_FLAG_DISPLAY_PASS to show an "OK" dialog

Returns

Type	Description
DiagnosticsRelayError	DIAGNOSTICS_RELAY_E_SUCCESS on success, DIAGNOSTICS_RELAY_E_INVALID_ARG when client is NULL, DIAGNOSTICS_RELAY_E_PLIST_ERROR if the device did not acknowledge the request

| Improve this Doc View Source

diagnostics_relay_shutdown(DiagnosticsRelayClientHandle, DiagnosticsRelayAction)

Shutdown of the device and optionally show a user notification.

Declaration

public virtual DiagnosticsRelayError diagnostics_relay_shutdown(DiagnosticsRelayClientHandle client, DiagnosticsRelayAction flags)

Parameters

Type	Name	Description
DiagnosticsRelayClientHandle	client	The diagnostics_relay client
DiagnosticsRelayAction	flags	A binary flag combination of DIAGNOSTICS_RELAY_ACTION_FLAG_WAIT_FOR_DISCONNECT to wait until diagnostics_relay_client_free() disconnects before execution and DIAGNOSTICS_RELAY_ACTION_FLAG_DISPLAY_FAIL to show a "FAIL" dialog or DIAGNOSTICS_RELAY_ACTION_FLAG_DISPLAY_PASS to show an "OK" dialog

Returns

Type	Description
DiagnosticsRelayError	DIAGNOSTICS_RELAY_E_SUCCESS on success, DIAGNOSTICS_RELAY_E_INVALID_ARG when client is NULL, DIAGNOSTICS_RELAY_E_PLIST_ERROR if the device did not acknowledge the request

| Improve this Doc View Source

diagnostics_relay_sleep(DiagnosticsRelayClientHandle)

Puts the device into deep sleep mode and disconnects from host.

Declaration

public virtual DiagnosticsRelayError diagnostics_relay_sleep(DiagnosticsRelayClientHandle client)

Parameters

Type	Name	Description
DiagnosticsRelayClientHandle	client	The diagnostics_relay client

Returns

Type	Description
DiagnosticsRelayError	DIAGNOSTICS_RELAY_E_SUCCESS on success, DIAGNOSTICS_RELAY_E_INVALID_ARG when client is NULL, DIAGNOSTICS_RELAY_E_PLIST_ERROR if the device did not acknowledge the request

Implements

IDiagnosticsRelayApi