Property

PurpleConversation:typing-state

unstable since: 3.0

Declaration

property typing-state: Purple.TypingState [ read, write ]

Description [src]

The PurpleTypingState of the libpurple user in this conversation.

When the property changes to typing, a timeout will be setup to change the property to paused if the property hasn’t been set to typing again before the timeout expires.

If the above timeout fires, the state will be changed to paused, and a new timeout will be added that will reset the state to none if it expires.

This means that user interfaces should only ever need to set the state to typing and should do so whenever the user types anything that could be part of a message. Things like keyboard navigation and %commands should not result in this property being changed.

If the PurpleProtocol that this conversation belongs to implements PurpleProtocolConversation and Purple.ProtocolConversationInterface.send_typing, Purple.ProtocolConversationInterface.send_typing will be called when this property is set even if the state hasn’t changed.

Type:PurpleTypingState

Available since: 3.0

Default valuePURPLE_TYPING_STATE_NONE
Getter methodpurple_conversation_get_typing_state()
Setter methodpurple_conversation_set_typing_state()

Flags

Readableyes
Writableyes
Constructno
Construct onlyno