WoW:API ComplainChat: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
(initial commit. trying to source the 1-per-minute 5-per-day comment, I know I saw a blue post it)
 
m (Move page script moved page API ComplainChat to API ComplainChat without leaving a redirect)
 
(3 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{wowapi}} __NOTOC__
{{wowapi}} __NOTOC__


 
Complain about a specific [[chat]] message to the [[Game Master|Game Masters]].
<!-- Describe the purpose of the function, exhausting detail can be saved for a later section -->
Reports the specified line of chat to the GMs.
<!-- List return values and arguments as well as function name, follow Blizzard usage convention for args -->
  ComplainChat(lineID)
  ComplainChat(lineID)
 
ComplainChat(author, [message])


== Arguments ==
== Arguments ==
<!-- List each argument, together with its type -->
<!-- List each argument, together with its type -->
:;lineID : int The line of chat to complain about. (lineID comes from the player link in the chat line)  
:;<number> lineID : This is the eleventh argument from CHAT_MSG [[Events (API)|events]].
 
:;<string> author : The name of the [[player]] to complain about.
== Details ==
:;<string> message : The [[chat]] message to complain about.
<!-- Details not appropriate for the main description can go here.
    REMOVE the section if you're just going to restate the intro line! -->
 
: Part of the new spam reporting API calls added in 2.1, currently unprotected. Use [[API_CanComplainChat|CanComplainChat]](lineID) to see if the specified lineID is allowed to be reported. Abusing the spam-reporting APIs will get them protected. [http://forums.worldofwarcraft.com/thread.html?topicId=63167579&sid=1&pageNo=25]
 
: Reporting a user using this method puts the user's entire account on ignore for the duration of the session. [http://forums.worldofwarcraft.com/thread.html?topicId=102905050]
 
:The equivalent mail spam functions are [[API_ComplainInboxItem|ComplainInboxItem]](index) and [[API_CanComplainInboxItem|CanComplainInboxItem]](index)


:There is a limitation of 1 spam report per minute and 5 reports per day per account.
== Notes ==
* Abusing the spam-reporting API will get it protected. [http://forums.worldofwarcraft.com/thread.html?topicId=63167579&sid=1&pageNo=25]
* Complaining about a [[player]] squelches further communication from the target's [[account]] for the rest of the session. [http://forums.worldofwarcraft.com/thread.html?topicId=102905050]
* ''lineID'' can also be obtained from the player link. E.g. <code>local lineID = strmatch(link, ("|Hplayer:[^:]*:(%d+):.*|h")</code> - useful if using [[UIHANDLER_OnHyperlinkClick|OnHyperlinkClick]], [[UIHANDLER_OnHyperlinkEnter|OnHyperlinkEnter]], or [[UIHANDLER_OnHyperlinkLeave|OnHyperlinkLeave]].


See UnitPopup.lua lines 737-741 StaticPopup.lua lines 333-343, build 6739
== See Also ==
: API [[API CanComplainChat|CanComplainChat]]

Latest revision as of 04:45, 15 August 2023

← WoW API < ComplainChat

Complain about a specific chat message to the Game Masters. 

ComplainChat(lineID)
ComplainChat(author, [message])

Arguments[edit]

<number> lineID
This is the eleventh argument from CHAT_MSG events.
<string> author
The name of the player to complain about.
<string> message
The chat message to complain about.

Notes[edit]

  • Abusing the spam-reporting API will get it protected. [1]
  • Complaining about a player squelches further communication from the target's account for the rest of the session. [2]
  • lineID can also be obtained from the player link. E.g. local lineID = strmatch(link, ("|Hplayer:[^:]*:(%d+):.*|h") - useful if using OnHyperlinkClick, OnHyperlinkEnter, or OnHyperlinkLeave.

See Also[edit]

API CanComplainChat
Retrieved from "https://addonstudio.org/mw/index.php?title=WoW:API_ComplainChat&oldid=18691"