Plugin : Message

Author:Rex.Rainbow

Download

Properties

Class

  • Class of the table.

Class name

  • Class name for storing messages structure.

Page

  • Paging for reading.

Lines

  • Line count of each page.

Order

  • Order.
    • Options : ["Earlier to later","Later to earlier"]

Linked tables

  • Linked tables.

Sender class name

  • Class name for storing sender data structure. Set "" to ignore sender data.

Receiver class name

  • Class name for storing receiver data structure. Set "" to ignore receiver data.

Actions

Filter - 1. new

Action:New

  • Create a new message filter.

Filter - 2. senderID

Action:All senders

  • Add all senders into filter.

Action:Add sender

  • Add a sender into filter.
    • Sender ID ( string ) : Sender ID.

Filter - 3. receiverID

Action:All receivers

  • Add all receivers into filter.

Action:Add receiver

  • Add a receiver into filter.
    • Receiver ID ( string ) : Receiver ID.

Filter - 4. category

Action:All categories

  • Add all categories into filter.

Action:Add category

  • Add a category into filter.
    • Category ( string ) : Category.

Filter - 5. status

Action:All status

  • Add all status into filter.

Action:Add status

  • Add a status into filter.
    • Status ( string ) : Status.

Filter - 6. timestamp

Action:All timestamps

  • Add all timestamps into filter.

Action:Add timestamp constraint

  • Add a timestamp constraint into filter. They will be jointed by AND operation.
    • When ( Combo ) : Before or after the timestamp.
      • Options : ["Before","After"]
    • Timestamp ( number ) : Timestamp in milliseconds.
    • Include ( Combo ) : Include compared timestamp or excluded.
      • Options : ["Excluded","Included"]
    • Type ( Combo ) : Type of compared timestamp.
      • Options : ["Created","Updated"]

Initial

Action:Initial table

  • Initial table.

Load

Action:Request in a range

  • Request messages in a range.
    • Start ( number ) : Start index, 0-based.
    • Lines ( number ) : Count of lines
    • Content ( Combo ) : Get content.
      • Options : ["without","with"]

Action:Request to page

  • Request messages at page.
    • Index ( number ) : Page index, 0-based.
    • Content ( Combo ) : Get content.
      • Options : ["without","with"]

Action:Request current page

  • Request messages at current page.
    • Content ( Combo ) : Get content.
      • Options : ["without","with"]

Action:Request next page

  • Request messages at next page.
    • Content ( Combo ) : Get content.
      • Options : ["without","with"]

Action:Request previous page

  • Request messages at previous page.
    • Content ( Combo ) : Get content.
      • Options : ["without","with"]

Load - all

Action:Request all messages

  • Load all messages.
    • Content ( Combo ) : Get content.
      • Options : ["without","with"]

Load - messageID

Action:Load by messageID

  • Load message by messageID.
    • Message ID ( string ) : Message ID.

Action:Load by index

  • Load message by index.
    • Index ( number ) : Index of queried rows.

Queried messages count

Action:Get messages count

  • Get queried messages count. Maximum of 160 requests per minute.

Remove

Action:Remove by messageID

  • Remove message by messageID.
    • Message ID ( string ) : Message ID.

Action:Remove queried messages

  • Remove queried messages.

Action:Remove by index

  • Remove message by index.
    • Index ( number ) : Index of queried rows.

Send - Status

Action:Set status

  • Change status of message.
    • Message ID ( string ) : Message ID.
    • Status ( string ) : Status of this message.

Action:Set status by index

  • Change status of message by index.
    • Index ( number ) : Index of queried rows.
    • Status ( string ) : Status of this message.

Send - message

Action:Send

  • Send message.
    • Receiver UserID ( string ) : UserID of receiver.
    • Title ( string ) : Title of this message.
    • Content ( string ) : Content of this message. String or JSON string for object.
    • Category ( string ) : Category of this message for filtering.
    • Status ( string ) : Status of this message.

User info

Action:Set user

  • Set user info.
    • Sender ID ( string ) : Sender ID.

Expressions

Error

Expression:ErrorCode

  • Error code.

Expression:ErrorMessage

  • Error message.

Load - for each

Expression:CurSenderID

  • Get the current senderID in a For Each loop.

Expression:CurReceiverID

  • Get the current receiverID in a For Each loop.

Expression:CurTitle

  • Get the current title in a For Each loop.

Expression:CurContent

  • Get the current content in a For Each loop.

Expression:CurMessageID

  • Get the current messageID in a For Each loop.

Expression:CurSentAt

  • Get the current sent unix timestamp (number of milliseconds since the epoch) in a For Each loop.

Expression:CurStatus

  • Get the current status of message in a For Each loop.

Expression:CurSenderData

  • Get value of current sender data in a For Each loop.

Expression:CurReceiverrData

  • Get value of current receiver data in a For Each loop.

Load - for each - index

Expression:CurMessageIndex

  • Get the current message index in a For Each loop.

Expression:CurStartIndex

  • Get start index in current received page.

Expression:LoopIndex

  • Get loop index in current received page.

Queried messages count

Expression:LastMessagesCount

  • Get last queried messages count under "Condition: On get messages count complete".

Received

Expression:MessagesToJSON

  • Get all read messages in JSON string.

Expression:CurMessageCount

  • Get message count in current received page.

Received - index

Expression:Index2SenderID

  • Get senderID by index.
    • Index ( number ) : Index of queried rows.

Expression:Index2ReceiverID

  • Get receiverID by index.
    • Index ( number ) : Index of queried rows.

Expression:Index2Title

  • Get title by index.
    • Index ( number ) : Index of queried rows.

Expression:Index2Content

  • Get content by index.
    • Index ( number ) : Index of queried rows.

Expression:Index2MessageID

  • Get messageID by index.
    • Index ( number ) : Index of queried rows.

Expression:Index2SentAt

  • Get sent unix timestamp (number of milliseconds since the epoch) under "Condition: On load by messageID complete".
    • Index ( number ) : Index of queried rows.

Expression:Index2Status

  • Get status by index.
    • Index ( number ) : Index of queried rows.

Expression:Index2SenderData

  • Get sender data by index.
    • Index ( number ) : Index of queried rows.

Expression:Index2ReceiverData

  • Get receiver data by index.
    • Index ( number ) : Index of queried rows.

Received - messageID

Expression:LastFetchedSenderID

  • Get senderID under "Condition: On load by messageID".

Expression:LastFetchedReceiverID

  • Get receiverID under "Condition: On load by messageID".

Expression:LastFetchedTitle

  • Get title under "Condition: On load by messageID".

Expression:LastFetchedContent

  • Get content under "Condition: On load by messageID".

Expression:LastFetchedMessageID

  • Get messageID under "Condition: On load by messageID".

Expression:LastFetchedSentAt

  • Get sent unix timestamp (number of milliseconds since the epoch) under "Condition: On load by messageID complete".

Expression:LastFetchedStatus

  • Get status under "Condition: On load by messageID".

Expression:LastFetchedSenderData

  • Get sender data under "Condition: On load by messageID".

Expression:LastFetchedReceiverData

  • Get receiver data under "Condition: On load by messageID".

Remove

Expression:LastRemovedMessageID

  • Get last removed messageID under "Condition:On remove complete".

Send

Expression:LastSentMessageID

  • Get last sent messageID under "Condition:On send complete".

User info

Expression:MyUserID

  • Get my userID.

Conditions

Load

Condition:On received

  • Triggered when received messages.

Condition:On received error

  • Triggered when received messages error.

Condition:Last page

  • Return true if current page is the last page.

Load - for each

Condition:For each message

  • Repeat the event for each message.

Condition:For each message in a range

  • Repeat the event for each message in a range.
    • Start ( number ) : Start from message index (0-based).
    • End ( number ) : End to message index (0-based). This value should larger than Start.

Load by messageID

Condition:On load by messageID

  • Triggered when load by messageID message complete.

Condition:On load by messageID error

  • Triggered when load by messageID message error.

Queried messages count

Condition:On get messages count

  • Triggered when get messages count.

Condition:On get messages count error

  • Triggered when get messages count error.

Remove by messageID

Condition:On remove by messageID

  • Triggered when remove complete.

Condition:On remove by messageID error

  • Triggered when remove error.

Remove queried messages

Condition:On remove queried messages

  • Triggered when remove complete.

Condition:On remove queried messages error

  • Triggered when remove error.

Send - message

Condition:On send

  • Triggered when send complete.

Condition:On send error

  • Triggered when send error.

Send - status

Condition:On set status

  • Triggered when set status complete.

Condition:On set status error

  • Triggered when set status error.