Package command_system :: Package implementation :: Module standard :: Class StandardGroupchatCommands
[hide private]
[frames] | no frames]

Class StandardGroupchatCommands

source code


This command container contains standard command which are unique to a group chat.
Nested Classes [hide private]

Inherited from framework.CommandContainer: __metaclass__

Instance Methods [hide private]
 
nick(self, new_nick) source code
 
chat(self, nick) source code
 
message(self, nick, a_message) source code
 
topic(self, new_topic) source code
 
invite(self, jid, reason) source code
 
join(self, jid, nick) source code
 
leave(self, reason) source code
 
ban(self, who, reason) source code
 
kick(self, who, reason) source code
 
names(self, verbose=False) source code
 
block(self, who) source code
 
unblock(self, who) source code

Inherited from object: __delattr__, __getattribute__, __hash__, __init__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __str__

Class Variables [hide private]
  HOSTS = GroupChatCommands,
Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

nick(self, new_nick)

source code 
Decorators:
  • @command(raw= True)
  • @documentation(_("Change your nickname in a group chat"))

chat(self, nick)

source code 
Decorators:
  • @command('query', raw= True)
  • @documentation(_("Open a private chat window with a specified occupant"))

message(self, nick, a_message)

source code 
Decorators:
  • @command('msg', raw= True)
  • @documentation(_("Open a private chat window with a specified occupant and send him a message"))

topic(self, new_topic)

source code 
Decorators:
  • @command(raw= True, empty= True)
  • @documentation(_("Display or change a group chat topic"))

invite(self, jid, reason)

source code 
Decorators:
  • @command(raw= True, empty= True)
  • @documentation(_("Invite a user to a room for a reason"))

join(self, jid, nick)

source code 
Decorators:
  • @command(raw= True, empty= True)
  • @documentation(_("Join a group chat given by a jid, optionally using given nickname"))

leave(self, reason)

source code 
Decorators:
  • @command('part', 'close', raw= True, empty= True)
  • @documentation(_("Leave the groupchat, optionally giving a reason, and close tab or window"))

ban(self, who, reason)

source code 
Decorators:
  • @command(raw= True, empty= True)
  • @documentation(_(""" Ban user by a nick or a jid from a groupchat If given nickname is not found it will be treated as a jid. """))

kick(self, who, reason)

source code 
Decorators:
  • @command(raw= True, empty= True)
  • @documentation(_("Kick user by a nick from a groupchat"))

names(self, verbose=False)

source code 
Decorators:
  • @command
  • @documentation(_("Display names of all group chat occupants"))

block(self, who)

source code 
Decorators:
  • @command('ignore', raw= True)
  • @documentation(_("Forbid an occupant to send you public or private messages"))

unblock(self, who)

source code 
Decorators:
  • @command('unignore', raw= True)
  • @documentation(_("Allow an occupant to send you public or private messages"))

Class Variable Details [hide private]

HOSTS

Value:
GroupChatCommands,