WoW:API CheckInbox: Difference between revisions

Revision as of 13:48, 28 April 2010

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

Populates client's inbox with messages.

CheckInbox();

This function requires that the mailbox window is open.
After it is called and the inbox populated, the client's stored mailbox information can be accessed from anywhere in the world. That is, functions like GetInboxHeaderInfo() and GetInboxNumItems() may be called from anywhere. Note that only the *stored* information can be accessed -- to get current inbox info, you have to call CheckInbox() again.

@@ Line 1: / Line 1: @@
 {{wowapi}}
-CheckInbox();
 Populates client's inbox with messages.
+ CheckInbox();
-----
+==Details==
-;''Details''
+* This function requires that the mailbox window is open.
+* After it is called and the inbox populated, the client's stored mailbox information can be accessed from anywhere in the world. That is, functions like {{api|GetInboxHeaderInfo}}() and {{api|GetInboxNumItems}}() may be called from anywhere. Note that only the *stored* information can be accessed -- to get current inbox info, you have to call CheckInbox() again.
-After it is called and the inbox populated, the client's stored mailbox information can be accessed from anywhere in the world. That is, functions like [[API_GetInboxHeaderInfo|GetInboxHeaderInfo()]] and [[API_GetInboxNumItems|GetInboxNumItems()]] may be called from anywhere. Note that only the *stored* information can be accessed--to get current inbox info, you have to call CheckInbox() again.
-Requires that the mailbox window is open.