<HIDEvent> Protocol Reference

Base class for a synchronization event sent from the server. More...

#include <HIDProgressListener.h>

Inheritance diagram for <HIDEvent>:

Properties
NSString *	ID
	Returns the type identifier of this event.
NSArray *	parameters
	Returns the metadata parameters.

Detailed Description

Base class for a synchronization event sent from the server.

The event identifier may be used to determine the expected event data.

Property Documentation

ID

- (NSString*) ID

readatomicassign

Returns the type identifier of this event.

Returns

The type identifier of this event.

parameters

- (NSArray*) parameters

readatomicassign

Returns the metadata parameters.

Returns

The event metadata parameters.

A HIDProgressEvent may contain the following HIDParameter ids:

• HID_PARAM_PROGRESSEVENT_MESSAGE: server synchronization progress event message
• HID_PARAM_PROGRESSEVENT_PERCENT: server synchronization progress percentage
• HID_PARAM_PROGRESSEVENT_LEVEL: server event importance (INFO, ERROR)

A HIDPasswordPromptEvent may contain the following HIDParameter ids:

• HID_PARAM_PASSWORD_PROGRESS_EVENT_KEY_LABEL: Provides a key label hint concerning the requested password
• HID_PARAM_PASSWORD_PROGRESS_EVENT_KEY_USAGE: Provides a key usage hint concerning the requested password
• HID_PARAM_PASSWORD_PROGRESS_EVENT_TYPE: Provides key protection policy type hint concerning the requested password (HID_PARAM_PASSWORD_PROGRESS_EVENT_TYPE_CONTAINER or HID_PARAM_PASSWORD_PROGRESS_EVENT_TYPE_KEY)