MessageNicklistChange

From TrillWiki

The messageNicklistChange will change information related to a user within a nicklist.

Compatibility: 2.0 and higher

Contents 1 Syntax 2 Parameters 3 Return Value 4 Remarks 5 Additional Structures 5.1 nicklist_entry_t

Syntax

plugin_send(MYGUID, "messageNicklistChange", struct nicklist_change_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

MessageNicklistChange utilitizes the nicklist_change_t structure.

struct nicklist_change_t {  
 	unsigned int			struct_size; 
 
 	int				window_id; 
 	int				connection_id; 
 
 	char				*medium; 
 	char				*location; 
 	 
 	struct nicklist_entry_t*	nicklist; 
 };

connection_id

The connection id of the window.

window_id

The window id of the window. If this is 0, the other variables are used to locate the window.

medium

The medium of the window.

location

The chat window name.

nicklist

A linked list of user entries to change from the nicklist. See below for more information.

Return Value

Negative value on error, 0 on success.

Remarks

None.

Additional Structures

nicklist_entry_t

struct nicklist_entry_t {  
 	unsigned int			struct_size; 
 
 	char				*name; 
 	char				*group; 
 	char				*tooltip; 
 
 	int				group_score; 
 
 	struct menu_entry_t		*menu; 
 
 	ttkCallback			callback; 
 
 	void				*data; 
 
 	struct nicklist_entry_t*	next_nicklist_entry;	 
 };

name

The name of the user to change.

next_nicklist_entry

Note: When changing users, the first nicklist_entry_t will be the user that needs to be changed. The NEXT will be how that entry should be changed. Each collection of 2 nicklist_entry_t structs will be used for the change. The last entry should set this value to NULL.