Package com.chrt.api.resources.tracking.sessions

Class SessionsClient

  • public class SessionsClient
extends java.lang.Object

    • Constructor Detail

      • SessionsClient

        public SessionsClient​(ClientOptions clientOptions)

    • Method Detail

      • withRawResponse

        public RawSessionsClient withRawResponse()
        Get responses with HTTP metadata like headers

      • listV1

        public java.util.List<Session1> listV1()
        Returns all tracking sessions for the caller's organization. | () -> (list[Session1])

      • listV1

        public java.util.List<Session1> listV1​(RequestOptions requestOptions)
        Returns all tracking sessions for the caller's organization. | () -> (list[Session1])

      • getV1

        public Session1 getV1​(SessionsGetV1Request request)
        Retrieves a single session by its ID. Access restricted to the caller's organization. | () -> (Session1)

      • createSessionV1

        public java.lang.String createSessionV1​(SessionCreateSessionRequest1 request)
        Creates a new tracking session for a device and links the device to it. The device must be registered to the caller's organization. | (SessionCreateSessionRequest1) -> (PydanticObjectId)

      • createSessionV1

        public java.lang.String createSessionV1​(SessionCreateSessionRequest1 request,
                                        RequestOptions requestOptions)
        Creates a new tracking session for a device and links the device to it. The device must be registered to the caller's organization. | (SessionCreateSessionRequest1) -> (PydanticObjectId)

      • updateV1

        public boolean updateV1​(SessionUpdateRequest1 request)
        Updates a session's comments and/or public visibility status. Can update one or both fields. | (SessionUpdateRequest1) -> (bool)

      • updateV1

        public boolean updateV1​(SessionUpdateRequest1 request,
                        RequestOptions requestOptions)
        Updates a session's comments and/or public visibility status. Can update one or both fields. | (SessionUpdateRequest1) -> (bool)

      • startV1

        public boolean startV1​(SessionsStartV1Request request)
        Starts location recording for a session by setting recording status to true. Sets the recording initiated timestamp on first start. | () -> (bool)

      • startV1

        public boolean startV1​(SessionsStartV1Request request,
                       RequestOptions requestOptions)
        Starts location recording for a session by setting recording status to true. Sets the recording initiated timestamp on first start. | () -> (bool)

      • pauseRecordingV1

        public boolean pauseRecordingV1​(SessionsPauseRecordingV1Request request)
        Pauses location recording for a session by setting recording status to false. Device remains linked to the session. | () -> (bool)

      • pauseRecordingV1

        public boolean pauseRecordingV1​(SessionsPauseRecordingV1Request request,
                                RequestOptions requestOptions)
        Pauses location recording for a session by setting recording status to false. Device remains linked to the session. | () -> (bool)

      • resumeRecordingV1

        public boolean resumeRecordingV1​(SessionsResumeRecordingV1Request request)
        Resumes location recording for a session by setting recording status to true. | () -> (bool)

      • terminateV1

        public boolean terminateV1​(SessionsTerminateV1Request request)
        Terminates a session by setting recording to false and marking it as terminated. Unlinks the device from the session. | () -> (bool)

      • terminateV1

        public boolean terminateV1​(SessionsTerminateV1Request request,
                           RequestOptions requestOptions)
        Terminates a session by setting recording to false and marking it as terminated. Unlinks the device from the session. | () -> (bool)

      • deleteV1

        public SessionDeleteResponse1 deleteV1​(SessionsDeleteV1Request request)
        Deletes a terminated session and all its associated timeseries data points. Only sessions marked as terminated can be deleted. | () -> (SessionDeleteResponse1)