JoinTemporaryChannel

Main Menu
WoW API Lua API FrameXML Widget API Widget scripts XML schema Events CVars Macro commands Combat Log Escape sequences Hyperlinks API changes HOWTOs wowuidev

Flavors
war within  mainline  cata  wrath  vanilla
Links
Wowprogramming  GitHub Search
Info
Added in 2.2.0 / 1.13.2

Joins the specified chat channel; the channel will be left on logout.

Joins the channel with the specified name. A player can be in a maximum of 10 chat channels. In opposite to API_JoinPermanentChannel the channel will be left at logout.

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

Parameters

(copy/paste from API_JoinChannelByName)

Arguments

channelName

string - The name of the channel to join. You can't use the "-" character in channelName (patch 1.9)

password

string? - The channel password, nil if none.

frameID

number? - The chat frame ID number to add the channel to. Use Frame:GetID() to retrieve it for chat frame objects.

hasVoice

number - (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

(copy/paste from API_JoinChannelByName)

JoinTemporaryChannel("Mammoth", "thesane", ChatFrame1:GetID(), 1);