Skip to content

Home > @world-wide-lab/client > ClientSessionOptions

ClientSessionOptions interface

Options to create a new Session

Signature:

typescript
export interface ClientSessionOptions extends ClientSessionUpdateOptions

Extends: ClientSessionUpdateOptions

Properties

Property

Modifiers

Type

Description

linkParticipant?

boolean

(Optional) If true, a participant will be linked to the session. If a participantId is stored, this will automatically be used to link the session to an existing participant.

participant?

Participant

(Optional) Link the session to an existing participant

studyId

string

The id of the study to create a session for. Required.