Class: Participant

A live Participant object. Every field from the API response is available directly on the object (e.g. participant.displayName, participant.externalUserId), and the object also exposes action methods (update(), delete(), watch()).

Extends

• ParticipantResponse

Constructors

new Participant()

new Participant(
   ctx, 
   _projectId, 
   data): Participant

Internal

Parameters

Parameter	Type	Description
ctx	ClientContext	-
_projectId	string	-
data	object	-
data.displayName	string	Description Display name of the participant
data.externalUserId	string	Description External User ID from ODIN (stable identifier)
data.id	string	Description Unique identifier for the participant
data.joinedAt	string	Format: date-time Description When the participant first joined any session in the project
data.projectId	string	Description ODIN project ID this participant belongs to
data.tenantId	string	Description Tenant ID
data.userData	object	Description User data from ODIN (parsed JSON)

Returns

Participant

Inherited from

ParticipantResponse.constructor

Defined in

4Players/cortex-typescript-sdk/src/resources/participants.ts:128

Properties

Property	Type	Description	Inherited from	Defined in
displayName	string	Description Display name of the participant	ParticipantResponse.displayName	4Players/cortex-typescript-sdk/src/types.ts:2817
externalUserId	string	Description External User ID from ODIN (stable identifier)	ParticipantResponse.externalUserId	4Players/cortex-typescript-sdk/src/types.ts:2819
id	string	Description Unique identifier for the participant	ParticipantResponse.id	4Players/cortex-typescript-sdk/src/types.ts:2813
joinedAt	string	Format: date-time Description When the participant first joined any session in the project	ParticipantResponse.joinedAt	4Players/cortex-typescript-sdk/src/types.ts:2830
projectId	string	Description ODIN project ID this participant belongs to	ParticipantResponse.projectId	4Players/cortex-typescript-sdk/src/types.ts:2815
tenantId	string	Description Tenant ID	ParticipantResponse.tenantId	4Players/cortex-typescript-sdk/src/types.ts:2821
userData	object	Description User data from ODIN (parsed JSON)	ParticipantResponse.userData	4Players/cortex-typescript-sdk/src/types.ts:2823

Accessors

data

get data(): object

The raw API response object.

Deprecated

The response fields are now available directly on this object (e.g. participant.displayName instead of participant.data.displayName). This accessor will be removed before the stable release.

Returns

object

Name	Type	Description	Defined in
displayName	string	Description Display name of the participant	4Players/cortex-typescript-sdk/src/types.ts:2817
externalUserId	string	Description External User ID from ODIN (stable identifier)	4Players/cortex-typescript-sdk/src/types.ts:2819
id	string	Description Unique identifier for the participant	4Players/cortex-typescript-sdk/src/types.ts:2813
joinedAt	string	Format: date-time Description When the participant first joined any session in the project	4Players/cortex-typescript-sdk/src/types.ts:2830
projectId	string	Description ODIN project ID this participant belongs to	4Players/cortex-typescript-sdk/src/types.ts:2815
tenantId	string	Description Tenant ID	4Players/cortex-typescript-sdk/src/types.ts:2821
userData	object	Description User data from ODIN (parsed JSON)	4Players/cortex-typescript-sdk/src/types.ts:2823

Defined in

4Players/cortex-typescript-sdk/src/resources/participants.ts:140

Methods

delete()

delete(): Promise<void>

Delete this participant

Returns

Promise<void>

Defined in

4Players/cortex-typescript-sdk/src/resources/participants.ts:161

---

update()

update(body): Promise<object>

Update this participant

Parameters

Parameter	Type	Description
body	object	Updated participant data
body.displayName?	string	Description Display name of the participant
body.userData?	object	Description User data from ODIN (parsed JSON)

Returns

Promise<object>

Updated participant

Name	Type	Description	Defined in
displayName	string	Description Display name of the participant	4Players/cortex-typescript-sdk/src/types.ts:2817
externalUserId	string	Description External User ID from ODIN (stable identifier)	4Players/cortex-typescript-sdk/src/types.ts:2819
id	string	Description Unique identifier for the participant	4Players/cortex-typescript-sdk/src/types.ts:2813
joinedAt	string	Format: date-time Description When the participant first joined any session in the project	4Players/cortex-typescript-sdk/src/types.ts:2830
projectId	string	Description ODIN project ID this participant belongs to	4Players/cortex-typescript-sdk/src/types.ts:2815
tenantId	string	Description Tenant ID	4Players/cortex-typescript-sdk/src/types.ts:2821
userData	object	Description User data from ODIN (parsed JSON)	4Players/cortex-typescript-sdk/src/types.ts:2823

Defined in

4Players/cortex-typescript-sdk/src/resources/participants.ts:149

---

watch()

watch(): DocumentSubscription<object>

Live-subscribe to this participant. current becomes undefined if deleted.

Returns

DocumentSubscription<object>

A DocumentSubscription for this participant

Name	Type	Description	Defined in
displayName	string	Description Display name of the participant	4Players/cortex-typescript-sdk/src/types.ts:2817
externalUserId	string	Description External User ID from ODIN (stable identifier)	4Players/cortex-typescript-sdk/src/types.ts:2819
id	string	Description Unique identifier for the participant	4Players/cortex-typescript-sdk/src/types.ts:2813
joinedAt	string	Format: date-time Description When the participant first joined any session in the project	4Players/cortex-typescript-sdk/src/types.ts:2830
projectId	string	Description ODIN project ID this participant belongs to	4Players/cortex-typescript-sdk/src/types.ts:2815
tenantId	string	Description Tenant ID	4Players/cortex-typescript-sdk/src/types.ts:2821
userData	object	Description User data from ODIN (parsed JSON)	4Players/cortex-typescript-sdk/src/types.ts:2823

Defined in

4Players/cortex-typescript-sdk/src/resources/participants.ts:173