Interface IAccessibilityProvider

Namespace

SharpHook.Providers

Assembly

SharpHook.dll

Represents a provider of low-level macOS Accessibility API functionality.

public interface IAccessibilityProvider

Properties

AxPollFrequency

Gets or sets the frequency in seconds for polling the access to the macOS Accessibility API when the global hook is running. The default value is 1 second.

uint AxPollFrequency { get; set; }

Property Value

uint

The frequency in seconds for polling the access to the macOS Accessibility API when the global hook is running.

Remarks

On Windows and Linux, this property does nothing and always returns 0.

PromptUserIfAxApiDisabled

Gets or sets the value which indicates whether global hooks or event simulation should prompt the user when they try to request access to macOS Accessibility API, and it is disabled. The default value is true.

bool PromptUserIfAxApiDisabled { get; set; }

Property Value

bool

true if global hooks and event simulation should prompt the user for access to macOS Accessibility API when it is disabled. Otherwise, false.

Remarks

On Windows and Linux, this property does nothing and always returns false.

Methods

IsAxApiEnabled(bool)

Checks whether access to macOS Accessibility API is enabled for the process, optionally prompting the user if it is disabled.

bool IsAxApiEnabled(bool promptUserIfDisabled)

Parameters

promptUserIfDisabled bool

Prompt the user if access to macOS Accessibility API is disabled.

Returns

bool

true if access to macOS Accessibility API is enabled for the process which means that global hooks and event simulation can be used. Otherwise, false.

Remarks

On Windows and Linux, this method does nothing and always returns true.