Interface DevicesApi

  • All Implemented Interfaces:

    
    public interface DevicesApi
    
                        
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
    • Field Summary

      Fields 
      Modifier and Type Field Description
    • Constructor Summary

      Constructors 
      Constructor Description
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
    • Method Summary

      Modifier and Type Method Description
      abstract Response createDevice(@Body() CreateDeviceRequest createDeviceRequest) Create device Adds a new device to a user, if the same device already exists the call will have no effect Responses:
      • 201: Successful response

      • 400: Bad request

      • 429: Too many requests

      abstract Response deleteDevice(@Query(value = "id") String id, @Query(value = "user_id") String userId) Delete device Deletes one device Responses:
      • 200: Successful response

      • 400: Bad request

      • 429: Too many requests

      abstract ListDevicesResponse listDevices(@Query(value = "user_id") String userId) List devices Returns all available devices Responses:
      • 200: Successful response

      • 400: Bad request

      • 429: Too many requests

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

    • Method Detail

      • createDevice

        @POST(value = "/video/devices") abstract Response createDevice(@Body() CreateDeviceRequest createDeviceRequest)

        Create device Adds a new device to a user, if the same device already exists the call will have no effect Responses:

        • 201: Successful response

        • 400: Bad request

        • 429: Too many requests

      • deleteDevice

        @DELETE(value = "/video/devices") abstract Response deleteDevice(@Query(value = "id") String id, @Query(value = "user_id") String userId)

        Delete device Deletes one device Responses:

        • 200: Successful response

        • 400: Bad request

        • 429: Too many requests

        Parameters:
        id - (optional)
        userId - (optional)
      • listDevices

        @GET(value = "/video/devices") abstract ListDevicesResponse listDevices(@Query(value = "user_id") String userId)

        List devices Returns all available devices Responses:

        • 200: Successful response

        • 400: Bad request

        • 429: Too many requests

        Parameters:
        userId - (optional)