Recent changes to Ircmsgs_object

WikiPage Ircmsgs_object modified by

Thu, 21 Feb 2013 21:27:04 -0000

WikiPage Ircmsgs_object modified by nanotube

nanotube — Thu, 21 Feb 2013 21:27:04 -0000

--- v3
+++ v4
@@ -36,91 +36,91 @@

 See also: [irc.queueMsg()](Irc_object#irc.queueMsg()), [irc.noReply()](Irc_object#irc.noReply()) 

-## ircmsgs.ops()
+## ircmsgs.op()

-**ircmsgs.ops(channel, nick)**
+**ircmsgs.op(channel, nick)**

 Create an IRC message suitable for giving ops to someone (mode +o). _Channel_ is the channel you want to send the message to. _nick_ is the nick to receive the ops. The resulting object is useful for passing to [irc.queueMsg()](Irc_object#irc.queueMsg()), for example. 

 Example: 

-    irc.queueMsg(ircmsgs.ops(channel, nick))
+    irc.queueMsg(ircmsgs.op(channel, nick))
     irc.noReply()

 See also: [irc.queueMsg()](Irc_object#irc.queueMsg()), [irc.noReply()](Irc_object#irc.noReply()) 

-## ircmsgs.deops()
+## ircmsgs.deop()

-**ircmsgs.deops(channel, nick)**
+**ircmsgs.deop(channel, nick)**

 Create an IRC message suitable for taking ops from someone (mode -o). _Channel_ is the channel you want to send the message to. _nick_ is the nick to remove the ops from. The resulting object is useful for passing to [irc.queueMsg()](Irc_object#irc.queueMsg()), for example. 

 Example: 

-    irc.queueMsg(ircmsgs.deops(channel, nick))
+    irc.queueMsg(ircmsgs.deop(channel, nick))
     irc.noReply()

 See also: [irc.queueMsg()](Irc_object#irc.queueMsg()), [irc.noReply()](Irc_object#irc.noReply()) 

-## ircmsgs.halfops()
+## ircmsgs.halfop()

-**ircmsgs.halfops(channel, nick)**
+**ircmsgs.halfop(channel, nick)**

 Create an IRC message suitable for giving halfops to someone (mode +h). _Channel_ is the channel you want to send the message to. _nick_ is the nick to receive the halfops. The resulting object is useful for passing to [irc.queueMsg()](Irc_object#irc.queueMsg()), for example. 

 Example: 

-    irc.queueMsg(ircmsgs.halfops(channel, nick))
+    irc.queueMsg(ircmsgs.halfop(channel, nick))
     irc.noReply()

 See also: [irc.queueMsg()](Irc_object#irc.queueMsg()), [irc.noReply()](Irc_object#irc.noReply()) 

-## ircmsgs.dehalfops()
+## ircmsgs.dehalfop()

-**ircmsgs.dehalfops(channel, nick)**
+**ircmsgs.dehalfop(channel, nick)**

 Create an IRC message suitable for removing halfops from someone (mode -h). _Channel_ is the channel you want to send the message to. _nick_ is the nick to remove the halfops from. The resulting object is useful for passing to [irc.queueMsg()](Irc_object#irc.queueMsg()), for example. 

 Example: 

-    irc.queueMsg(ircmsgs.dehalfops(channel, nick))
+    irc.queueMsg(ircmsgs.dehalfop(channel, nick))
     irc.noReply()

 See also: [irc.queueMsg()](Irc_object#irc.queueMsg()), [irc.noReply()](Irc_object#irc.noReply()) 

-## ircmsgs.voices()
+## ircmsgs.voice()

-**ircmsgs.voices(channel, nick)**
+**ircmsgs.voice(channel, nick)**

 Create an IRC message suitable for giving voice to someone (mode +v). _Channel_ is the channel you want to send the message to. _nick_ is the nick to receive voice. The resulting object is useful for passing to [irc.queueMsg()](Irc_object#irc.queueMsg()), for example. 

 Example: 

-    irc.queueMsg(ircmsgs.voices(channel, nick))
+    irc.queueMsg(ircmsgs.voice(channel, nick))
     irc.noReply()

 See also: [irc.queueMsg()](Irc_object#irc.queueMsg()), [irc.noReply()](Irc_object#irc.noReply()) 

-## ircmsgs.devoices()
+## ircmsgs.devoice()

-**ircmsgs.devoices(channel, nick)**
+**ircmsgs.devoice(channel, nick)**

 Create an IRC message suitable for removing voice from someone (mode -v). _Channel_ is the channel you want to send the message to. _nick_ is the nick to remove the voice from. The resulting object is useful for passing to [irc.queueMsg()](Irc_object#irc.queueMsg()), for example. 

 Example: 

-    irc.queueMsg(ircmsgs.devoices(channel, nick))
+    irc.queueMsg(ircmsgs.devoice(channel, nick))
     irc.noReply()

WikiPage Ircmsgs_object modified by quantumlemur

quantumlemur — Thu, 21 Feb 2013 21:27:04 -0000

--- v2
+++ v3
@@ -10,7 +10,7 @@

 **ircmsgs.privmsg(channel, text)**

-Create an irc PRIVMSG message. _channel_ is the channel you want to send message to. _text_ is the text you want to send. The resulting object is useful for passing to [irc.queueMsg()](Irc_object#irc.queueMsg()), for example. 
+Create an irc PRIVMSG message. _channel_ is the channel you want to send the message to. _text_ is the text you want to send. The resulting object is useful for passing to [irc.queueMsg()](Irc_object#irc.queueMsg()), for example. 

 Example: 

@@ -25,7 +25,7 @@

 **ircmsgs.action(channel, text)**

-Create an irc PRIVMSG ACTION message. _channel_ is the channel you want to send message to. _text_ is the text you want to send. The resulting object is useful for passing to [irc.queueMsg()](Irc_object#irc.queueMsg()), for example. 
+Create an irc PRIVMSG ACTION message. _channel_ is the channel you want to send the message to. _text_ is the text you want to send. The resulting object is useful for passing to [irc.queueMsg()](Irc_object#irc.queueMsg()), for example. 

 Example: 

@@ -35,3 +35,108 @@

 See also: [irc.queueMsg()](Irc_object#irc.queueMsg()), [irc.noReply()](Irc_object#irc.noReply()) 
+
+## ircmsgs.ops()
+
+**ircmsgs.ops(channel, nick)**
+
+Create an IRC message suitable for giving ops to someone (mode +o). _Channel_ is the channel you want to send the message to. _nick_ is the nick to receive the ops. The resulting object is useful for passing to [irc.queueMsg()](Irc_object#irc.queueMsg()), for example. 
+
+Example: 
+    
+    
+    irc.queueMsg(ircmsgs.ops(channel, nick))
+    irc.noReply()
+    
+
+See also: [irc.queueMsg()](Irc_object#irc.queueMsg()), [irc.noReply()](Irc_object#irc.noReply()) 
+
+## ircmsgs.deops()
+
+**ircmsgs.deops(channel, nick)**
+
+Create an IRC message suitable for taking ops from someone (mode -o). _Channel_ is the channel you want to send the message to. _nick_ is the nick to remove the ops from. The resulting object is useful for passing to [irc.queueMsg()](Irc_object#irc.queueMsg()), for example. 
+
+Example: 
+    
+    
+    irc.queueMsg(ircmsgs.deops(channel, nick))
+    irc.noReply()
+    
+
+See also: [irc.queueMsg()](Irc_object#irc.queueMsg()), [irc.noReply()](Irc_object#irc.noReply()) 
+
+## ircmsgs.halfops()
+
+**ircmsgs.halfops(channel, nick)**
+
+Create an IRC message suitable for giving halfops to someone (mode +h). _Channel_ is the channel you want to send the message to. _nick_ is the nick to receive the halfops. The resulting object is useful for passing to [irc.queueMsg()](Irc_object#irc.queueMsg()), for example. 
+
+Example: 
+    
+    
+    irc.queueMsg(ircmsgs.halfops(channel, nick))
+    irc.noReply()
+    
+
+See also: [irc.queueMsg()](Irc_object#irc.queueMsg()), [irc.noReply()](Irc_object#irc.noReply()) 
+
+## ircmsgs.dehalfops()
+
+**ircmsgs.dehalfops(channel, nick)**
+
+Create an IRC message suitable for removing halfops from someone (mode -h). _Channel_ is the channel you want to send the message to. _nick_ is the nick to remove the halfops from. The resulting object is useful for passing to [irc.queueMsg()](Irc_object#irc.queueMsg()), for example. 
+
+Example: 
+    
+    
+    irc.queueMsg(ircmsgs.dehalfops(channel, nick))
+    irc.noReply()
+    
+
+See also: [irc.queueMsg()](Irc_object#irc.queueMsg()), [irc.noReply()](Irc_object#irc.noReply()) 
+
+## ircmsgs.voices()
+
+**ircmsgs.voices(channel, nick)**
+
+Create an IRC message suitable for giving voice to someone (mode +v). _Channel_ is the channel you want to send the message to. _nick_ is the nick to receive voice. The resulting object is useful for passing to [irc.queueMsg()](Irc_object#irc.queueMsg()), for example. 
+
+Example: 
+    
+    
+    irc.queueMsg(ircmsgs.voices(channel, nick))
+    irc.noReply()
+    
+
+See also: [irc.queueMsg()](Irc_object#irc.queueMsg()), [irc.noReply()](Irc_object#irc.noReply()) 
+
+## ircmsgs.devoices()
+
+**ircmsgs.devoices(channel, nick)**
+
+Create an IRC message suitable for removing voice from someone (mode -v). _Channel_ is the channel you want to send the message to. _nick_ is the nick to remove the voice from. The resulting object is useful for passing to [irc.queueMsg()](Irc_object#irc.queueMsg()), for example. 
+
+Example: 
+    
+    
+    irc.queueMsg(ircmsgs.devoices(channel, nick))
+    irc.noReply()
+    
+
+See also: [irc.queueMsg()](Irc_object#irc.queueMsg()), [irc.noReply()](Irc_object#irc.noReply()) 
+
+## ircmsgs.kick()
+
+**ircmsgs.kick(channel, nick, message)**
+
+Create an IRC message suitable for kicking someone from a channel. _Channel_ is the channel from which you want to kick the person. _nick_ is the nick to be kicked. _message_ is the kick message to send. The resulting object is useful for passing to [irc.queueMsg()](Irc_object#irc.queueMsg()), for example. 
+
+Example: 
+    
+    
+    irc.queueMsg(ircmsgs.kick(channel, nick, message))
+    irc.noReply()
+    
+
+See also: [irc.queueMsg()](Irc_object#irc.queueMsg()), [irc.noReply()](Irc_object#irc.noReply())

WikiPage Ircmsgs_object modified by nanotube

nanotube — Thu, 21 Feb 2013 21:27:03 -0000

--- v1
+++ v2
@@ -1,14 +1,16 @@
 [TOC]

-The ircmsgs object is a convenience method to create irc message objects. To access it: 
+The ircmsgs object has convenience methods to create irc message objects. To access it: 

     import supybot.ircmsgs as ircmsgs

-## ircmsgs.privmsg(channel, text)
+## ircmsgs.privmsg()

-Create an irc PRIVMSG message. This resulting object is useful for passing to [irc.queueMsg()](Irc_object#irc.queueMsg(ircmsgs)), for example. 
+**ircmsgs.privmsg(channel, text)**
+
+Create an irc PRIVMSG message. _channel_ is the channel you want to send message to. _text_ is the text you want to send. The resulting object is useful for passing to [irc.queueMsg()](Irc_object#irc.queueMsg()), for example. 

 Example: 

@@ -17,9 +19,13 @@
     irc.noReply()

-## ircmsgs.action(channel,text)
+See also: [irc.queueMsg()](Irc_object#irc.queueMsg()), [irc.noReply()](Irc_object#irc.noReply()) 

-Create an irc ACTION message. This resulting object is useful for passing to [irc.queueMsg()](Irc_object#irc.queueMsg(ircmsgs)), for example. 
+## ircmsgs.action()
+
+**ircmsgs.action(channel, text)**
+
+Create an irc PRIVMSG ACTION message. _channel_ is the channel you want to send message to. _text_ is the text you want to send. The resulting object is useful for passing to [irc.queueMsg()](Irc_object#irc.queueMsg()), for example. 

 Example: 

@@ -27,3 +33,5 @@
     irc.queueMsg(ircmsgs.action(channel, text))
     irc.noReply()

+
+See also: [irc.queueMsg()](Irc_object#irc.queueMsg()), [irc.noReply()](Irc_object#irc.noReply())

WikiPage Ircmsgs_object modified by nanotube

nanotube — Thu, 21 Feb 2013 21:27:03 -0000

ircmsgs.privmsg(channel, text)
ircmsgs.action(channel,text)

The ircmsgs object is a convenience method to create irc message objects. To access it:

import supybot.ircmsgs as ircmsgs

ircmsgs.privmsg(channel, text)

Create an irc PRIVMSG message. This resulting object is useful for passing to irc.queueMsg(), for example.

Example:

irc.queueMsg(ircmsgs.privmsg(channel, text))
irc.noReply()

ircmsgs.action(channel,text)

Create an irc ACTION message. This resulting object is useful for passing to irc.queueMsg(), for example.

Example:

irc.queueMsg(ircmsgs.action(channel, text))
irc.noReply()