Skip to content

Requirements

Jump to bottom
William Amos edited this page Oct 10, 2022 · 5 revisions

  1. Client app can connect to Server app (R)

    1. Auto negotiate encryption key exchange (R): Have the server and client agree on a shared key for encrypting data sent between the two.

    2. Allow a user defied pre-shared key (password) (R): Rather than the server and client picking an encryption key, allow the user to create one themselves.

    3. Encryption of data sent between client and server (R): Encrypt the traffic between the client and server application

    4. Rest API server side (R): API endpoints for client to send data to.

      1. New device pairing endpoints (R): The endpoints required to initiate device pairing, negotiate a key
        1. Device rename, config changes, unpair (delete) requests. /api/v1/client/{clientId} (R): Allows the client to send data notifying the server of configuration changes (name, settings) and to unpair/remove the client.
        2. Encryption negotiation endpoint /api/v1/client/encryption (R): Used to negotiate a key and check/test encryption settings.
        3. Pair request /api/v1/pair (R): Allows the client to initiate pairing, agree on "ids" and other pairing related details.
      2. Notification endpoint(s) /api/v1/notifications/{clientId}}#{notificationId} (R): Endpoints required to receive notification details, icons, etc
        1. POST: new notification data
        2. PUT: update notification
        3. DELETE: remove
      3. File endpoints (D): Endpoints required for receiving files and notifying the server on successful download
        1. Notify of incoming file, send file metadata /api/v1/files/{clientId}/incoming (D): Endpoint for the client to tell the server of an incoming file, share data about the file
        2. Actual file upload endpoint /api/v1/files/{clientId}/upload (D): Where the client would send the file data
      4. Clipboard endpoints (D): Same as above, for receiving clipboard data (text, separate for "file" data (think photos and files)).
        1. Send text clipboard data, notify of incoming clipboard contents /api/v1/clipboard/{clientId}/incoming (D): Endpoint for the client to tell the server of an incoming file, share data about the file
        2. Actual file upload endpoint /api/v1/clipboard/{clientId}/upload (D): Where the client would send file data if required (photos and files)

    5. Rest API client side (R): API endpoints for server to send data to.

      1. New device pairing endpoints (R): The endpoints required to initiate device pairing, negotiate a key
        1. Device rename, config changes, unpair (delete) requests. /api/v1/server /{serverId} (R): Allows the server to send data notifying the client of configuration changes (name, settings) and to unpair/remove the server.
        2. Encryption negotiation endpoint /api/v1/server/encryption (R): Used to negotiate a key and check/test encryption settings.
        3. Pair request /api/v1/pair (R): Allows the server to initiate pairing, agree on "ids" and other pairing related details.
      2. Notification endpoint(s) /api/v1/notifications/{serverId}#{notificationId} (R): Endpoints required to tell the client to dismiss, activate or any other interaction with notifications
        1. POST: interact with notification (inline reply, clicked, button clicked, etc)
        2. DELETE: dismiss notification
      3. File endpoints (D): Endpoints required for receiving files and notifying the client on successful download
        1. Notify of incoming file, send file metadata /api/v1/files/{serverId}/incoming (D): Endpoint for the client to tell the client of an incoming file, share data about the file
        2. Actual file upload endpoint /api/v1/files/{serverId}/upload (D): Where the server would send the file data
      4. Clipboard endpoints (D): Same as above, for receiving clipboard data (text, separate for "file" data (think photos and files)).
        1. Send text clipboard data, notify of incoming clipboard contents /api/v1/clipboard/{serverId}/incoming (D): Endpoint for the server to tell the client of an incoming file, share data about the file
        2. Actual file upload endpoint /api/v1/clipboard/{serverId}/upload (D): Where the server would send file data if required (photos and files)

  2. Sends client notifications to server (R)

    1. Basic details (title, notification body) (R): Be able to receive basic details on the server side
    2. Receives notifications on server (R)
    3. Able to change which app's notifications your client app sends (R)
    4. Activate notification (D): When you click (activate) a notification on the server, simulate a "tap" (activate) on the client side
    5. Send "dismissed" action to client (D): When you dismiss (remove/clear) a notification on the server, simulate that on the client side
    6. Update on notification removal (client -> server) (D): When the notification is removed, activated, or otherwise gone on the client side remove it from the server side. (dev note: this requires remembering the notification ids on server side).
    7. Notification history on server (D): On the right side of the home screen for the server application there was a list of the "recent device notifications"
    8. Send client battery life to server (A)
    9. Ability to use inline reply function of notifications (A): Android allows replies to be sent via notifications. Allow this to be done on the server side and send that data to the client.

  3. Send files from client app (D): Allow the user to choose whether they would like to allow file sharing between the client and server app.

    1. Receive files on server (D)
      1. Allow user to choose the destination folder of the sent files (D)
      2. Notify the user upon file received (D): Allow the user to choose whether they wish to receive notifications upon receiving a file or not.
        1. Automatically accept files sent to the server by client (A): The user has the choice of automatically accepting files sent to them by connected clients or approving/disapproving files sent to them by connected clients.

  4. Send file from server application (D): Allow the user to choose whether they would like to allow file sharing between the server app and client app.

    1. Receive those files on the client side (D)
      1. Allow user to choose the destination folder of the sent files (D)
      2. Notify the user upon file received (D): Allow the user to choose whether they wish to receive notifications upon receiving a file or not.
        1. Automatically accept files sent to the server by client (A): The user has the choice of automatically accepting files sent to them by connected clients or approving/disapproving files sent to them by connected clients.

  5. Send clipboard data from client app (D): Send clipboard contents to the server. Allow the user to choose whether they wish to use the clipboard or not.

    1. Receive clipboard data on server (D): Receive and act on that clipboard data (put into server's clipboard).
      1. Text data (D): Send text data to the server and have the server put that into its clipboard
      2. Picture data (D): If a picture is in the client's clipboard, send the photo itself to the server
    2. Send clipboard data upon clicking the send clipboard button (D): Tells the client to update its clipboard with the data sent by the server.
    3. Receive clipboard data upon clicking the receive clipboard button (D): Requests the clipboard data be sent from the client to the server.
    4. Automatically send clipboard data (A): Allow the user to choose between automatically sending clipboard data (send when updated) and manually sending clipboard data using the send clipboard button.

  6. Send clipboard data from server application (D): Send clipboard contents to the client. Allow the user to choose whether they wish to use the clipboard or not.

    1. Receive those files on the client side (D): Receive and act on that clipboard data (put into client's clipboard)
      1. Text data (D): Send text data to the client and have the client put that into its clipboard
      2. Picture data (D): If a picture is in the server's clipboard, send the photo itself to the client
    2. Send clipboard data upon clicking the send clipboard button (D): Tells the server to update its clipboard with the data sent by the client.
    3. Receive clipboard data upon clicking the receive clipboard button (D): Requests the clipboard data be sent from the server to the client.
    4. Automatically send clipboard data (A): Allow the user to choose between automatically sending clipboard data (send when updated) and manually sending clipboard data using the send clipboard button .

  7. Add new devices (R)

    1. Add new servers to your client app (R).
    2. Able to connect to new client devices on server app (R)

  8. Rename devices (D)

    1. Able to rename client device (D): Be able to change the friendly name of the client device.
    2. Able to rename server device (D): Be able to change the friendly name of the server instance.

  9. Remove devices (R)

    1. Able to remove devices from the client side upon clicking the delete device button.
    2. Able to remove devices from the server side by clicking the delete button.

  10. Allow user to open "Server Settings" page (R): While in the server app, the user can click on the "File" tab in the top left of the screen followed by the "Server Settings" tab to see information including the server device's name and listening IP address.

    1. Users can send a sample notification using the test notification button (D).
    2. Users can exit the "Server Settings" page by clicking the exit button (R).

  11. Allow the user to open the "Device Connection Details" page (R): While in the server app the user can click on the "File" tab at the top left of the screen followed by the "Device Connection Details" tab to see information about the currently connected and selected device.

    1. Users can test connection latency using the ping button (D).
    2. Users can exit the "Device Connection Details" page upon clicking the exit button (R).

  12. Allow the user to open the "About" page to learn information about the project (D): While in the server application, the user can click on the help tab at the top of the screen and click about. This will display a page with the name of the project, version info, a link to the GitHub repository, and our names.

Clone this wiki locally