ContactlistRemove

From TrillWiki

The contactlistRemove function removes a contact from a particular contact list. It will not ask the user before finishing.

Compatibility: 2.0 and higher

Contents 1 Syntax 2 Parameters 3 Return Value 4 Remarks

Syntax

plugin_send(MYGUID, "contactlistRemove", struct contactlist_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

ContactlistRemove 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.

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).

Return Value

Negative value on error, 0 on success.

Remarks

Do not remove any contacts that the user may wish to keep. Good uses for this function include removing contacts that are duplicated in the list, or that are invalid (if the user is given warning that this is going to take place).