comparison: libpurple/protocol.h
libpurple/protocol.h
- branch
- soc.2013.gobjectification.plugins
- changeset 37087
- 197d965cec97
- parent 37086
- b78048ba0fbb
- child 37089
- 4cf0522a39f5
equal
deleted
inserted
replaced
| 37086:b78048ba0fbb | 37087:197d965cec97 |
|---|---|
| 270 * invite message. | 270 * invite message. |
| 271 * @keepalive: If implemented, this will be called regularly for this | 271 * @keepalive: If implemented, this will be called regularly for this |
| 272 * protocol's active connections. You'd want to do this if you | 272 * protocol's active connections. You'd want to do this if you |
| 273 * need to repeatedly send some kind of keepalive packet to | 273 * need to repeatedly send some kind of keepalive packet to |
| 274 * the server to avoid being disconnected. ("Regularly" is | 274 * the server to avoid being disconnected. ("Regularly" is |
| 275 * defined by #KEEPALIVE_INTERVAL in | 275 * defined by <literal>KEEPALIVE_INTERVAL</literal> in |
| 276 * <filename>libpurple/connection.c</filename>.) | 276 * <filename>libpurple/connection.c</filename>.) |
| 277 * @alias_buddy: Save/store buddy's alias on server list/roster | 277 * @alias_buddy: Save/store buddy's alias on server list/roster |
| 278 * @group_buddy: Change a buddy's group on a server list/roster | 278 * @group_buddy: Change a buddy's group on a server list/roster |
| 279 * @rename_group: Rename a group on a server list/roster | 279 * @rename_group: Rename a group on a server list/roster |
| 280 * @set_buddy_icon: Set the buddy icon for the given connection to @img. The | 280 * @set_buddy_icon: Set the buddy icon for the given connection to @img. The |
| 385 typedef struct _PurpleProtocolIMIface PurpleProtocolIMIface; | 385 typedef struct _PurpleProtocolIMIface PurpleProtocolIMIface; |
| 386 | 386 |
| 387 /** | 387 /** |
| 388 * PurpleProtocolIMIface: | 388 * PurpleProtocolIMIface: |
| 389 * @send: This protocol function should return a positive value on | 389 * @send: This protocol function should return a positive value on |
| 390 * success. If the message is too big to be sent, return -#E2BIG. | 390 * success. If the message is too big to be sent, return |
| 391 * If the account is not connected, return -#ENOTCONN. If the | 391 * <literal>-E2BIG</literal>. If the account is not connected, |
| 392 * protocol is unable to send the message for another reason, | 392 * return <literal>-ENOTCONN</literal>. If the protocol is unable |
| 393 * return some other negative value. You can use one of the valid | 393 * to send the message for another reason, return some other |
| 394 * #errno values, or just big something. If the message should not | 394 * negative value. You can use one of the valid #errno values, or |
| 395 * be echoed to the conversation window, return 0. | 395 * just big something. If the message should not be echoed to the |
| 396 * conversation window, return 0. | |
| 396 * @send_typing: If this protocol requires the #PURPLE_IM_TYPING message to be | 397 * @send_typing: If this protocol requires the #PURPLE_IM_TYPING message to be |
| 397 * sent repeatedly to signify that the user is still typing, then | 398 * sent repeatedly to signify that the user is still typing, then |
| 398 * the protocol should return the number of seconds to wait before | 399 * the protocol should return the number of seconds to wait before |
| 399 * sending a subsequent notification. Otherwise the protocol | 400 * sending a subsequent notification. Otherwise the protocol |
| 400 * should return 0. | 401 * should return 0. |
| 465 * <sbr/>@id: The id of the chat. | 466 * <sbr/>@id: The id of the chat. |
| 466 * <sbr/>@who: The name of the user to send the whisper to. | 467 * <sbr/>@who: The name of the user to send the whisper to. |
| 467 * <sbr/>@message: The message of the whisper. | 468 * <sbr/>@message: The message of the whisper. |
| 468 * @send: Send a message to a chat. | 469 * @send: Send a message to a chat. |
| 469 * <sbr/>This protocol function should return a positive value on | 470 * <sbr/>This protocol function should return a positive value on |
| 470 * success. If the message is too big to be sent, return -#E2BIG. | 471 * success. If the message is too big to be sent, return |
| 471 * If the account is not connected, return -#ENOTCONN. If the | 472 * <literal>-E2BIG</literal>. If the account is not connected, |
| 472 * protocol is unable to send the message for another reason, | 473 * return <literal>-ENOTCONN</literal>. If the protocol is unable |
| 473 * return some other negative value. You can use one of the valid | 474 * to send the message for another reason, return some other |
| 474 * #errno values, or just big something. | 475 * negative value. You can use one of the valid #errno values, or |
| 476 * just big something. | |
| 475 * <sbr/>@id: The id of the chat to send the message to. | 477 * <sbr/>@id: The id of the chat to send the message to. |
| 476 * <sbr/>@message: The message to send to the chat. | 478 * <sbr/>@message: The message to send to the chat. |
| 477 * <sbr/>@flags: A bitwise OR of #PurpleMessageFlags representing | 479 * <sbr/>@flags: A bitwise OR of #PurpleMessageFlags representing |
| 478 * message flags. | 480 * message flags. |
| 479 * <sbr/>Returns: A positive number or 0 in case of success, a | 481 * <sbr/>Returns: A positive number or 0 in case of success, a |
| 724 }; | 726 }; |
| 725 | 727 |
| 726 /** | 728 /** |
| 727 * PURPLE_PROTOCOL_IMPLEMENTS: | 729 * PURPLE_PROTOCOL_IMPLEMENTS: |
| 728 * @protocol: The protocol in which to check | 730 * @protocol: The protocol in which to check |
| 729 * @IFACE: The interface name in caps. e.g. #CLIENT_IFACE | 731 * @IFACE: The interface name in caps. e.g. <literal>CLIENT_IFACE</literal> |
| 730 * @func: The function to check | 732 * @func: The function to check |
| 731 * | 733 * |
| 732 * Returns: %TRUE if a protocol implements a function in an interface, | 734 * Returns: %TRUE if a protocol implements a function in an interface, |
| 733 * %FALSE otherwise. | 735 * %FALSE otherwise. |
| 734 */ | 736 */ |
