Interface ISpringBoardServicesApi

Namespace: iMobileDevice.SpringBoardServices

Assembly: iMobileDevice-net.dll

Syntax

public interface ISpringBoardServicesApi

Properties

| Improve this Doc View Source

Parent

Gets or sets the which owns this iMobileDevice.SpringBoardServices.

Declaration

ILibiMobileDevice Parent { get; }

Property Value

Type	Description
ILibiMobileDevice

Methods

| Improve this Doc View Source

sbservices_client_free(IntPtr)

Disconnects an sbservices client from the device and frees up the sbservices client data.

Declaration

SpringBoardServicesError sbservices_client_free(IntPtr client)

Parameters

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

Returns

Type	Description
SpringBoardServicesError	SBSERVICES_E_SUCCESS on success, SBSERVICES_E_INVALID_ARG when client is NULL, or an SBSERVICES_E_* error code otherwise.

| Improve this Doc View Source

sbservices_client_new(iDeviceHandle, LockdownServiceDescriptorHandle, out SpringBoardServicesClientHandle)

Connects to the springboardservices service on the specified device.

Declaration

SpringBoardServicesError sbservices_client_new(iDeviceHandle device, LockdownServiceDescriptorHandle service, out SpringBoardServicesClientHandle client)

Parameters

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

Returns

Type	Description
SpringBoardServicesError	SBSERVICES_E_SUCCESS on success, SBSERVICES_E_INVALID_ARG when client is NULL, or an SBSERVICES_E_* error code otherwise.

| Improve this Doc View Source

sbservices_client_start_service(iDeviceHandle, out SpringBoardServicesClientHandle, String)

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

Declaration

SpringBoardServicesError sbservices_client_start_service(iDeviceHandle device, out SpringBoardServicesClientHandle client, string label)

Parameters

Type	Name	Description
iDeviceHandle	device	The device to connect to.
SpringBoardServicesClientHandle	client	Pointer that will point to a newly allocated sbservices_client_t upon successful return. Must be freed using sbservices_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
SpringBoardServicesError	SBSERVICES_E_SUCCESS on success, or an SBSERVICES_E_* error code otherwise.

| Improve this Doc View Source

sbservices_get_home_screen_wallpaper_pngdata(SpringBoardServicesClientHandle, ref IntPtr, ref UInt64)

Get the home screen wallpaper as PNG data.

Declaration

SpringBoardServicesError sbservices_get_home_screen_wallpaper_pngdata(SpringBoardServicesClientHandle client, ref IntPtr pngdata, ref ulong pngsize)

Parameters

Type	Name	Description
SpringBoardServicesClientHandle	client	The connected sbservices client to use.
System.IntPtr	pngdata	Pointer that will point to a newly allocated buffer containing the PNG data upon successful return. It is up to the caller to free the memory.
System.UInt64	pngsize	Pointer to a uint64_t that will be set to the size of the buffer pngdata points to upon successful return.

Returns

Type	Description
SpringBoardServicesError	SBSERVICES_E_SUCCESS on success, SBSERVICES_E_INVALID_ARG when client or pngdata are invalid, or an SBSERVICES_E_* error code otherwise.

| Improve this Doc View Source

sbservices_get_icon_pngdata(SpringBoardServicesClientHandle, String, ref IntPtr, ref UInt64)

Get the icon of the specified app as PNG data.

Declaration

SpringBoardServicesError sbservices_get_icon_pngdata(SpringBoardServicesClientHandle client, string bundleid, ref IntPtr pngdata, ref ulong pngsize)

Parameters

Type	Name	Description
SpringBoardServicesClientHandle	client	The connected sbservices client to use.
System.String	bundleid
System.IntPtr	pngdata	Pointer that will point to a newly allocated buffer containing the PNG data upon successful return. It is up to the caller to free the memory.
System.UInt64	pngsize	Pointer to a uint64_t that will be set to the size of the buffer pngdata points to upon successful return.

Returns

Type	Description
SpringBoardServicesError	SBSERVICES_E_SUCCESS on success, SBSERVICES_E_INVALID_ARG when client, bundleId, or pngdata are invalid, or an SBSERVICES_E_* error code otherwise.

| Improve this Doc View Source

sbservices_get_icon_state(SpringBoardServicesClientHandle, out PlistHandle, String)

Gets the icon state of the connected device.

Declaration

SpringBoardServicesError sbservices_get_icon_state(SpringBoardServicesClientHandle client, out PlistHandle state, string formatVersion)

Parameters

Type	Name	Description
SpringBoardServicesClientHandle	client	The connected sbservices client to use.
PlistHandle	state	Pointer that will point to a newly allocated plist containing the current icon state. It is up to the caller to free the memory.
System.String	formatVersion

Returns

Type	Description
SpringBoardServicesError	SBSERVICES_E_SUCCESS on success, SBSERVICES_E_INVALID_ARG when client or state is invalid, or an SBSERVICES_E_* error code otherwise.

| Improve this Doc View Source

sbservices_get_interface_orientation(SpringBoardServicesClientHandle, ref SpringBoardServicesInterfaceOrientation)

Gets the interface orientation of the device.

Declaration

SpringBoardServicesError sbservices_get_interface_orientation(SpringBoardServicesClientHandle client, ref SpringBoardServicesInterfaceOrientation interfaceOrientation)

Parameters

Type	Name	Description
SpringBoardServicesClientHandle	client	The connected sbservices client to use.
SpringBoardServicesInterfaceOrientation	interfaceOrientation

Returns

Type	Description
SpringBoardServicesError	SBSERVICES_E_SUCCESS on success, SBSERVICES_E_INVALID_ARG when client or state is invalid, or an SBSERVICES_E_* error code otherwise.

| Improve this Doc View Source

sbservices_set_icon_state(SpringBoardServicesClientHandle, PlistHandle)

Sets the icon state of the connected device.

Declaration

SpringBoardServicesError sbservices_set_icon_state(SpringBoardServicesClientHandle client, PlistHandle newstate)

Parameters

Type	Name	Description
SpringBoardServicesClientHandle	client	The connected sbservices client to use.
PlistHandle	newstate	A plist containing the new iconstate.

Returns

Type	Description
SpringBoardServicesError	SBSERVICES_E_SUCCESS on success, SBSERVICES_E_INVALID_ARG when client or newstate is NULL, or an SBSERVICES_E_* error code otherwise.