Difference between revisions of "Best Practices"

From iPhone Development Wiki
Jump to: navigation, search
(Packages: Moving this over to the packaging page.)
m (Applications and Tweaks)
Line 2: Line 2:
  
 
== Applications and Tweaks ==
 
== Applications and Tweaks ==
* Avoid referring to <code>/var/mobile</code> directly - use <code>NSHomeDirectory()</code> if your code is running as mobile!
+
* <code>NSHomeDirectory()</code> doesn't guarantee that it will return <code>/var/mobile</code>, especially from within sandboxed processes.
 
** If your code is running as root, use extra caution when writing files that mobile can access - you might break the file's access permissions.
 
** If your code is running as root, use extra caution when writing files that mobile can access - you might break the file's access permissions.
 
** App Store apps will return their sandbox data path from <code>NSHomeDirectory()</code>.
 
** App Store apps will return their sandbox data path from <code>NSHomeDirectory()</code>.
Line 8: Line 8:
 
* You should consider the UDID deprecated like Apple has for some time, but if you need the device's UDID, use [[libMobileGestalt.dylib]].
 
* You should consider the UDID deprecated like Apple has for some time, but if you need the device's UDID, use [[libMobileGestalt.dylib]].
 
* If you need to use singletons, see [[singleton pattern]] for advice.
 
* If you need to use singletons, see [[singleton pattern]] for advice.
* If you need to respring from a tweak and you are targeting iOS 6 - 7, kill backboardd instead of SpringBoard. Killing SpringBoard has been known to cause some issues regarding the backlight. For iOS 8 and newer, if possible, use <code>-[HBRespringController respring]</code> from [https://github.com/hbang/libcephei/blob/master/HBRespringController.x libcephei] for a more appropriate way to respring. Simply killing the processes can destroy battery usage data (the feature since iOS 8) of the user.
+
* If you need to respring from a tweak and you are targeting iOS 6 - 7, kill backboardd instead of SpringBoard. Killing SpringBoard has been known to cause some issues regarding the backlight. For iOS 8 and newer, if possible, use <code>-[HBRespringController respring]</code> from [https://github.com/hbang/libcephei/blob/master/HBRespringController.x libcephei] for a more appropriate way to respring. Simply killing the processes can destroy battery usage data (the feature since iOS 8).

Revision as of 15:38, 28 May 2021

Use the following guidelines to avoid your package or app being fragile and to increase the chances of it being accepted by a community host.

Applications and Tweaks

  • NSHomeDirectory() doesn't guarantee that it will return /var/mobile, especially from within sandboxed processes.
    • If your code is running as root, use extra caution when writing files that mobile can access - you might break the file's access permissions.
    • App Store apps will return their sandbox data path from NSHomeDirectory().
  • See MobileSubstrate Pitfalls for additional guidelines regarding tweaks.
  • You should consider the UDID deprecated like Apple has for some time, but if you need the device's UDID, use libMobileGestalt.dylib.
  • If you need to use singletons, see singleton pattern for advice.
  • If you need to respring from a tweak and you are targeting iOS 6 - 7, kill backboardd instead of SpringBoard. Killing SpringBoard has been known to cause some issues regarding the backlight. For iOS 8 and newer, if possible, use -[HBRespringController respring] from libcephei for a more appropriate way to respring. Simply killing the processes can destroy battery usage data (the feature since iOS 8).