Phantasmal Site > Phantasmal API > API Listing > unsubscribe_user

API Function: unsubscribe_user

Summary:

remove a user's subscription to a channel

Defined In LPC Object:

/usr/common/sys/channeld.c

Prototype:

int unsubscribe_user(mixed user, int channel)

Can Be Called By:

System, Common, Game

Description:

Unsubscribe the user from the channel. User can be specified as a user object or a name string. The user will no longer receive data sent to the given channel.

Return Value:

Returns 1 if successful, -1 if failed. Normally an unsubscribe will only fail if the user isn't already subscribed.

Errors:

Normally none

See Also:

get_channel_by_name , string_to_channel , subscribe_user , unsubscribe_user_from_all