SocketMessageTypes.js

/*
 * The MIT License
 *
 * Copyright 2016 Kaleb Pace && Eli Davis.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */


module.exports = {
    /**
     * Message types that the Server recieves from the client
     */
    ToServerMessages: {
        
        /*
         * {
         *     albumArtRef: [],
         *     artist: "",
         *     durationMillis: "",
         *     genre: "",
         *     nid: "",
         *     title: ""
         * }
         */
        AddToQ: "AddToQ",
        
        /*
         * {
         *    uid: browser fingerprint
         *    songId: string of characters
         *    vote: -1 | 0 | 1
         * }
         */
        SetVote: "SetVote",

        /**
         * {
         *     name: username
         *     uid: browser fingerprint
         * }
         * 
         */
        SetUsername: "SetUsername",

        /**
         * {
         *     uid: browser fingerprint
         *     password: password
         * }
         */
        SetAdminPassword: "SetAdminPassword"
    },
    /**
     * Message types that the client recieves from the server
     */
    ToClientMessages: {
        /**
         * []
         */
        EntireQ: "EntireQ",
        
        /**
         *    message: ""
         */
        GreetingMessage: "GreetingMessage",

        /**
         * {
         *     albumArtRef: [],
         *     artist: "",
         *     durationMillis: "",
         *     genre: "",
         *     nid: "",
         *     title: ""
         * }
         */
        NowPlaying: "NowPlaying",

        /**
         * level: ""
         */
        SetAdminPrivledgeLevel: "SetAdminPrivledgeLevel",

        /**
         * "playing" | "finish" | "paused"
         */
        PlayerStatus: "PlayerStatus"
    }
};