WoW API: JoinTemporaryChannel

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

→ WoW API

← WoW API < JoinTemporaryChannel

Seems to have the same effect as API_JoinChannelByName (except that a channel joined by JoinTemporaryChannel is left at 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 (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

(copy/paste from API_JoinChannelByName)

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