observation-js Documentation - v1.14.0
    Preparing search index...

    Class Sessions

    Index

    Constructors

    Methods

    • Fetches a list of observation sessions for the authenticated user.

      Returns Promise<Paginated<Session>>

      A promise that resolves to a paginated list of sessions.

      If the request is not authenticated.

      If the request fails.

    • Creates a new observation session.

      Parameters

      • payload: CreateSessionPayload

        The data for the new session.

      Returns Promise<Session>

      A promise that resolves to the newly created session object.

      If the request is not authenticated.

      If the request fails.

    • Updates an existing observation session. If a session with the given UUID does not exist, a new one will be created.

      Parameters

      • payload: CreateSessionPayload

        The data to update the session with, including its UUID.

      Returns Promise<Session>

      A promise that resolves to the updated or created session object.

      If the request is not authenticated.

      If the request fails.

    • Fetches the observations associated with a specific session.

      Parameters

      • uuid: string

        The unique identifier (UUID) of the session.

      Returns Promise<Paginated<Observation>>

      A promise that resolves to a paginated list of observations for the session.

      If the request is not authenticated.

      If the request fails.