com.wialon.core

Class MessagesLoader

java.lang.Object

com.wialon.core.MessagesLoader

public class MessagesLoader
extends java.lang.Object

Wialon messages loader object. Allow to load messages from units, users, resources into session, retrieve and delete them.

Constructor Summary

Constructors

Constructor and Description
MessagesLoader()

Method Summary

Methods

Modifier and Type	Method and Description
void	deleteMessage(int msgIndex, ResponseHandler callback) Delete message from database, it is not possible to delete unit last message or latest message with position information.
void	getMessages(int indexFrom, int indexTo, MessagesResponseHandler callback) Get messages data for given indices
void	getPackedMessages(long itemId, long timeFrom, long timeTo, ResponseHandler callback)
void	loadInterval(long itemId, long timeFrom, long timeTo, long flags, long flagsMask, int loadCount, MessagesResponseHandler callback) Load messages for given time interval, require ACL wialon.core.Item.accessFlag.execReports
void	loadLast(long itemId, long lastTime, int lastCount, long flags, long flagsMask, int loadCount, MessagesResponseHandler callback) Load last N messages, require ACL wialon.core.Item.accessFlag.execReports
void	unload(ResponseHandler callback) Unload loaded messages

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MessagesLoader

public MessagesLoader()

Method Detail

loadInterval

public void loadInterval(long itemId,
                long timeFrom,
                long timeTo,
                long flags,
                long flagsMask,
                int loadCount,
                MessagesResponseHandler callback)

Load messages for given time interval, require ACL wialon.core.Item.accessFlag.execReports

Parameters:

itemId - item Id for which to load messages

timeFrom - interval beginning

timeTo - interval ending

flags - messages flags, see wialon.messages.Message.messageFlag for possible values

flagsMask - messages flags mask, see wialon.messages.Message.messageFlag for possible values

loadCount - how many message to pass initially in callback

callback - callback function that is called after messages are loaded, result: {count: N, messages: [...]}

loadLast

public void loadLast(long itemId,
            long lastTime,
            int lastCount,
            long flags,
            long flagsMask,
            int loadCount,
            MessagesResponseHandler callback)

Load last N messages, require ACL wialon.core.Item.accessFlag.execReports

Parameters:

itemId - item Id for which to load messages

lastTime - time of end of interval, to get last count messages paass zero

lastCount - how many last messages will be loaded, value should be between 1 and 10000

flags - messages flags, see wialon.item.Item.messageFlag for possible values

flagsMask - messages flags mask, see wialon.item.Item.messageFlag for possible values

loadCount - how many message to pass initially in callback

callback - callback function that is called after messages are loaded, result: {count: N, messages: [...]}

unload

public void unload(ResponseHandler callback)

Unload loaded messages

Parameters:

callback - callback function that is called after messages unloaded

getMessages

public void getMessages(int indexFrom,
               int indexTo,
               MessagesResponseHandler callback)

Get messages data for given indices

Parameters:

indexFrom - {Integer} starting index (inclusive)

indexTo - {Integer} ending index (inclusive)

callback - {Function?null} callback, that get result in form callback(code, col), where zero code mean success, and col is a collection of requested messages

deleteMessage

public void deleteMessage(int msgIndex,
                 ResponseHandler callback)

Delete message from database, it is not possible to delete unit last message or latest message with position information. Require ACL wialon.core.Unit.accessFlag.deleteMessages over item. Only messages from units can be deleted.

Parameters:

msgIndex - message indexes from loaded into layer for deletion

callback - {Function?null} callback, that get result in form callback(code), where zero code mean successful message deletion

getPackedMessages

public void getPackedMessages(long itemId,
                     long timeFrom,
                     long timeTo,
                     ResponseHandler callback)