LKMessage Class Reference
Inherits from | NSOperation |
Declared in | LKMessage.h LKMessage.m |
Overview
LKMessage executes LDAP requests and returns the results.
KVO-Compliant Properties
The LKMessage class is key-value coding (KVC) and key-value observing (KVO)
compliant for several of its properties in addition to the key-value coding
(KVC) and key-value observing (KVO) compliant properties of the
NSOperation
class. As needed, you can observe these properties to control
other parts of your application. The properties you can observe include the
following:
entries
– read-only propertyreferrals
– read-only propertymatchedDNs
– read-only property
Read the documentation for the NSOperation
class for information on
implementing observers in multi-threaded applications.
Tasks
Message information
-
messageType
The type of request the message was initialized to process.
property
Errors
-
errorCode
The numeric value of the error.
property -
errorTitle
An optional title of the error for use when reporting error to users.
property -
errorMessage
A human readable error message.
property -
diagnosticMessage
Additional diagnostic information if available.
property -
isSuccessful
Determines if the error code indicates whether the task succeeded or failed.
property
Results
-
entries
An array of LKEntry objects returned by a search request.
property -
referrals
An array of LDAP referrals returned by an LDAP request.
property
Identifying the LKMessage
Properties
diagnosticMessage
Additional diagnostic information if available.
@property (atomic, copy, readonly) NSString *diagnosticMessage
Declared In
LKMessage.h
entries
An array of LKEntry objects returned by a search request.
@property (atomic, copy, readonly) NSArray *entries
Declared In
LKMessage.h
errorCode
The numeric value of the error.
@property (atomic, readonly) NSInteger errorCode
Discussion
See the man page for ldap_error(3) for descriptions of valid error codes.
Declared In
LKMessage.h
errorMessage
A human readable error message.
@property (atomic, copy, readonly) NSString *errorMessage
Declared In
LKMessage.h
errorTitle
An optional title of the error for use when reporting error to users.
@property (atomic, copy, readonly) NSString *errorTitle
Declared In
LKMessage.h
isSuccessful
Determines if the error code indicates whether the task succeeded or failed.
@property (atomic, readonly) BOOL isSuccessful
Declared In
LKMessage.h
messageType
The type of request the message was initialized to process.
@property (atomic, readonly) LKLdapMessageType messageType
Discussion
Valid values:
LKLdapMessageType | Description |
---|---|
LKLdapMessageTypeBind |
LDAP bind request |
LKLdapMessageTypeDelete |
LDAP delete request |
LKLdapMessageTypeModify |
LDAP modify request |
LKLdapMessageTypeRename |
LDAP rename request |
LKLdapMessageTypeRebind |
LDAP unbind and bind request |
LKLdapMessageTypeSearch |
LDAP search request |
LKLdapMessageTypeUnbind |
LDAP unbind request |
LKLdapMessageTypeWhoAmI |
LDAP whoami request |
Declared In
LKMessage.h
object
An object reference you can use to associate data with messages in your application.
@property (atomic, retain) id<NSObject> object
Declared In
LKMessage.h