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

Class RawSessionsClient

java.lang.Object

com.chrt.api.resources.tracking.sessions.RawSessionsClient

public class RawSessionsClient
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
protected ClientOptions	clientOptions

Constructor Summary

Constructors

Constructor	Description
RawSessionsClient(ClientOptions clientOptions)

Method Summary

Modifier and Type	Method	Description
ChrtApiHttpResponse<java.lang.String>	createSessionV1(SessionCreateSessionRequest1 request)	Creates a new tracking session for a device and links the device to it.
ChrtApiHttpResponse<java.lang.String>	createSessionV1(SessionCreateSessionRequest1 request, RequestOptions requestOptions)	Creates a new tracking session for a device and links the device to it.
ChrtApiHttpResponse<SessionDeleteResponse1>	deleteV1(SessionsDeleteV1Request request)	Deletes a terminated session and all its associated timeseries data points.
ChrtApiHttpResponse<SessionDeleteResponse1>	deleteV1(SessionsDeleteV1Request request, RequestOptions requestOptions)	Deletes a terminated session and all its associated timeseries data points.
ChrtApiHttpResponse<Session1>	getV1(SessionsGetV1Request request)	Retrieves a single session by its ID.
ChrtApiHttpResponse<Session1>	getV1(SessionsGetV1Request request, RequestOptions requestOptions)	Retrieves a single session by its ID.
ChrtApiHttpResponse<java.util.List<Session1>>	listV1()	Returns all tracking sessions for the caller's organization.
ChrtApiHttpResponse<java.util.List<Session1>>	listV1(RequestOptions requestOptions)	Returns all tracking sessions for the caller's organization.
ChrtApiHttpResponse<java.lang.Boolean>	pauseRecordingV1(SessionsPauseRecordingV1Request request)	Pauses location recording for a session by setting recording status to false.
ChrtApiHttpResponse<java.lang.Boolean>	pauseRecordingV1(SessionsPauseRecordingV1Request request, RequestOptions requestOptions)	Pauses location recording for a session by setting recording status to false.
ChrtApiHttpResponse<java.lang.Boolean>	resumeRecordingV1(SessionsResumeRecordingV1Request request)	Resumes location recording for a session by setting recording status to true.
ChrtApiHttpResponse<java.lang.Boolean>	resumeRecordingV1(SessionsResumeRecordingV1Request request, RequestOptions requestOptions)	Resumes location recording for a session by setting recording status to true.
ChrtApiHttpResponse<java.lang.Boolean>	startV1(SessionsStartV1Request request)	Starts location recording for a session by setting recording status to true.
ChrtApiHttpResponse<java.lang.Boolean>	startV1(SessionsStartV1Request request, RequestOptions requestOptions)	Starts location recording for a session by setting recording status to true.
ChrtApiHttpResponse<java.lang.Boolean>	terminateV1(SessionsTerminateV1Request request)	Terminates a session by setting recording to false and marking it as terminated.
ChrtApiHttpResponse<java.lang.Boolean>	terminateV1(SessionsTerminateV1Request request, RequestOptions requestOptions)	Terminates a session by setting recording to false and marking it as terminated.
ChrtApiHttpResponse<java.lang.Boolean>	updateV1(SessionUpdateRequest1 request)	Updates a session's comments and/or public visibility status.
ChrtApiHttpResponse<java.lang.Boolean>	updateV1(SessionUpdateRequest1 request, RequestOptions requestOptions)	Updates a session's comments and/or public visibility status.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

clientOptions

protected final ClientOptions clientOptions

Constructor Detail

RawSessionsClient

public RawSessionsClient(ClientOptions clientOptions)

Method Detail

listV1

public ChrtApiHttpResponse<java.util.List<Session1>> listV1()

Returns all tracking sessions for the caller's organization. | () -> (list[Session1])

listV1

public ChrtApiHttpResponse<java.util.List<Session1>> listV1(RequestOptions requestOptions)

Returns all tracking sessions for the caller's organization. | () -> (list[Session1])

getV1

public ChrtApiHttpResponse<Session1> getV1(SessionsGetV1Request request)

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

getV1

public ChrtApiHttpResponse<Session1> getV1(SessionsGetV1Request request,
                                           RequestOptions requestOptions)

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

createSessionV1

public ChrtApiHttpResponse<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 ChrtApiHttpResponse<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 ChrtApiHttpResponse<java.lang.Boolean> updateV1(SessionUpdateRequest1 request)

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

updateV1

public ChrtApiHttpResponse<java.lang.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 ChrtApiHttpResponse<java.lang.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 ChrtApiHttpResponse<java.lang.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 ChrtApiHttpResponse<java.lang.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 ChrtApiHttpResponse<java.lang.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 ChrtApiHttpResponse<java.lang.Boolean> resumeRecordingV1(SessionsResumeRecordingV1Request request)

Resumes location recording for a session by setting recording status to true. | () -> (bool)

resumeRecordingV1

public ChrtApiHttpResponse<java.lang.Boolean> resumeRecordingV1(SessionsResumeRecordingV1Request request,
                                                                RequestOptions requestOptions)

Resumes location recording for a session by setting recording status to true. | () -> (bool)

terminateV1

public ChrtApiHttpResponse<java.lang.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 ChrtApiHttpResponse<java.lang.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 ChrtApiHttpResponse<SessionDeleteResponse1> deleteV1(SessionsDeleteV1Request request)

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

deleteV1

public ChrtApiHttpResponse<SessionDeleteResponse1> deleteV1(SessionsDeleteV1Request request,
                                                            RequestOptions requestOptions)

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