invite

Invites a user to a channel.

void
invite
(,
const string channel
,
const string nickname
,,
const string caller = __FUNCTION__
)

Parameters

state IRCPluginState

The current plugin's IRCPluginState, via which to send messages to the server.

channel string

Channel to which to invite the user.

nickname string

Nickname of user to invite.

properties Message.Property

Custom message properties, such as Message.Property.quiet and Message.Property.forced.

caller string

String name of the calling function, or something else that gives context.

Examples

IRCPluginState state;
state.mainThread = thisTid;

invite(state, "#channel", "kameloso");

receive(
    (Message m)
    {
        with (m.event)
        {
            assert((type == IRCEvent.Type.INVITE), Enum!(IRCEvent.Type).toString(type));
            assert((channel == "#channel"), channel);
            assert((target.nickname == "kameloso"), target.nickname);
            assert(m.properties == Message.Property.init);
        }
    }
);

Meta