Back to index...

NameTypeDeprecatedSecureDescription
Command.Message.AcceptfunctionSets the environment to accept a given type and identifier of message. Parameters can be replaced...
Command.Message.BroadcastfunctionBroadcast an unreliable addon message to some number of targets. This message will be dropped sil...
Command.Message.RejectfunctionSets the environment to reject a given type and identifier of message. Directly cancels out singl...
Command.Message.SendfunctionSend an reliable addon message to a single target. The callback will respond with success only o...
Event.Message.ReceiveSignals the receipt of an addon message.
Inspect.Message.Accept.CheckfunctionChecks whether a given message type would be accepted if it were sent to you. Parameters can be r...
Inspect.Message.Accept.ListfunctionRetrieves the list of accepted message types and identifiers.
Utility.Message.LimitsfunctionReturns information on the message bandwidth limits.
Utility.Message.SizefunctionReturns the size of a message, as used for bandwidth control.

Command.Message.Accept

Sets the environment to accept a given type and identifier of message. Parameters can be replaced with "nil" to act as a wildcard.

Usage:

Command.Message.Accept(type, identifier)
ParameterTypeDatatypeDescription
identifierparameterstring/nilThe identifier type of the message. Used for the receiver to filter accepted messages via the Command.Message.Accept() function. Must be at least three characters long.
typeparameterstring/nilThe type of message. Valid types include "tell", "channel", "guild", "officer", "party", "raid", "say", "yell", "send".

Command.Message.Broadcast

Broadcast an unreliable addon message to some number of targets. This message will be dropped silently if the targets do not have the available bandwidth to receive it. The callback will respond with failure only if the message's target is invalid. "tell" messages are subject to the same restrictions as Command.Message.Send(). This command is throttled by the "message" throttle type.

Usage:

Command.Message.Broadcast(type, target, identifier, data)
Command.Message.Broadcast(type, target, identifier, data, callback)
ParameterTypeDatatypeDescription
callbackparametercallbackfunctionA standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
dataparameterstringThe data to send. This parameter is binary-safe.
identifierparameterstringThe identifier type of the message. Used for the receiver to filter accepted messages via the Command.Message.Accept() function. Must be at least three characters long.
targetparameterstring/nilThe target of this message. Required for "channel" or "tell" message types, must be nil otherwise.
typeparameterstringThe type of message to send. Valid types include "tell", "channel", "guild", "officer", "party", "raid", "say", "yell".

Command.Message.Reject

Sets the environment to reject a given type and identifier of message. Directly cancels out single calls to Command.Message.Accept.

Usage:

Command.Message.Reject(type, identifier)
ParameterTypeDatatypeDescription
identifierparameterstring/nilThe identifier type of the message. Used for the receiver to filter accepted messages via the Command.Message.Accept() function. Must be at least three characters long.
typeparameterstring/nilThe type of message. Valid types include "tell", "channel", "guild", "officer", "party", "raid", "say", "yell", "send".

Command.Message.Send

Send an reliable addon message to a single target. The callback will respond with success only once the server has accepted the message for processing and queueing. Failure may occur if the target is invalid or if the target's receive queue is full. Messages may be sent only to players that are nearby, in your guild, in your party or raid, or that have sent you a message or tell during this session. This command is throttled by the "message" throttle type.

Usage:

Command.Message.Send(target, identifier, data, callback)
ParameterTypeDatatypeDescription
callbackparametercallbackfunctionA standard command callback, used for detecting success or failure. See the "callbackfunction" documentation for more details.
dataparameterstringThe data to send. This parameter is binary-safe.
identifierparameterstringThe identifier type of the message. Used for the receiver to filter accepted messages via the Command.Message.Accept() function. Must be at least three characters long.
targetparameterstringThe name of the player to send the message to.

Event.Message.Receive

Signals the receipt of an addon message.

Usage:

Event.Message.Receive(from, type, channel, identifier, data)
ParameterTypeDatatypeDescription
channelparameter<nope>If type is "channel", the channel that this message was sent to. Otherwise, nil.
dataparameter<nope>The data payload for this message type.
fromparametervariantThe name of the player this message is from.
identifierparameter<nope>The identifier for this message.
typeparameter<nope>The type of this message. May be any of "send", "tell", "channel", "guild", "officer", "party", "raid", "say", or "yell".

Inspect.Message.Accept.Check

Checks whether a given message type would be accepted if it were sent to you. Parameters can be replaced by "nil" to check for wildcard acceptance.

Usage:

accepted = Inspect.Message.Accept.Check(type, identifier)
ParameterTypeDatatypeDescription
identifierparameterstring/nilThe identifier type of the message. Used for the receiver to filter accepted messages via the Command.Message.Accept() function. Must be at least three characters long.
typeparameterstring/nilThe type of message. Valid types include "tell", "channel", "guild", "officer", "party", "raid", "say", "yell", "send".
acceptedresultbooleanTrue if the message would be transferred to this client.

Inspect.Message.Accept.List

Retrieves the list of accepted message types and identifiers.

Usage:

accepts = Inspect.Message.Accept.List()
ParameterTypeDatatypeDescription
acceptsresulttableList of all accepted message types. Takes the form of a key/value table. The key is a table containing {type, identifier}, where either element may be nil to indicate a wildcard. The value is the number of times this type has been accepted.

Utility.Message.Limits

Returns information on the message bandwidth limits.

Usage:

data = Utility.Message.Limits()
ParameterTypeDatatypeDescription
dataresulttableThe requested data.
members
burst The amount of data that can be sent or received without being subject to throttling.
maximum Maximum allowed message size.
sustained Amount of data that can be transferred per second without dropping messages.

Utility.Message.Size

Returns the size of a message, as used for bandwidth control.

Usage:

size = Utility.Message.Size(to, identifier, data)
ParameterTypeDatatypeDescription
dataparameterstringThe data to send. This parameter is binary-safe.
identifierparameterstringThe identifier type of the message. Used for the receiver to filter accepted messages via the Command.Message.Accept() function. Must be at least three characters long.
toparameterstring/nilThe name of the player or channel to send to. nil if this is not targeted at a specific player or channel.
sizeresultnumberThe calculated size of the message.

Back to index...