libpurple/server.h

branch
soc.2013.gobjectification
changeset 34670
9bd5bd903dc7
parent 34632
ebe6b2a60305
child 35393
00f876b129bc
child 36543
a8c3fecee2d3
equal deleted inserted replaced
34669:250f77369396 34670:9bd5bd903dc7
37 * 37 *
38 * TODO: Could probably move this into the conversation API. 38 * TODO: Could probably move this into the conversation API.
39 * 39 *
40 * @param gc The connection over which to send the typing notification. 40 * @param gc The connection over which to send the typing notification.
41 * @param name The user to send the typing notification to. 41 * @param name The user to send the typing notification to.
42 * @param state One of PURPLE_IM_CONVERSATION_TYPING, PURPLE_IM_CONVERSATION_TYPED, or PURPLE_IM_CONVERSATION_NOT_TYPING. 42 * @param state One of PURPLE_IM_TYPING, PURPLE_IM_TYPED, or PURPLE_IM_NOT_TYPING.
43 * @return A quiet-period, specified in seconds, where Purple will not 43 * @return A quiet-period, specified in seconds, where Purple will not
44 * send any additional typing notification messages. Most 44 * send any additional typing notification messages. Most
45 * protocols should return 0, which means that no additional 45 * protocols should return 0, which means that no additional
46 * PURPLE_IM_CONVERSATION_TYPING messages need to be sent. If this is 5, for 46 * PURPLE_IM_TYPING messages need to be sent. If this is 5, for
47 * example, then Purple will wait five seconds, and if the Purple 47 * example, then Purple will wait five seconds, and if the Purple
48 * user is still typing then Purple will send another PURPLE_IM_CONVERSATION_TYPING 48 * user is still typing then Purple will send another PURPLE_IM_TYPING
49 * message. 49 * message.
50 */ 50 */
51 unsigned int serv_send_typing(PurpleConnection *gc, const char *name, PurpleIMConversationTypingState state); 51 unsigned int serv_send_typing(PurpleConnection *gc, const char *name, PurpleIMTypingState state);
52 52
53 void serv_move_buddy(PurpleBuddy *, PurpleGroup *, PurpleGroup *); 53 void serv_move_buddy(PurpleBuddy *, PurpleGroup *, PurpleGroup *);
54 int serv_send_im(PurpleConnection *, const char *, const char *, PurpleMessageFlags flags); 54 int serv_send_im(PurpleConnection *, const char *, const char *, PurpleMessageFlags flags);
55 55
56 /** Get information about an account's attention commands, from the prpl. 56 /** Get information about an account's attention commands, from the prpl.
85 */ 85 */
86 void purple_serv_got_private_alias(PurpleConnection *gc, const char *who, const char *alias); 86 void purple_serv_got_private_alias(PurpleConnection *gc, const char *who, const char *alias);
87 87
88 88
89 /** 89 /**
90 * Receive a typing message from a remote user. Either PURPLE_IM_CONVERSATION_TYPING 90 * Receive a typing message from a remote user. Either PURPLE_IM_TYPING
91 * or PURPLE_IM_CONVERSATION_TYPED. If the user has stopped typing then use 91 * or PURPLE_IM_TYPED. If the user has stopped typing then use
92 * serv_got_typing_stopped instead. 92 * serv_got_typing_stopped instead.
93 * 93 *
94 * TODO: Could probably move this into the conversation API. 94 * TODO: Could probably move this into the conversation API.
95 * 95 *
96 * @param gc The connection on which the typing message was received. 96 * @param gc The connection on which the typing message was received.
97 * @param name The name of the remote user. 97 * @param name The name of the remote user.
98 * @param timeout If this is a number greater than 0, then 98 * @param timeout If this is a number greater than 0, then
99 * Purple will wait this number of seconds and then 99 * Purple will wait this number of seconds and then
100 * set this buddy to the PURPLE_IM_CONVERSATION_NOT_TYPING state. This 100 * set this buddy to the PURPLE_IM_NOT_TYPING state. This
101 * is used by protocols that send repeated typing messages 101 * is used by protocols that send repeated typing messages
102 * while the user is composing the message. 102 * while the user is composing the message.
103 * @param state The typing state received 103 * @param state The typing state received
104 */ 104 */
105 void serv_got_typing(PurpleConnection *gc, const char *name, int timeout, 105 void serv_got_typing(PurpleConnection *gc, const char *name, int timeout,
106 PurpleIMConversationTypingState state); 106 PurpleIMTypingState state);
107 107
108 /** 108 /**
109 * TODO: Could probably move this into the conversation API. 109 * TODO: Could probably move this into the conversation API.
110 */ 110 */
111 void serv_got_typing_stopped(PurpleConnection *gc, const char *name); 111 void serv_got_typing_stopped(PurpleConnection *gc, const char *name);

mercurial