Medium contactAdd

From TrillWiki

The medium_contactAdd notification is sent to a medium when a new contact is added, either through reading it from the xml or added via the user or plugin.

Compatibility: 2.0 and higher

Contents 1 Syntax 2 Parameters 3 Return Value 4 Remarks

Syntax

callback(int window_id, char *icontrol, "medium_contactAdd", contactlist_entry_t *data, void *userData);

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

Medium contactAdd utilitizes the contactlist_entry_t structure.

struct contactlist_entry_t
{
    unsigned int                struct_size;

    char                        *medium;

    int                        connection_id;

    char                        *name;
    char                        *real_name;
    char                        *status;

    /* 2.0 enhancement
     */
    char                        *section;
    char                        *uri;
    char                        *tooltip;

    int                         status_score;
    int                         status_idle;
    int                         status_block;

    struct group_entry_t        *group;
    struct menu_entry_t         *menu_entry;

    ttkCallback                 callback;
    void                        *data;

    /* 3.0 
     */
    int                         status_warned;
    int                         status_time;
    int                         status_idle_time;

    char                        *status_message;
};

medium

Medium for the the contact.

name

The display name for the contact.

real_name

The address associated with the contact. (The value that never changes).

section

The Contact List to add the contact to. A NULL will specify the default section (My Contacts).

uri

A URI to associate with the contact when saving it to disk. This will be given to you on a medium_contactAdd notification on file load.

tooltip

The default tooltip for the contact when not using the enhanced tooltips.

group

The group to add the contact to.

menu_entry

The initial menu for the contact.

callback

The callback to use for this contact.

data

The user data to send with each notification sent to the callback.

Return Value

Must return 0.

Remarks

Not all of the fields may be filled out when receiving this event. Such as if it is read from the file, the URI will be available, but not the real name. It is the responsibility of the medium to specify the real name, uri, callback, data, menu, etc if they are missing using the contactlistUpdate function.

See also: contactlistUpdate