Skip to content

Latest commit

 

History

History
129 lines (81 loc) · 2.9 KB

4. APIs.md

File metadata and controls

129 lines (81 loc) · 2.9 KB
Raw

APIs

View in korean version

{room}/slide/

new_slide

  • Create a new slide.
  • Client to Server ; (request)
  • Server to Client ; slide id

del_slide

  • Delete a slide.
  • Client to Server ; slide id
  • Server to Client ; slide id

change_slide

  • Change or Save contents of a slide.
  • Client to Server ; slide id, patch_text(not a DB field), pre_hash(not a DB field), curr_hash(not a DB field)
  • Server to Client ; slide id, patch_test(not a DB field), pre_hash(not a DB field), curr_hash(not a DB field)

get_slide

  • View contents of a slide.
  • Client to Server ; slide id, room label
  • Server to Client ; slide markdown blob

change_slide_order

  • Change the order of slides.
  • Client to Server ; slide id, slide next id
  • Server to Client ; slide id, slide next id

curr_slide

  • Check a room admin's current slide.
  • Client to Server ; slide id
  • Server to Client ; slide id

rename_slide

  • Rename a slide title.
  • Client to Server ; slide id, slide title
  • Server to Client ; slide id, slide title

get_slide_diff

  • Get a local slide contents and remote slide contents diff.
  • Client to Server ; slide id, hash(not a DB field)
  • Server to Client ; slide id, patch_test(not a DB field), pre_hash(not a DB field), curr_hash(not a DB field)

{room}/room/

set_title

  • Set a room title.
  • admin_user to Server ; room title, room label

get_title

  • Load a room title.
  • Server to user (not only a admin_user) ; room title

check_admin

  • Authenticate admin user.
  • Client to Server ; user session
  • Server to Client ; is_admin

{room}/chat/

new_chat

  • Send a new chat(or reply chat).
  • Client to Server (is_reply=false) ; description(=message), is_reply
  • Client to Server (is_reply=true) ; description, is_reply, hash(existing hash)
  • Server to Client (is_reply=false) ; time, description, is_reply, hash(newly generated)
  • Server to Client (is_reply=true) ; time, description, is_reply

get_all_chat

  • Get the list of chat and replies.

{room}/notice/

new_notice

  • Send a new notice.
  • Client to Server ; description(=message)
  • Server to Client ; description, time

get_list_notice

  • Get the list of notices.

{room}/poll/

new_poll

  • Create a new poll.
  • admin_user to Server ; question, answers

start_poll

  • Start a poll.
  • Server to user(except for admin_user) ; question, answers

end_poll

  • End a poll(=Reply a poll).
  • user(except for admin_user) to Server ; answer index

result_poll

  • Create a poll result chart.
  • Server to all user ; question, answers, answer count

get_list_poll

  • Get the list of polls.
  • Server to Client ; question, answers, answer count, hash_value

get_poll

  • Get poll results.
  • user to Server ; hash_value