WoW:API JoinChannelByName: Difference between revisions

Revision as of 09:34, 20 January 2007

Reference e
AddOns WoW API Widget API XML UI Event API WoW Lua Macro API CVars Battle.net HOWTOs Snippets UI tech Categories

JoinChannelByName - Documentation by AlexanderYoshi

Joins the channel with the specified name.

type, name = JoinChannelByName("channelName" [,"password" [,frameID]])

("channelName" [,"password" [,frameID]])

password: String (optional) - The channel password, nil if none.
frameID: Number (optional) - The chat frame ID number to add the channel to. Use Frame:GetID() to retrieve it for chat frame objects.

type: Number - The type of channel. 0 for a undefined channel, 1 for the zone General channel, etc
name: String - The name of the channel.

JoinChannelByName("Mammoth", "thesane", ChatFrame1:GetID());

Joins the channel with the specified name if there are less than 10 live channels.

@@ Line 12: / Line 12: @@
 :;channelName : String - The name of the channel to join
 :;: You can't use the "-" character in channelName (patch 1.9)
-:;password : String <small><i>(optional)</i></small> - The channel password, nil if none.
+:;password : String <small>''(optional)''</small> - The channel password, nil if none.
-:;frameID : Number <small><i>(optional)</i></small> - The chat frame ID number to add the channel to. Use [[API Frame GetID|Frame:GetID()]] to retrieve it for chat frame objects.
+:;frameID : Number <small>''(optional)''</small> - The chat frame ID number to add the channel to. Use [[API Frame GetID|Frame:GetID()]] to retrieve it for chat frame objects.
 === Returns ===