on_search_result_reference Event

Fired for every result reference returned from a search operation.

Syntax

class LDAPSearchResultReferenceEventParams(object):
  @property
  def message_id() -> int: ...
  @property
  def ldap_url() -> str: ...

# In class LDAP:
@property
def on_search_result_reference() -> Callable[[LDAPSearchResultReferenceEventParams], None]: ...
@on_search_result_reference.setter
def on_search_result_reference(event_hook: Callable[[LDAPSearchResultReferenceEventParams], None]) -> None: ...

Remarks

MessageId identifies the corresponding search request. LdapUrl contains a URL reference to server that can be used for continuing the search operation.

Every search operation results in a sequence of 0 or more on_search_result events, a sequence of 0 or more on_search_result_reference events, followed by a on_search_complete event.