Skip to main content

KeyHeaderFlags

Overview​

KeyHeaderFlags is a typed dictionary representing flag settings for a key header. These flags provide additional metadata about the state and properties of a key message in the KeySquare platform.

Definition​

from typing import TypedDict, NotRequired

class KeyHeaderFlags(TypedDict):
    """
    Represents flag settings for a key header.

    Attributes:
        voided: Whether the message is voided
        editable: Whether the message can be edited
        ephemeral: Whether the message is temporary
    """
    voided: NotRequired[bool]
    editable: NotRequired[bool]
    ephemeral: NotRequired[bool]

Attributes​

  • voided: Whether the message is voided (optional, bool)
  • editable: Whether the message can be edited (optional, bool)
  • ephemeral: Whether the message is temporary (optional, bool)

Usage Example​

from keysquarepy import KeyHeaderFlags

flags: KeyHeaderFlags = {
    "voided": True,
    "editable": False
}
print(flags)

See Also​