usermessagemanager - TogetherGames/Public-Corona-Lua GitHub Wiki

The UserMessageManager class is used to find and fetch messages directly sent to the current session's User account. With this class, a developer will be able to create a message, delete a message, get all messages, and mark a message as read. A Developer can use UserMessages as in-game email.

Stores all the UserMessages contained in the Manager.

Adds a UserMessage to the internally managed list without persistence.

Note
This method is deprecated

UserMessageManager:Add( userMessage )

TogetherUserMessage userMessage

Instance of a UserMessage to add internally

Finds the UserMessage with the specified UserMessageID if it exists, otherwise returns nil.

UserMessageManager:FindByUserMessageID( userMessageID )

number userMessageID

The ID of the UserMessage to find

Gets the number of UserMessages currently managed internally.

UserMessageManager:GetCount(  )

Gets the UserMessage at the specified index if it exists, otherwise returns nil.

UserMessageManager:Get( index )

number index

The index of the UserMessage to find

Returns the index of the specified UserMessage if it exists, otherwise returns nil.

UserMessageManager:IndexOf( userMessage )

TogetherUserMessage userMessage

Instance of the UserMessage to find the index of

Returns the index of the UserMessage with the specified UserMessageID if it exists, otherwise returns -1.

UserMessageManager:IndexOfByUserMessageID( userMessageID )

number userMessageID

The ID of the UserMessage to find the index of

Removes a UserMessage from the internally managed list. This does not delete the message from the user's mailbox persistently.

Note
This method is deprecated

UserMessageManager:Remove( index )

number index

The index of the UserMessage to remove internally

Gets all UserMessages assigned to the User. Upon success, this will automatically update the internal mailbox.

UserMessageManager:GetAll( unreadOnly, startID, count, callbackFunc )

boolean unreadOnly

A Boolean indicating whether only unread messages should be retrieved.

The ID of the UserMessage to start with when returning UserMessages.

The max number of UserMessages to return.

The function to call upon completion.

Sends a message to a specific User. Upon success, this will automatically update the internal mailbox.

UserMessageManager:CreateMessage( destinationUserID, title, message, isGameIndependent, messageProperties, callbackFunc )

number destinationUserID

The ID of the User to send the UserMessage to.

The title of the UserMessage.

The message of the UserMessage.

A boolean indicating whether the generated UserMessage is assigned to the Game being played.

The properties to assign to the UserMessage. Pass in nil to assign no properties.

The function to call upon completion.

Marks a UserMessage as read. Upon success, this will automatically update the internal mailbox.

UserMessageManager:MarkMessageAsRead( userMessageID, callbackFunc )

number userMessageID

The ID of the UserMessage to mark as read.

The function to call upon completion.

Deletes a UserMessage. Upon success, this will automatically update the internal mailbox.

UserMessageManager:DeleteMessage( userMessageID, callbackFunc )

number userMessageID

The ID of the UserMessage to delete.

The function to call upon completion.