Function

Purpleserv_send_typing

Declaration [src]

unsigned int
purple_serv_send_typing (
  PurpleConnection* gc,
  const char* name,
  PurpleIMTypingState state
)

Description [src]

Send a typing message to a given user over a given connection.

Parameters

gc PurpleConnection
 

The connection over which to send the typing notification.

 The data is owned by the caller of the function.
name const char*
 

The user to send the typing notification to.

 The data is owned by the caller of the function.
 The value is a NUL terminated UTF-8 string.
state PurpleIMTypingState
 

One of PURPLE_IM_TYPING, PURPLE_IM_TYPED, or PURPLE_IM_NOT_TYPING.

Return value

Returns: unsigned int
 

A quiet-period, specified in seconds, where Purple will not send any additional typing notification messages. Most protocols should return 0, which means that no additional PURPLE_IM_TYPING messages need to be sent. If this is 5, for example, then Purple will wait five seconds, and if the Purple user is still typing then Purple will send another PURPLE_IM_TYPING message.