Platforms to show: All Mac Windows Linux Cross-Platform
IOPMAssertionMBS class
Type | Topic | Plugin | Version | macOS | Windows | Linux | Console & Web | iOS |
class | Power | MBS MacOSX Plugin | 13.2 | Yes | No | No | Yes, macOS only | No |
Notes: You use this class to block a Mac from sleeping display, disk or whole machine.
- 10 properties
- property Details as String
- property Handle as Integer
- property HumanReadableReason as String
- property Level as Integer
- property LocalizationBundlePath as String
- property Name as String
- property RetainCount as Integer
- property Timeout as Double
- property TimeoutAction as String
- property Type as String
- 3 methods
- method Constructor(type as string, level as Integer, name as string)
- method Properties as Dictionary
- method SetProperty(key as string, value as Variant) as boolean
- 7 shared methods
- shared method AssertionsByProcess as Dictionary
- shared method AssertionsStatus as Dictionary
- shared method CreateWithDescription(AssertionType as string, Name as string, Details as string = "", HumanReadableReason as string = "", LocalizationBundlePath as string = "", Timeout as Double = 0, TimeoutAction as string = "") as IOPMAssertionMBS
- shared method CreateWithHandle(Handle as Integer) as IOPMAssertionMBS
- shared method CreateWithName(type as string, level as Integer, name as string) as IOPMAssertionMBS
- shared method CreateWithProperties(AssertionProperties as Dictionary) as IOPMAssertionMBS
- shared method DeclareUserActivity(AssertionName as string, userType as Integer, byref AssertionID as Integer) as Integer
- 22 constants
- const kIOPMAssertionDetailsKey = "Details"
- const kIOPMAssertionFrameworkIDKey = "FrameworkBundleID"
- const kIOPMAssertionHumanReadableReasonKey = "HumanReadableReason"
- const kIOPMAssertionLevelKey = "AssertLevel"
- const kIOPMAssertionLevelOff = 0
- const kIOPMAssertionLevelOn = 255
- const kIOPMAssertionLocalizationBundlePathKey = "BundlePath"
- const kIOPMAssertionNameKey = "AssertName"
- const kIOPMAssertionPlugInIDKey = "PlugInBundleID"
- const kIOPMAssertionRetainCountKey = "RetainCount"
- const kIOPMAssertionTimeoutActionKey = "TimeoutAction"
- const kIOPMAssertionTimeoutActionLog = "TimeoutActionLog"
- const kIOPMAssertionTimeoutActionRelease = "TimeoutActionRelease"
- const kIOPMAssertionTimeoutActionTurnOff = "TimeoutActionTurnOff"
- const kIOPMAssertionTimeoutKey = "TimeoutSeconds"
- const kIOPMAssertionTypeKey = "AssertType"
- const kIOPMAssertionTypePreventSystemSleep = "PreventSystemSleep"
- const kIOPMAssertionTypePreventUserIdleDisplaySleep = "PreventUserIdleDisplaySleep"
- const kIOPMAssertionTypePreventUserIdleSystemSleep = "PreventUserIdleSystemSleep"
- const kIOPMAssertPreventDiskIdle = "PreventDiskIdle"
User Activity Constants
Constant | Value | Description |
---|---|---|
kIOPMUserActiveLocal | 0 |
User is local on the system |
kIOPMUserActiveRemote | 1 |
Remote User connected to the system. |
This class has no sub classes.
Some examples which use this class:
Blog Entries
The items on this page are in the following plugins: MBS MacOSX Plugin.
Links
MBS Xojo PDF Plugins