Skip to content
This repository was archived by the owner on Dec 26, 2024. It is now read-only.

Message

Cyrille Giquello edited this page Jul 19, 2015 · 13 revisions

BotQ Message

Fields

id

The unique auto increment message identifier.

dev_status: done.

channel_id

The message's channel id. It's a foreign key.

dev_status: done.

label

The message label. It's some user text without software meaning.

dev_status: done.

priority

The message's priority permit to play a prioritized message and abort the current playing message.

dev_status: done.

priority_action

When a prioritized message arrived, the priority_action field informs how to interrupt (or not) the current playing one.

possibles values:

  • pause : interrupt but resume after prioritized message stopped;
  • stop : interrupt the current message and forget it
  • simult : do not interrupt the current message but simultaneous playing the prioritized one

default value:

  • pause

dev_status: todo.

play_loop

If no other message the current one can infinite play.

dev_status by content_type:

  • text/plain : done
  • application_url : done

play_at_time

The message will be played at this time, if there is not a prioritized message.

dev_status: done.

play_duration

If the message does not contains a timed content, like video, the play_duration field indicate how long to play the message, like a web page.

dev_status: done.

content_type

The message content type (the media type to play).

dev_status: see "content".

content

The data for content_type.

dev_status:

  • video: running
  • video/mp4: done
  • video/ogg: done
  • video/webm: done
  • video/flv: todo
  • video/youtube: todo
  • video/vimeo: todo
  • video/dailymotion: todo
  • application/url: done
  • content.url: done
  • content.css: done
  • application/tts: done
  • content.text: done
  • android tts server: done => look at https://github.com/Cyrille37/AndGWS
  • text/plain: done
  • content.text: done
  • content.css: done
  • application/service: running
  • content.command:
    • resetChannel: done

status_got

At the time the client start processing the message it say to server that it got the message. The message won't be sent any more to the client.

dev_status: done.

status_done

When the client finished playing a message it informs the server that it has done.

dev_status: done.

status_aborted

Like status_done but to tell that the message play was aborted, because of a prioritized message or something else.

dev_status: done.

created_at

ORM managed field to memorize the message created date & time. Eloquent timestamps().

dev_status: done.

updated_at

ORM managed field to memorize the message last updated date & time. Eloquent timestamps().

dev_status: done.

deleted_at

ORM managed field to memorize the message deleted date & time. Eloquent softDeletes().

dev_status: done.

Clone this wiki locally