Inter-Guild Link API Constants
In addition to constants that are useful when interacting with the API, the IGLAPIConstants table provides many additional named values that may be of use to other AddOn developers and which exceed the API that is documented here. Only those values that are specifically relevant to the Inter-Guild Link API are documented here; all others are documented within the IGLAPIConstants.lua file.

The constants used to interact with this API are somewhat hierarchical in that a relationship exists between Event Identifiers and Event Clarifying "ActionVerbs" (where provided), as illustrated here:
  • IGLAPIConstants.WOW_EVENT_CALENDAR_UPDATE_EVENT_LIST
    String constant form of the native Blizzard "CALENDAR_UPDATE_EVENT_LIST" event identifier. This is used to register call-back functions with IGLInterop.RegisterAllyEventListener() that will receive notification whenever the details of an allied guild calendar event become available to the local client. This event can occur only when both allied guilds mutually permit Guild Calendar Events to be shared over their link. This event notice is further clarified by an additional ActionVerb parameter, which will include one of:
    • IGLAPIConstants.API_VERB_CALENDAR_ADD
      Used to inform your call-back function (registered with IGLInterop.RegisterAllyEventListener()) of whenever a new allied Guild Calendar Event has been added. When your call-back function receives this event and ActionVerb combination, Inter-Guild Link has already added the new Guild Event to the local calendar. The identifying details of the new guild calendar event are provided as additional arguments. The full set of arguments that your call-back function will receive with this event/verb combination includes:
      • EventIdentifier=(string) Will be IGLAPIConstants.WOW_EVENT_CALENDAR_UPDATE_EVENT_LIST
      • GuildName=(string) Name of the allied guild from which this event originates
      • ActionVerb=(string) Will be IGLAPIConstants.API_VERB_CALENDAR_ADD
      • EventYear=(number) Calendar year of the guild event
      • EventMonth=(number) Calendar month index of the guild event
      • EventDay=(number) Calendar day-of-month of the guild event
      • EventHour=(number) Calendar hour index of the guild event
      • EventMinute=(number) Calendar minute of the guild event
      • EventTitle=(string) Title of the guild event
    • IGLAPIConstants.API_VERB_CALENDAR_REMOVE
      Used to inform your call-back function (registered with IGLInterop.RegisterAllyEventListener()) of whenever an allied Guild Calendar Event has been removed. When your call-back function receives this event and ActionVerb combination, Inter-Guild Link has already removed the Guild Event from the local calendar. The identifying details of the extinguished guild calendar event are provided as additional arguments. The full set of arguments that your call-back function will receive with this event/verb combination includes:
      • EventIdentifier=(string) Will be IGLAPIConstants.WOW_EVENT_CALENDAR_UPDATE_EVENT_LIST
      • GuildName=(string) Name of the allied guild from which this event originates
      • ActionVerb=(string) Will be IGLAPIConstants.API_VERB_CALENDAR_REMOVE
      • EventYear=(number) Calendar year of the guild event
      • EventMonth=(number) Calendar month index of the guild event
      • EventDay=(number) Calendar day-of-month of the guild event
      • EventHour=(number) Calendar hour index of the guild event
      • EventMinute=(number) Calendar minute of the guild event
      • EventTitle=(string) Title of the guild event
  • IGLAPIConstants.WOW_EVENT_CHAT_MSG_ADDON
    String constant form of the native Blizzard "CHAT_MSG_ADDON" event identifier. This is used to register call-back functions with IGLInterop.RegisterAllyEventListener() that will receive notification whenever an allied guild member is transmitting other AddOn data via the Guild or Officer chat channels. This event can occur only when both allied guilds mutually permit Other AddOn Data to be shared over their link. The sender's name, AddOn prefix, and AddOn data package are provided as additional arguments. There are no further clarifying ActionVerbs for this event. The full set of arguments that your call-back function will receive with this event identifier includes:
    • EventIdentifier=(string) Will be IGLAPIConstants.WOW_EVENT_CHAT_MSG_ADDON
    • GuildName=(string) Name of the allied guild from which this event originates
    • ChatType=(string) Type of chat channel from which the event was originally received; will be one of:
      • IGLAPIConstants.WOW_CHATTYPE_GUILD
        String constant form of the native Blizzard "GUILD" chat type identifier, identifying the guild chat channel as the target of the message.
      • IGLAPIConstants.WOW_CHATTYPE_OFFICER
        String constant form of the native Blizzard "OFFICER" chat type identifier, identifying the guild officer chat channel as the target of the message.
    • SenderName=(string) Name of the allied guild member who originated this event (may not be the name of the allied guild relay if someone other than the allied guild relay originated the event)
    • AddOnPrefix=(string) Internal prefix identifier used by the other AddOn that originated this event
    • AddOnData=(string) Serialized data as sent from the other AddOn
  • IGLAPIConstants.WOW_EVENT_CHAT_MSG_GUILD
    String constant form of the native Blizzard "CHAT_MSG_GUILD" event identifier. This is used to register call-back functions with IGLInterop.RegisterAllyEventListener() that will receive notification whenever an allied guild member sends a guild chat message. This event can occur only when both guild are allied, either mutually or by Ally-of-Ally. There are no further clarifying ActionVerbs for this event. The full set of arguments that your call-back function will receive with this event identifier includes:
    • EventIdentifier=(string) Will be IGLAPIConstants.WOW_EVENT_CHAT_MSG_GUILD
    • GuildName=(string) Name of the allied guild from which this event originates
    • SenderName=(string) Name of the allied guild member who originated this event (may not be the name of the allied guild relay if someone other than the allied guild relay originated the event)
    • ChatMessage=(string) The entire original chat message
    • EventTarget=(string) Target of the chat message event
    • AwayType=(string) AFK/Away/DND state of the sender
    • SenderGUId=(string) GUId of the sender
  • IGLAPIConstants.WOW_EVENT_CHAT_MSG_GUILD_ACHIEVEMENT
    String constant form of the native Blizzard "CHAT_MSG_GUILD_ACHIEVEMENT" event identifier. This is used to register call-back functions with IGLInterop.RegisterAllyEventListener() that will receive notification whenever an allied guild or allied guild member earns an in-game achievement. This event can occur only when both allied guilds mutually permit Achievements to be shared over their link. There are no further clarifying ActionVerbs for this event. The full set of arguments that your call-back function will receive with this event identifier includes:
    • EventIdentifier=(string) Will be IGLAPIConstants.WOW_EVENT_CHAT_MSG_GUILD_ACHIEVEMENT
    • GuildName=(string) Name of the allied guild from which this event originates
    • SenderName=(string) Name of the allied guild member who originated this event (may not be the name of the allied guild relay if someone other than the allied guild relay originated the event)
    • AchievementMessage=(string) The expanded Achievement message as it will be displayed to the remote user (so, its locale may not match that of the local client)
  • IGLAPIConstants.WOW_EVENT_CHAT_MSG_OFFICER
    String constant form of the native Blizzard "CHAT_MSG_OFFICER" event identifier. This is used to register call-back functions with IGLInterop.RegisterAllyEventListener() that will receive notification whenever an allied guild member sends and officer chat message. This event can occur only when both allied guilds mutually permit Officer Chat to be shared over their link. There are no further clarifying ActionVerbs for this event. The full set of arguments that your call-back function will receive with this event identifier includes:
    • EventIdentifier=(string) Will be IGLAPIConstants.WOW_EVENT_CHAT_MSG_OFFICER
    • GuildName=(string) Name of the allied guild from which this event originates
    • SenderName=(string) Name of the allied guild member who originated this event (may not be the name of the allied guild relay if someone other than the allied guild relay originated the event)
    • ChatMessage=(string) The entire original chat message
    • EventTarget=(string) Target of the chat message event
    • AwayType=(string) AFK/Away/DND state of the sender
    • SenderGUId=(string) GUId of the sender
  • IGLAPIConstants.WOW_EVENT_GUILD_MOTD
    String constant form of the native Blizzard "GUILD_MOTD" event identifier. This is used to register call-back functions with IGLInterop.RegisterAllyEventListener() that will receive notification whenever the Message of the Day for an allied guild has changed. This event can occur only when both allied guilds mutually permit Officer Chat to be shared over their link. There are no further clarifying ActionVerbs for this event. The full set of arguments that your call-back function will receive with this event identifier includes:
    • EventIdentifier=(string) Will be IGLAPIConstants.WOW_EVENT_GUILD_MOTD
    • GuildName=(string) Name of the allied guild from which this event originates
    • GuildMotD=(string) The new Message of the Day text
  • IGLAPIConstants.WOW_EVENT_GUILD_ROSTER_UPDATE
    String constant form of the native Blizzard "GUILD_ROSTER_UPDATE" event identifier. This is used to register call-back functions with IGLInterop.RegisterAllyEventListener() that will receive notification whenever the details of an allied member have changed in the local guild roster. This event can occur only when both guild are allied, either mutually or by Ally-of-Ally. This event notice is further clarified by an additional ActionVerb parameter, which will include one of:
    • IGLAPIConstants.API_VERB_ROSTER_MEMBER_NEW
      Used to inform your call-back function (registered with IGLInterop.RegisterAllyEventListener()) of whenever an allied guild member's details have been added to the roster cache. When your call-back function receives this event and ActionVerb combination, Inter-Guild Link has already added the new allied guild member to the local roster. The name of the new allied member is provided as an additional parameter. The full set of arguments that your call-back function will receive with this event/verb combination includes:
      • EventIdentifier=(string) Will be IGLAPIConstants.WOW_EVENT_GUILD_ROSTER_UPDATE
      • GuildName=(string) Name of the allied guild from which this event originates
      • ActionVerb=(string) Will be IGLAPIConstants.API_VERB_ROSTER_MEMBER_NEW
      • AffectedMemberName=(string) Name of the allied guild member whom the ActionVerb describes
    • IGLAPIConstants.API_VERB_ROSTER_MEMBER_UPDATE
      Used to inform your call-back function (registered with IGLInterop.RegisterAllyEventListener()) of whenever an allied guild member's details have been updated in the roster cache. When your call-back function receives this event and ActionVerb combination, Inter-Guild Link has already updated the allied guild member's details in the local roster. The name of the updated allied member is provided as an additional parameter. The full set of arguments that your call-back function will receive with this event/verb combination includes:
      • EventIdentifier=(string) Will be IGLAPIConstants.WOW_EVENT_GUILD_ROSTER_UPDATE
      • GuildName=(string) Name of the allied guild from which this event originates
      • ActionVerb=(string) Will be IGLAPIConstants.API_VERB_ROSTER_MEMBER_UPDATE
      • AffectedMemberName=(string) Name of the allied guild member whom the ActionVerb describes
    • IGLAPIConstants.API_VERB_ROSTER_ONLINE
      Used to inform your call-back function (registered with IGLInterop.RegisterAllyEventListener()) of whenever an allied guild member has come on-line or gone off-line. This ActionVerb can be present only only when both guilds mutually permit Online Notices over their link. When your call-back function receives this event and ActionVerb combination, Inter-Guild Link has already updated the local guild roster to reflect this change. The name of the updated allied member is provided as an additional parameter. The full set of arguments that your call-back function will receive with this event/verb combination includes:
      • EventIdentifier=(string) Will be IGLAPIConstants.WOW_EVENT_GUILD_ROSTER_UPDATE
      • GuildName=(string) Name of the allied guild from which this event originates
      • ActionVerb=(string) Will be IGLAPIConstants.API_VERB_ROSTER_ONLINE
      • AffectedMemberName=(string) Name of the allied guild member whom the ActionVerb describes
      • OnlineFlag=(number) 0=member went off-line, or 1=member came on-line
    • IGLAPIConstants.API_VERB_ROSTER_JOIN
      Used to inform your call-back function (registered with IGLInterop.RegisterAllyEventListener()) of whenever an allied guild member has joined an allied guild. This ActionVerb can be present only when both guilds mutually permit Membership Change notices over their link. When your call-back function receives this event and ActionVerb combination, Inter-Guild Link has already added the new allied guild member to the local guild roster. The name of the joining allied member is provided as an additional parameter. The full set of arguments that your call-back function will receive with this event/verb combination includes:
      • EventIdentifier=(string) Will be IGLAPIConstants.WOW_EVENT_GUILD_ROSTER_UPDATE
      • GuildName=(string) Name of the allied guild from which this event originates
      • ActionVerb=(string) Will be IGLAPIConstants.API_VERB_ROSTER_JOIN
      • AffectedMemberName=(string) Name of the allied guild member whom the ActionVerb describes
    • IGLAPIConstants.API_VERB_ROSTER_LEAVE
      Used to inform your call-back function (registered with IGLInterop.RegisterAllyEventListener()) of whenever an allied guild member has voluntarily left an allied guild. This ActionVerb can be present only when both guilds mutually permit Membership Change notices over their link. When your call-back function receives this event and ActionVerb combination, Inter-Guild Link has already removed the quitting allied guild member from the local guild roster. The name of the leaving allied member is provided as an additional parameter. The full set of arguments that your call-back function will receive with this event/verb combination includes:
      • EventIdentifier=(string) Will be IGLAPIConstants.WOW_EVENT_GUILD_ROSTER_UPDATE
      • GuildName=(string) Name of the allied guild from which this event originates
      • ActionVerb=(string) Will be IGLAPIConstants.API_VERB_ROSTER_LEAVE
      • AffectedMemberName=(string) Name of the allied guild member whom the ActionVerb describes
    • IGLAPIConstants.API_VERB_ROSTER_KICK
      Used to inform your call-back function (registered with IGLInterop.RegisterAllyEventListener()) of whenever an allied guild member has been involuntarily kicked from an allied guild. This ActionVerb can be present only when both guilds mutually permit Membership Change notices over their link. When your call-back function receives this event and ActionVerb combination, Inter-Guild Link has already removed the undesired allied guild member from the local guild roster. The names of the kicked allied member and the the officer who performed the kick are provided as an additional arguments. The full set of arguments that your call-back function will receive with this event/verb combination includes:
      • EventIdentifier=(string) Will be IGLAPIConstants.WOW_EVENT_GUILD_ROSTER_UPDATE
      • GuildName=(string) Name of the allied guild from which this event originates
      • ActionVerb=(string) Will be IGLAPIConstants.API_VERB_ROSTER_KICK
      • AffectedMemberName=(string) Name of the allied guild member whom the ActionVerb describes
      • AffectorMemberName=(string) Name of the allied guild officer whom performed the action
    • IGLAPIConstants.API_VERB_ROSTER_PROMOTE
      Used to inform your call-back function (registered with IGLInterop.RegisterAllyEventListener()) of whenever an allied guild member has been promoted within an allied guild. This ActionVerb can be present only when both guilds mutually permit Member Rank Change notices over their link. When your call-back function receives this event and ActionVerb combination, Inter-Guild Link has already updated the guild roster to reflect this change. The names of the promoted allied member and the the officer who performed the promotion are provided as an additional arguments. The full set of arguments that your call-back function will receive with this event/verb combination includes:
      • EventIdentifier=(string) Will be IGLAPIConstants.WOW_EVENT_GUILD_ROSTER_UPDATE
      • GuildName=(string) Name of the allied guild from which this event originates
      • ActionVerb=(string) Will be IGLAPIConstants.API_VERB_ROSTER_PROMOTE
      • AffectedMemberName=(string) Name of the allied guild member whom the ActionVerb describes
      • AffectorMemberName=(string) Name of the allied guild officer whom performed the action
    • IGLAPIConstants.API_VERB_ROSTER_DEMOTE
      Used to inform your call-back function (registered with IGLInterop.RegisterAllyEventListener()) of whenever an allied guild member has been demoted within an allied guild. This ActionVerb can be present only when both guilds mutually permit Member Rank Change notices over their link. When your call-back function receives this event and ActionVerb combination, Inter-Guild Link has already updated the guild roster to reflect this change. The names of the demoted allied member and the the officer who performed the demotion are provided as an additional arguments. The full set of arguments that your call-back function will receive with this event/verb combination includes:
      • EventIdentifier=(string) Will be IGLAPIConstants.WOW_EVENT_GUILD_ROSTER_UPDATE
      • GuildName=(string) Name of the allied guild from which this event originates
      • ActionVerb=(string) Will be IGLAPIConstants.API_VERB_ROSTER_DEMOTE
      • AffectedMemberName=(string) Name of the allied guild member whom the ActionVerb describes
      • AffectorMemberName=(string) Name of the allied guild officer whom performed the action
  • IGLAPIConstants.WOW_EVENT_TRADE_SKILL_UPDATE
    String constant form of the native Blizzard "TRADE_SKILL_UPDATE" event identifier. This is used to register call-back functions with IGLInterop.RegisterAllyEventListener() that will receive notification whenever an allied guild member has changed or improved a primary Trade Skill (Profession). This event can occur only when both guild are allied, either mutually or by Ally-of-Ally. When your call-back function receives this event identifier, Inter-Guild Link has already updated the local guild roster to reflect the change. There are no further clarifying ActionVerbs for this event. The full set of arguments that your call-back function will receive with this event identifier includes:
    • EventIdentifier=(string) Will be IGLAPIConstants.WOW_EVENT_TRADE_SKILL_UPDATE
    • GuildName=(string) Name of the allied guild from which this event originates
    • SenderName=(string) Name of the allied guild member who originated this event
    • TradeName=(string) Name of the Trade Skill (Profession) that is being updated for the specified SenderName
    • TradeCategoryId=(number) Internal Trade Skill (Profession) identifier that is being updated for the specified sender
    • SenderSkillLevel=(number) SenderName's proficiency level in the identified Trade Skill (Profession)
    • TradeLink=(string) Trade Skill (Profession) Hyperlink comprising full details of SenderName's recipe book for the identified trade
 
Stats
Files: 0
Downloads: 0
Favorites: 0

Menu
» Home



Content

New & Updated


WOWInterface