README.md

Welcome to AresLabs!

As a provider of physical security for properties on Mars, we are always striving to bring the best and most innovative solutions to our clients. As part of this effort, we have developed a digital aspect to our services, including a vert.x gateway wrapper to help manage and secure your Martian property.

This documentation covers the various event types and responses available through the vert.x gateway wrapper. It is designed to help you understand the functionality of the wrapper and how to effectively use it to protect your Martian property.

We hope this documentation serves as a helpful resource as you utilize the vert.x gateway wrapper and the other digital security tools we offer at AresLabs. If you have any questions or need further assistance, please don't hesitate to reach out to our team. We are here to help you keep your property safe and secure.

Table of Contents

• Welcome
• Quickstart
  • Backend
  • Frontend
• Frontend (Client)
  • Introduction to the Client Wrapper
  • Waiting for connection
  • Querying the Server
    • Adding a query type
    • Executing a query
  • Listening for events
    • Adding an event type
    • Listening for an event
• Backend
  • Introduction with the backend
    • Handling events
      • Handling requests
    • Managing sessions
    • Sending messages
      • Common types
    • Performing database operations
• Events
  • What are events?
    • Internal events
      • session
      • subscribe
    • Queries
      • User related queries
        • queries.get-user
        • queries.get-users
        • queries.get-user-properties
      • Equipment related queries
        • queries.dispatch-drone
        • queries.get-dispatched-drones
        • queries.get-free-drones
        • queries.recall-drone
      • Property related queries
        • queries.add-property
        • queries.remove-property
        • queries.get-property
        • queries.get-property-detailed
        • queries.get-properties
        • queries.change-property-size
        • queries.change-property-coordinates
        • queries.change-property-status
        • queries.get-pending-properties**
        • queries.add-equipment
        • queries.remove-equipment
        • queries.get-equipment
        • queries.change-property-tier
        • queries.search-pending-properties
        • queries.search-removal-properties
        • queries.request-remove-property
        • queries.get-requested-remove-properties**
        • queries.approve-remove-property
        • queries.get-allowed-users
        • queries.add-allowed-user
        • queries.remove-allowed-user
        • queries.get-alerts
        • queries.add-alert
        • queries.get-weekly-visitors
        • queries.add-visitor
        • queries.get-scanned-visitors
        • queries.get-crimes-in-area
        • queries.add-crime
        • queries.get-auth-entries
        • queries.add-auth-entry
    • Subscriptions
      • About events
      • events.all
      • events.alerts
      • events.visits
      • events.crimes
      • events.scanned
      • events.auth-entries
      • events.property-added
      • events.property-status-change
      • events.property-equipment-change
      • events.requested-remove-property
      • events.approved-remove-property
      • events.drone-dispatched
      • events.drone-recalled
      • events.property-coordinates-changed
      • events.property-size-changed
      • events.property-tier-changed