Skip to content
This repository has been archived by the owner on Jun 17, 2024. It is now read-only.
/ speakerslist Public archive

Speakerslist is a project, to simplify meetings by a digital speakerslist. It is divided into two components, on the one hand the public API and on the other hand the flexible GUI.

Notifications You must be signed in to change notification settings

eknoes/speakerslist

Repository files navigation

Speakerslist

Speakerslist is a project, to simplify meetings by a digital speakerslist. It is divided into two components, on the one hand the public API and on the other hand the flexible GUI.

API Specification

Speakerslist provides a simple API.

Objects

  • SpeakerList String id: Unique identifier of a list Array knownSpeakers: Array of already added Speakers, e.g. for autocompletion Array queue: Speakers in the order they are allowed to speak boolean sexBalanced: if true, the speakers are tried to order balanced by gender. default false boolean preferNewSpeaker: if true, new speaker are preferred. default false

  • Speaker String uid: Unique identifier of a Speaker String name: Name of the Speaker String sex: Gender of the speaker (male|female|mixed) boolean hasSpoken: if true, the speaker has already spoken to the current topic

v0 Methods

Creating a list

  • /newList return SpeakerList-Object Creates a new list.

List operations

List operations are called by /list/$id

  • (without operation) Gets the list. return SpeakerList Object with id = $id

  • /addSpeaker Adds a speaker to the queue. return Updated SpeakerList Object

    Parameter $name When called with name as parameter, a new Speaker is created and added to the queue. If a speaker with this name already exists, the existing Speaker is added to the queue.

    Parameter $uid When called with uid as parameter, the Speaker with uid = $uid is added to the queue.

  • /changeSpeaker Changes a speakers gender. return Updated SpeakerList Object

    Parameters $uid, $gender Changes the Speaker with uid = $uid to the given gender. $gender = (male|female|mixed)

About

Speakerslist is a project, to simplify meetings by a digital speakerslist. It is divided into two components, on the one hand the public API and on the other hand the flexible GUI.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published