on_password_needed Event

Requests a password from the application.

Syntax

class DCAuthPasswordNeededEventParams(object):
  @property
  def needed_for() -> str: ...
  @property
  def id() -> str: ...
  @property
  def password() -> str: ...
  @password.setter
  def password(value) -> None: ...
  @property
  def cancel() -> bool: ...
  @cancel.setter
  def cancel(value) -> None: ...

# In class DCAuth:
@property
def on_password_needed() -> Callable[[DCAuthPasswordNeededEventParams], None]: ...
@on_password_needed.setter
def on_password_needed(event_hook: Callable[[DCAuthPasswordNeededEventParams], None]) -> None: ...

Remarks

Subscribe to this event to pass a password to the server component. The NeededFor parameter specifies the entity a password for which is being requested (which is typically a certificate). The Id parameter provides the entity's identifier, such as a path to the certificate being loaded. When handling this event, assign the Password to the valid password if you have it; otherwise, set Cancel to true to abort the operation.