ConnectionUpdate

From TrillWiki

The connectionUpdate function updates the information related to a particular connection. You can use this to update a menu or the status currently.

Compatibility: 2.0 and higher

Contents 1 Syntax 2 Parameters 3 Return Value 4 Remarks

Syntax

plugin_send(MYGUID, "connectionUpdate", struct connection_entry_t *);

Note that all Trillian functions and notifications begin with a lower-case letter, despite the Wiki requirement that all pages start with a capital letter.

Parameters

ConnectionUpdate utilitizes the connection_entry_t structure.

struct connection_entry_t {  
 	unsigned int			struct_size; 
 
 	char				*medium; 
 
 	int				connection_id; 
 
 	char				*name; 
 	char				*status; 
 
 	/* 2.0 
 	 */ 
 	char				*section; 
 	struct menu_entry_t		*menu_entry; 
 };

medium

The medium for this particular connection.

connection_id

A unique number representing the connection.

status

The current status of the connection. The main options for this are "Online", "Offline", and "Away".

section

The section associated with the connection. A NULL section means to use the default Contact List.

menu_entry

The menu associated with this connection.

Return Value

Negative value on error, 0 on success.

Remarks

Any status which is not Online or Offline will trigger the away icon to be shown within the status window.

Note, this is only for mediums to use to update the current connection. A non medium based plugin setting this will not change your status on that medium.