WoW API: GetChannelDisplayInfo

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 < GetChannelDisplayInfo

GetChannelDisplayInfo

Retrieves channels (and category headers) that would be displayed in Blizzards ChannelFrame.

name, header, collapsed, channelNumber, count, active, category, voiceEnabled, voiceActive = GetChannelDisplayInfo(i);

Parameters

Arguments

id

item id (ChannelFrame can display a combined maximum of 20 channels and headers; see MAX_CHANNEL_BUTTONS and use API GetNumDisplayChannels)

---

Returns

name

(for channels) channel name
(for headers) name of the header

header

true if this item is a header (e.g. for category "CHANNEL_CATEGORY_WORLD")

collapsed

(for headers) true if subchannels are hidden (header is collapsed)

channelNumber

(for channels) channel number

count

(for channels) number of players in this channel
(for headers) number of subchannels beneath this header

active

(for channels) true if channel is active (if you leave a city where you were in Trade Channel the channel will remain as inactive)

category

(for channels) "CHANNEL_CATEGORY_WORLD", "CHANNEL_CATEGORY_GROUP" or "CHANNEL_CATEGORY_CUSTOM"

voiceEnabled

true if voice is enabled for this channel

voiceActive

true if voice is currently active (someone is speaking)

---

Note

I didn't test this function in detail. But it looks very powerful and could help keeping an eye on joined channels.
Just look into ChannelFrame.lua for more information.

---