Changes: API JoinChannelByName

Revision as of 20:21, 1 June 2009

Joins the channel with the specified name. A player can be in a maximum of 10 chat channels.

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

Parameters

Arguments

channelName: String - The name of the channel to join

You can't use the "-" character in channelName (patch 1.9)

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.
hasVoice: Boolean (1/nil) - Enable voice chat for this channel.

Returns

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 (Ohklus: seems to be nil for most channels).

Example

local channel_type, channel_name = JoinChannelByName("Mammoth", "thesane", ChatFrame1:GetID(), 1);

@@ Line 1: / Line 1: @@
+{{wowapi}}
-<center>'''JoinChannelByName''' - ''Documentation by AlexanderYoshi''</center>
+Joins the channel with the specified name. A player can be in a maximum of 10 chat channels.
+ type, name = JoinChannelByName("channelName" [,"password" [,frameID[, hasVoice]]])
-Joins the channel with the specified name.
- retCode = JoinChannelByName("channelName" [,"password" [,frameID]])
 == Parameters ==
 === Arguments ===
-:("channelName" [,"password" [,frameID]])
+:;channelName : String - The name of the channel to join
+:;: You can't use the "-" character in channelName (patch 1.9)
+:;password : String <small>''(optional)''</small> - The channel password, nil if none.
+:;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.
+:;hasVoice : Boolean (1/nil) - Enable voice chat for this channel.
-:;channelName : String - The name of the channel to join
-:;password : String <small><i>(optional)</i></small> - The channel password, nil if none.
-:;frameID :  <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.
 === Returns ===
+:;type : Number - The type of channel. 0 for a undefined channel, 1 for the zone General channel,  etc
-:retCode
+:;name : String - The name of the channel (Ohklus: seems to be nil for most channels).
-:;retCode : Number - Appears to always equal 0.
 == Example ==
 <!-- begin code -->
- JoinChannelByName("Mammoth", "thesane", ChatFrame1:GetID());
+ local channel_type, channel_name = JoinChannelByName("Mammoth", "thesane", ChatFrame1:GetID(), 1);
 <!-- end code -->
-== Details ==
-: Joins the channel with the specified name if there are less than 10 live channels.
-----
-__NOTOC__
-{{Template:WoW API}}
-[[Category:API Chat Functions|JoinChannelByName]]