Class: Gathering

A live Gathering object. Every field from the API response is available directly on the object (e.g. gathering.name, gathering.joinCode), and the object also exposes action methods (start(), end(), addMember(), watchMembers(), …).

Extends

• GatheringResponse

Constructors

new Gathering()

new Gathering(
   ctx, 
   _projectId, 
   data): Gathering

Internal

Parameters

Parameter	Type	Description
ctx	ClientContext	-
_projectId	string	-
data	object	-
data.accessPolicy	string	Description Access policy
data.autoStartSession	boolean	Description Whether session starts automatically
data.createdAt	string	Format: date-time Description Creation timestamp
data.description?	string	Description Gathering description
data.endsAt?	string	Format: date-time Description Scheduled end time
data.expiresAt?	string	Format: date-time Description Expiration timestamp
data.id	string	Description Gathering ID
data.inviterEmail?	string	Description Email address of the gathering organizer (used as Reply-To in invitation emails)
data.inviterName?	string	Description Display name of the gathering organizer
data.joinCode	string	Description Join code for sharing
data.listed	boolean	Description Whether gathering is listed for discovery
data.maxMembers	number	Description Maximum members allowed
data.memberCount	number	Description Current member count
data.members?	object[]	Description Members (included in detailed view)
data.name	string	Description Gathering name
data.ownerId?	string	Description Owner participant ID
data.projectId	string	Description Project ID
data.properties?	object	Description Custom properties
data.roomId?	string	Description Target ODIN room ID
data.sessionId?	string	Description Created session ID
data.startsAt?	string	Format: date-time Description Scheduled start time
data.status	| "pending" | "active" | "started" | "ended" | "cancelled" | "expired"	Description Gathering status
data.tenantId	string	Description Tenant ID
data.timezone?	string	Description Timezone for scheduled times
data.type	"lobby" | "appointment" | "open"	Description Gathering type

Returns

Gathering

Inherited from

GatheringResponse.constructor

Defined in

4Players/cortex-typescript-sdk/src/resources/gatherings.ts:211

Properties

Property	Type	Description	Inherited from	Defined in
accessPolicy	string	Description Access policy	GatheringResponse.accessPolicy	4Players/cortex-typescript-sdk/src/types.ts:3669
autoStartSession	boolean	Description Whether session starts automatically	GatheringResponse.autoStartSession	4Players/cortex-typescript-sdk/src/types.ts:3687
createdAt	string	Format: date-time Description Creation timestamp	GatheringResponse.createdAt	4Players/cortex-typescript-sdk/src/types.ts:3702
description?	string	Description Gathering description	GatheringResponse.description	4Players/cortex-typescript-sdk/src/types.ts:3649
endsAt?	string	Format: date-time Description Scheduled end time	GatheringResponse.endsAt	4Players/cortex-typescript-sdk/src/types.ts:3681
expiresAt?	string	Format: date-time Description Expiration timestamp	GatheringResponse.expiresAt	4Players/cortex-typescript-sdk/src/types.ts:3707
id	string	Description Gathering ID	GatheringResponse.id	4Players/cortex-typescript-sdk/src/types.ts:3641
inviterEmail?	string	Description Email address of the gathering organizer (used as Reply-To in invitation emails)	GatheringResponse.inviterEmail	4Players/cortex-typescript-sdk/src/types.ts:3653
inviterName?	string	Description Display name of the gathering organizer	GatheringResponse.inviterName	4Players/cortex-typescript-sdk/src/types.ts:3651
joinCode	string	Description Join code for sharing	GatheringResponse.joinCode	4Players/cortex-typescript-sdk/src/types.ts:3691
listed	boolean	Description Whether gathering is listed for discovery	GatheringResponse.listed	4Players/cortex-typescript-sdk/src/types.ts:3671
maxMembers	number	Description Maximum members allowed	GatheringResponse.maxMembers	4Players/cortex-typescript-sdk/src/types.ts:3665
memberCount	number	Description Current member count	GatheringResponse.memberCount	4Players/cortex-typescript-sdk/src/types.ts:3667
members?	object[]	Description Members (included in detailed view)	GatheringResponse.members	4Players/cortex-typescript-sdk/src/types.ts:3709
name	string	Description Gathering name	GatheringResponse.name	4Players/cortex-typescript-sdk/src/types.ts:3647
ownerId?	string	Description Owner participant ID	GatheringResponse.ownerId	4Players/cortex-typescript-sdk/src/types.ts:3697
projectId	string	Description Project ID	GatheringResponse.projectId	4Players/cortex-typescript-sdk/src/types.ts:3643
properties?	object	Description Custom properties	GatheringResponse.properties	4Players/cortex-typescript-sdk/src/types.ts:3693
roomId?	string	Description Target ODIN room ID	GatheringResponse.roomId	4Players/cortex-typescript-sdk/src/types.ts:3685
sessionId?	string	Description Created session ID	GatheringResponse.sessionId	4Players/cortex-typescript-sdk/src/types.ts:3689
startsAt?	string	Format: date-time Description Scheduled start time	GatheringResponse.startsAt	4Players/cortex-typescript-sdk/src/types.ts:3676
status	| "pending" | "active" | "started" | "ended" | "cancelled" | "expired"	Description Gathering status	GatheringResponse.status	4Players/cortex-typescript-sdk/src/types.ts:3663
tenantId	string	Description Tenant ID	GatheringResponse.tenantId	4Players/cortex-typescript-sdk/src/types.ts:3645
timezone?	string	Description Timezone for scheduled times	GatheringResponse.timezone	4Players/cortex-typescript-sdk/src/types.ts:3683
type	"lobby" | "appointment" | "open"	Description Gathering type	GatheringResponse.type	4Players/cortex-typescript-sdk/src/types.ts:3658

Accessors

data

get data(): object

The raw API response object.

Deprecated

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

Returns

object

Name	Type	Description	Defined in
accessPolicy	string	Description Access policy	4Players/cortex-typescript-sdk/src/types.ts:3669
autoStartSession	boolean	Description Whether session starts automatically	4Players/cortex-typescript-sdk/src/types.ts:3687
createdAt	string	Format: date-time Description Creation timestamp	4Players/cortex-typescript-sdk/src/types.ts:3702
description?	string	Description Gathering description	4Players/cortex-typescript-sdk/src/types.ts:3649
endsAt?	string	Format: date-time Description Scheduled end time	4Players/cortex-typescript-sdk/src/types.ts:3681
expiresAt?	string	Format: date-time Description Expiration timestamp	4Players/cortex-typescript-sdk/src/types.ts:3707
id	string	Description Gathering ID	4Players/cortex-typescript-sdk/src/types.ts:3641
inviterEmail?	string	Description Email address of the gathering organizer (used as Reply-To in invitation emails)	4Players/cortex-typescript-sdk/src/types.ts:3653
inviterName?	string	Description Display name of the gathering organizer	4Players/cortex-typescript-sdk/src/types.ts:3651
joinCode	string	Description Join code for sharing	4Players/cortex-typescript-sdk/src/types.ts:3691
listed	boolean	Description Whether gathering is listed for discovery	4Players/cortex-typescript-sdk/src/types.ts:3671
maxMembers	number	Description Maximum members allowed	4Players/cortex-typescript-sdk/src/types.ts:3665
memberCount	number	Description Current member count	4Players/cortex-typescript-sdk/src/types.ts:3667
members?	object[]	Description Members (included in detailed view)	4Players/cortex-typescript-sdk/src/types.ts:3709
name	string	Description Gathering name	4Players/cortex-typescript-sdk/src/types.ts:3647
ownerId?	string	Description Owner participant ID	4Players/cortex-typescript-sdk/src/types.ts:3697
projectId	string	Description Project ID	4Players/cortex-typescript-sdk/src/types.ts:3643
properties?	object	Description Custom properties	4Players/cortex-typescript-sdk/src/types.ts:3693
roomId?	string	Description Target ODIN room ID	4Players/cortex-typescript-sdk/src/types.ts:3685
sessionId?	string	Description Created session ID	4Players/cortex-typescript-sdk/src/types.ts:3689
startsAt?	string	Format: date-time Description Scheduled start time	4Players/cortex-typescript-sdk/src/types.ts:3676
status	| "pending" | "active" | "started" | "ended" | "cancelled" | "expired"	Description Gathering status	4Players/cortex-typescript-sdk/src/types.ts:3663
tenantId	string	Description Tenant ID	4Players/cortex-typescript-sdk/src/types.ts:3645
timezone?	string	Description Timezone for scheduled times	4Players/cortex-typescript-sdk/src/types.ts:3683
type	"lobby" | "appointment" | "open"	Description Gathering type	4Players/cortex-typescript-sdk/src/types.ts:3658

Defined in

4Players/cortex-typescript-sdk/src/resources/gatherings.ts:223

Methods

addMember()

addMember(body): Promise<object>

Add a member to this gathering

Parameters

Parameter	Type	Description
body	object	Member addition payload
body.participantId	string	Description Participant ID to add
body.properties?	Record<string, never>	Description Custom member properties
body.role?	"owner" | "member"	Description Role for the member (default: member)

Returns

Promise<object>

Added member

Name	Type	Description	Defined in
displayName	string	Description Participant display name	4Players/cortex-typescript-sdk/src/types.ts:3610
gatheringId	string	Description Gathering ID	4Players/cortex-typescript-sdk/src/types.ts:3606
id	string	Description Member record ID	4Players/cortex-typescript-sdk/src/types.ts:3604
invitedAt?	string	Format: date-time Description When the member was invited	4Players/cortex-typescript-sdk/src/types.ts:3627
joinedAt?	string	Format: date-time Description When the member joined	4Players/cortex-typescript-sdk/src/types.ts:3632
participantId	string	Description Participant ID	4Players/cortex-typescript-sdk/src/types.ts:3608
properties?	Record<string, never>	Description Custom member properties	4Players/cortex-typescript-sdk/src/types.ts:3622
readyAt?	string	Format: date-time Description When the member marked as ready	4Players/cortex-typescript-sdk/src/types.ts:3637
role	"owner" | "member"	Description Member role	4Players/cortex-typescript-sdk/src/types.ts:3620
status	"invited" | "joined" | "ready" | "left"	Description Member status	4Players/cortex-typescript-sdk/src/types.ts:3615

Defined in

4Players/cortex-typescript-sdk/src/resources/gatherings.ts:301

---

cancel()

cancel(): Promise<object>

Cancel this gathering

Returns

Promise<object>

Cancelled gathering

Name	Type	Description	Defined in
accessPolicy	string	Description Access policy	4Players/cortex-typescript-sdk/src/types.ts:3669
autoStartSession	boolean	Description Whether session starts automatically	4Players/cortex-typescript-sdk/src/types.ts:3687
createdAt	string	Format: date-time Description Creation timestamp	4Players/cortex-typescript-sdk/src/types.ts:3702
description?	string	Description Gathering description	4Players/cortex-typescript-sdk/src/types.ts:3649
endsAt?	string	Format: date-time Description Scheduled end time	4Players/cortex-typescript-sdk/src/types.ts:3681
expiresAt?	string	Format: date-time Description Expiration timestamp	4Players/cortex-typescript-sdk/src/types.ts:3707
id	string	Description Gathering ID	4Players/cortex-typescript-sdk/src/types.ts:3641
inviterEmail?	string	Description Email address of the gathering organizer (used as Reply-To in invitation emails)	4Players/cortex-typescript-sdk/src/types.ts:3653
inviterName?	string	Description Display name of the gathering organizer	4Players/cortex-typescript-sdk/src/types.ts:3651
joinCode	string	Description Join code for sharing	4Players/cortex-typescript-sdk/src/types.ts:3691
listed	boolean	Description Whether gathering is listed for discovery	4Players/cortex-typescript-sdk/src/types.ts:3671
maxMembers	number	Description Maximum members allowed	4Players/cortex-typescript-sdk/src/types.ts:3665
memberCount	number	Description Current member count	4Players/cortex-typescript-sdk/src/types.ts:3667
members?	object[]	Description Members (included in detailed view)	4Players/cortex-typescript-sdk/src/types.ts:3709
name	string	Description Gathering name	4Players/cortex-typescript-sdk/src/types.ts:3647
ownerId?	string	Description Owner participant ID	4Players/cortex-typescript-sdk/src/types.ts:3697
projectId	string	Description Project ID	4Players/cortex-typescript-sdk/src/types.ts:3643
properties?	object	Description Custom properties	4Players/cortex-typescript-sdk/src/types.ts:3693
roomId?	string	Description Target ODIN room ID	4Players/cortex-typescript-sdk/src/types.ts:3685
sessionId?	string	Description Created session ID	4Players/cortex-typescript-sdk/src/types.ts:3689
startsAt?	string	Format: date-time Description Scheduled start time	4Players/cortex-typescript-sdk/src/types.ts:3676
status	| "pending" | "active" | "started" | "ended" | "cancelled" | "expired"	Description Gathering status	4Players/cortex-typescript-sdk/src/types.ts:3663
tenantId	string	Description Tenant ID	4Players/cortex-typescript-sdk/src/types.ts:3645
timezone?	string	Description Timezone for scheduled times	4Players/cortex-typescript-sdk/src/types.ts:3683
type	"lobby" | "appointment" | "open"	Description Gathering type	4Players/cortex-typescript-sdk/src/types.ts:3658

Defined in

4Players/cortex-typescript-sdk/src/resources/gatherings.ts:245

---

end()

end(): Promise<object>

End this gathering

Returns

Promise<object>

Ended gathering

Name	Type	Description	Defined in
accessPolicy	string	Description Access policy	4Players/cortex-typescript-sdk/src/types.ts:3669
autoStartSession	boolean	Description Whether session starts automatically	4Players/cortex-typescript-sdk/src/types.ts:3687
createdAt	string	Format: date-time Description Creation timestamp	4Players/cortex-typescript-sdk/src/types.ts:3702
description?	string	Description Gathering description	4Players/cortex-typescript-sdk/src/types.ts:3649
endsAt?	string	Format: date-time Description Scheduled end time	4Players/cortex-typescript-sdk/src/types.ts:3681
expiresAt?	string	Format: date-time Description Expiration timestamp	4Players/cortex-typescript-sdk/src/types.ts:3707
id	string	Description Gathering ID	4Players/cortex-typescript-sdk/src/types.ts:3641
inviterEmail?	string	Description Email address of the gathering organizer (used as Reply-To in invitation emails)	4Players/cortex-typescript-sdk/src/types.ts:3653
inviterName?	string	Description Display name of the gathering organizer	4Players/cortex-typescript-sdk/src/types.ts:3651
joinCode	string	Description Join code for sharing	4Players/cortex-typescript-sdk/src/types.ts:3691
listed	boolean	Description Whether gathering is listed for discovery	4Players/cortex-typescript-sdk/src/types.ts:3671
maxMembers	number	Description Maximum members allowed	4Players/cortex-typescript-sdk/src/types.ts:3665
memberCount	number	Description Current member count	4Players/cortex-typescript-sdk/src/types.ts:3667
members?	object[]	Description Members (included in detailed view)	4Players/cortex-typescript-sdk/src/types.ts:3709
name	string	Description Gathering name	4Players/cortex-typescript-sdk/src/types.ts:3647
ownerId?	string	Description Owner participant ID	4Players/cortex-typescript-sdk/src/types.ts:3697
projectId	string	Description Project ID	4Players/cortex-typescript-sdk/src/types.ts:3643
properties?	object	Description Custom properties	4Players/cortex-typescript-sdk/src/types.ts:3693
roomId?	string	Description Target ODIN room ID	4Players/cortex-typescript-sdk/src/types.ts:3685
sessionId?	string	Description Created session ID	4Players/cortex-typescript-sdk/src/types.ts:3689
startsAt?	string	Format: date-time Description Scheduled start time	4Players/cortex-typescript-sdk/src/types.ts:3676
status	| "pending" | "active" | "started" | "ended" | "cancelled" | "expired"	Description Gathering status	4Players/cortex-typescript-sdk/src/types.ts:3663
tenantId	string	Description Tenant ID	4Players/cortex-typescript-sdk/src/types.ts:3645
timezone?	string	Description Timezone for scheduled times	4Players/cortex-typescript-sdk/src/types.ts:3683
type	"lobby" | "appointment" | "open"	Description Gathering type	4Players/cortex-typescript-sdk/src/types.ts:3658

Defined in

4Players/cortex-typescript-sdk/src/resources/gatherings.ts:272

---

listInvitations()

listInvitations(): Promise<object[]>

List all invitation records for this gathering, regardless of status (pending, accepted, declined). Useful for tracking RSVP state of email invitations sent via CreateGatheringRequest.participants or Gathering.sendInvitations.

Returns

Promise<object[]>

Array of invitation records for this gathering

Defined in

4Players/cortex-typescript-sdk/src/resources/gatherings.ts:361

---

listMembers()

listMembers(): Promise<object[]>

List members of this gathering

Returns

Promise<object[]>

Array of gathering members

Defined in

4Players/cortex-typescript-sdk/src/resources/gatherings.ts:287

---

removeMember()

removeMember(participantId): Promise<void>

Remove a member from this gathering

Parameters

Parameter	Type	Description
participantId	string	Participant ID to remove

Returns

Promise<void>

Defined in

4Players/cortex-typescript-sdk/src/resources/gatherings.ts:329

---

sendInvitations()

sendInvitations(body): Promise<object[]>

Send invitations to this gathering

Parameters

Parameter	Type	Description
body	object	Invitations payload
body.baseUrl?	string	Description Base URL for HTTP join links Example https://game.example.com
body.customProtocol?	string	Description Custom protocol format for join URL Example mygame://
body.emails?	string[]	Description Email addresses to invite
body.invitedById	string	Description Participant UUID of the person sending invitations
body.participantIds?	string[]	Description Participant IDs to invite

Returns

Promise<object[]>

Array of created invitations

Defined in

4Players/cortex-typescript-sdk/src/resources/gatherings.ts:344

---

start()

start(body): Promise<object>

Start this gathering

Parameters

Parameter	Type	Description
body	object	Start payload (roomId)
body.roomId	string	Description ODIN room ID to use Example room-123

Returns

Promise<object>

Started gathering

Name	Type	Description	Defined in
accessPolicy	string	Description Access policy	4Players/cortex-typescript-sdk/src/types.ts:3669
autoStartSession	boolean	Description Whether session starts automatically	4Players/cortex-typescript-sdk/src/types.ts:3687
createdAt	string	Format: date-time Description Creation timestamp	4Players/cortex-typescript-sdk/src/types.ts:3702
description?	string	Description Gathering description	4Players/cortex-typescript-sdk/src/types.ts:3649
endsAt?	string	Format: date-time Description Scheduled end time	4Players/cortex-typescript-sdk/src/types.ts:3681
expiresAt?	string	Format: date-time Description Expiration timestamp	4Players/cortex-typescript-sdk/src/types.ts:3707
id	string	Description Gathering ID	4Players/cortex-typescript-sdk/src/types.ts:3641
inviterEmail?	string	Description Email address of the gathering organizer (used as Reply-To in invitation emails)	4Players/cortex-typescript-sdk/src/types.ts:3653
inviterName?	string	Description Display name of the gathering organizer	4Players/cortex-typescript-sdk/src/types.ts:3651
joinCode	string	Description Join code for sharing	4Players/cortex-typescript-sdk/src/types.ts:3691
listed	boolean	Description Whether gathering is listed for discovery	4Players/cortex-typescript-sdk/src/types.ts:3671
maxMembers	number	Description Maximum members allowed	4Players/cortex-typescript-sdk/src/types.ts:3665
memberCount	number	Description Current member count	4Players/cortex-typescript-sdk/src/types.ts:3667
members?	object[]	Description Members (included in detailed view)	4Players/cortex-typescript-sdk/src/types.ts:3709
name	string	Description Gathering name	4Players/cortex-typescript-sdk/src/types.ts:3647
ownerId?	string	Description Owner participant ID	4Players/cortex-typescript-sdk/src/types.ts:3697
projectId	string	Description Project ID	4Players/cortex-typescript-sdk/src/types.ts:3643
properties?	object	Description Custom properties	4Players/cortex-typescript-sdk/src/types.ts:3693
roomId?	string	Description Target ODIN room ID	4Players/cortex-typescript-sdk/src/types.ts:3685
sessionId?	string	Description Created session ID	4Players/cortex-typescript-sdk/src/types.ts:3689
startsAt?	string	Format: date-time Description Scheduled start time	4Players/cortex-typescript-sdk/src/types.ts:3676
status	| "pending" | "active" | "started" | "ended" | "cancelled" | "expired"	Description Gathering status	4Players/cortex-typescript-sdk/src/types.ts:3663
tenantId	string	Description Tenant ID	4Players/cortex-typescript-sdk/src/types.ts:3645
timezone?	string	Description Timezone for scheduled times	4Players/cortex-typescript-sdk/src/types.ts:3683
type	"lobby" | "appointment" | "open"	Description Gathering type	4Players/cortex-typescript-sdk/src/types.ts:3658

Defined in

4Players/cortex-typescript-sdk/src/resources/gatherings.ts:259

---

update()

update(body): Promise<object>

Update this gathering

Parameters

Parameter	Type	Description
body	object	Updated gathering data
body.accessPolicy?	"public" | "private" | "invite-only"	Description Updated access policy
body.description?	string	Description Updated description
body.endsAt?	string	Description Updated scheduled end time
body.inviterEmail?	string	Description Updated inviter email address
body.inviterName?	string	Description Updated inviter display name
body.listed?	boolean	Description Updated visibility
body.maxMembers?	number	Description Updated max members
body.name?	string	Description Updated name
body.properties?	Record<string, never>	Description Updated properties
body.searchProperties?	Record<string, never>	Description Updated search properties
body.startsAt?	string	Description Updated scheduled start time

Returns

Promise<object>

Updated gathering

Name	Type	Description	Defined in
accessPolicy	string	Description Access policy	4Players/cortex-typescript-sdk/src/types.ts:3669
autoStartSession	boolean	Description Whether session starts automatically	4Players/cortex-typescript-sdk/src/types.ts:3687
createdAt	string	Format: date-time Description Creation timestamp	4Players/cortex-typescript-sdk/src/types.ts:3702
description?	string	Description Gathering description	4Players/cortex-typescript-sdk/src/types.ts:3649
endsAt?	string	Format: date-time Description Scheduled end time	4Players/cortex-typescript-sdk/src/types.ts:3681
expiresAt?	string	Format: date-time Description Expiration timestamp	4Players/cortex-typescript-sdk/src/types.ts:3707
id	string	Description Gathering ID	4Players/cortex-typescript-sdk/src/types.ts:3641
inviterEmail?	string	Description Email address of the gathering organizer (used as Reply-To in invitation emails)	4Players/cortex-typescript-sdk/src/types.ts:3653
inviterName?	string	Description Display name of the gathering organizer	4Players/cortex-typescript-sdk/src/types.ts:3651
joinCode	string	Description Join code for sharing	4Players/cortex-typescript-sdk/src/types.ts:3691
listed	boolean	Description Whether gathering is listed for discovery	4Players/cortex-typescript-sdk/src/types.ts:3671
maxMembers	number	Description Maximum members allowed	4Players/cortex-typescript-sdk/src/types.ts:3665
memberCount	number	Description Current member count	4Players/cortex-typescript-sdk/src/types.ts:3667
members?	object[]	Description Members (included in detailed view)	4Players/cortex-typescript-sdk/src/types.ts:3709
name	string	Description Gathering name	4Players/cortex-typescript-sdk/src/types.ts:3647
ownerId?	string	Description Owner participant ID	4Players/cortex-typescript-sdk/src/types.ts:3697
projectId	string	Description Project ID	4Players/cortex-typescript-sdk/src/types.ts:3643
properties?	object	Description Custom properties	4Players/cortex-typescript-sdk/src/types.ts:3693
roomId?	string	Description Target ODIN room ID	4Players/cortex-typescript-sdk/src/types.ts:3685
sessionId?	string	Description Created session ID	4Players/cortex-typescript-sdk/src/types.ts:3689
startsAt?	string	Format: date-time Description Scheduled start time	4Players/cortex-typescript-sdk/src/types.ts:3676
status	| "pending" | "active" | "started" | "ended" | "cancelled" | "expired"	Description Gathering status	4Players/cortex-typescript-sdk/src/types.ts:3663
tenantId	string	Description Tenant ID	4Players/cortex-typescript-sdk/src/types.ts:3645
timezone?	string	Description Timezone for scheduled times	4Players/cortex-typescript-sdk/src/types.ts:3683
type	"lobby" | "appointment" | "open"	Description Gathering type	4Players/cortex-typescript-sdk/src/types.ts:3658

Defined in

4Players/cortex-typescript-sdk/src/resources/gatherings.ts:232

---

updateMember()

updateMember(memberId, body): Promise<object>

Update a gathering member

Parameters

Parameter	Type	Description
memberId	string	Member ID
body	object	Updated member data
body.properties?	Record<string, never>	Description Updated member properties
body.status?	"invited" | "joined" | "ready" | "left"	Description Updated member status

Returns

Promise<object>

Updated member

Name	Type	Description	Defined in
displayName	string	Description Participant display name	4Players/cortex-typescript-sdk/src/types.ts:3610
gatheringId	string	Description Gathering ID	4Players/cortex-typescript-sdk/src/types.ts:3606
id	string	Description Member record ID	4Players/cortex-typescript-sdk/src/types.ts:3604
invitedAt?	string	Format: date-time Description When the member was invited	4Players/cortex-typescript-sdk/src/types.ts:3627
joinedAt?	string	Format: date-time Description When the member joined	4Players/cortex-typescript-sdk/src/types.ts:3632
participantId	string	Description Participant ID	4Players/cortex-typescript-sdk/src/types.ts:3608
properties?	Record<string, never>	Description Custom member properties	4Players/cortex-typescript-sdk/src/types.ts:3622
readyAt?	string	Format: date-time Description When the member marked as ready	4Players/cortex-typescript-sdk/src/types.ts:3637
role	"owner" | "member"	Description Member role	4Players/cortex-typescript-sdk/src/types.ts:3620
status	"invited" | "joined" | "ready" | "left"	Description Member status	4Players/cortex-typescript-sdk/src/types.ts:3615

Defined in

4Players/cortex-typescript-sdk/src/resources/gatherings.ts:316

---

watch()

watch(): DocumentSubscription<object>

Live-subscribe to this gathering. current reflects status changes (started, ended, cancelled) and becomes undefined only if the gathering is deleted.

Returns

DocumentSubscription<object>

A DocumentSubscription for this gathering

Name	Type	Description	Defined in
accessPolicy	string	Description Access policy	4Players/cortex-typescript-sdk/src/types.ts:3669
autoStartSession	boolean	Description Whether session starts automatically	4Players/cortex-typescript-sdk/src/types.ts:3687
createdAt	string	Format: date-time Description Creation timestamp	4Players/cortex-typescript-sdk/src/types.ts:3702
description?	string	Description Gathering description	4Players/cortex-typescript-sdk/src/types.ts:3649
endsAt?	string	Format: date-time Description Scheduled end time	4Players/cortex-typescript-sdk/src/types.ts:3681
expiresAt?	string	Format: date-time Description Expiration timestamp	4Players/cortex-typescript-sdk/src/types.ts:3707
id	string	Description Gathering ID	4Players/cortex-typescript-sdk/src/types.ts:3641
inviterEmail?	string	Description Email address of the gathering organizer (used as Reply-To in invitation emails)	4Players/cortex-typescript-sdk/src/types.ts:3653
inviterName?	string	Description Display name of the gathering organizer	4Players/cortex-typescript-sdk/src/types.ts:3651
joinCode	string	Description Join code for sharing	4Players/cortex-typescript-sdk/src/types.ts:3691
listed	boolean	Description Whether gathering is listed for discovery	4Players/cortex-typescript-sdk/src/types.ts:3671
maxMembers	number	Description Maximum members allowed	4Players/cortex-typescript-sdk/src/types.ts:3665
memberCount	number	Description Current member count	4Players/cortex-typescript-sdk/src/types.ts:3667
members?	object[]	Description Members (included in detailed view)	4Players/cortex-typescript-sdk/src/types.ts:3709
name	string	Description Gathering name	4Players/cortex-typescript-sdk/src/types.ts:3647
ownerId?	string	Description Owner participant ID	4Players/cortex-typescript-sdk/src/types.ts:3697
projectId	string	Description Project ID	4Players/cortex-typescript-sdk/src/types.ts:3643
properties?	object	Description Custom properties	4Players/cortex-typescript-sdk/src/types.ts:3693
roomId?	string	Description Target ODIN room ID	4Players/cortex-typescript-sdk/src/types.ts:3685
sessionId?	string	Description Created session ID	4Players/cortex-typescript-sdk/src/types.ts:3689
startsAt?	string	Format: date-time Description Scheduled start time	4Players/cortex-typescript-sdk/src/types.ts:3676
status	| "pending" | "active" | "started" | "ended" | "cancelled" | "expired"	Description Gathering status	4Players/cortex-typescript-sdk/src/types.ts:3663
tenantId	string	Description Tenant ID	4Players/cortex-typescript-sdk/src/types.ts:3645
timezone?	string	Description Timezone for scheduled times	4Players/cortex-typescript-sdk/src/types.ts:3683
type	"lobby" | "appointment" | "open"	Description Gathering type	4Players/cortex-typescript-sdk/src/types.ts:3658

Defined in

4Players/cortex-typescript-sdk/src/resources/gatherings.ts:377

---

watchInvitations()

watchInvitations(): CollectionSubscription<object>

Live-subscribe to this gathering's invitations. sent upserts the invitation record; accepted/declined update its status in place. Initial invitations are loaded via REST.

Returns

CollectionSubscription<object>

A CollectionSubscription of invitation records

Name	Type	Description	Defined in
displayName?	string	Description Display name of the invitee	4Players/cortex-typescript-sdk/src/types.ts:4118
email?	string	Description Invited email	4Players/cortex-typescript-sdk/src/types.ts:4116
expiresAt?	string	Format: date-time Description When invitation expires	4Players/cortex-typescript-sdk/src/types.ts:4139
gatheringId	string	Description Gathering ID	4Players/cortex-typescript-sdk/src/types.ts:4112
id	string	Description Invitation ID	4Players/cortex-typescript-sdk/src/types.ts:4110
invitedAt	string	Format: date-time Description When invitation was sent	4Players/cortex-typescript-sdk/src/types.ts:4134
invitedById?	string	Description Who sent the invitation (null for system-generated invitations)	4Players/cortex-typescript-sdk/src/types.ts:4120
joinCode	string	Description Join code	4Players/cortex-typescript-sdk/src/types.ts:4129
joinUrl	string	Description Join URL	4Players/cortex-typescript-sdk/src/types.ts:4127
participantId?	string	Description Invited participant ID	4Players/cortex-typescript-sdk/src/types.ts:4114
respondedAt?	string	Format: date-time Description When invitee responded	4Players/cortex-typescript-sdk/src/types.ts:4144
status	"pending" | "expired" | "accepted" | "declined"	Description Invitation status	4Players/cortex-typescript-sdk/src/types.ts:4125

Defined in

4Players/cortex-typescript-sdk/src/resources/gatherings.ts:413

---

watchMembers()

watchMembers(): CollectionSubscription<object>

Live-subscribe to this gathering's members. Members are keyed by participant ID; joined/ready upsert the member, left removes them. Initial members are loaded via REST.

Returns

CollectionSubscription<object>

A CollectionSubscription of gathering members

Name	Type	Description	Defined in
displayName	string	Description Participant display name	4Players/cortex-typescript-sdk/src/types.ts:3610
gatheringId	string	Description Gathering ID	4Players/cortex-typescript-sdk/src/types.ts:3606
id	string	Description Member record ID	4Players/cortex-typescript-sdk/src/types.ts:3604
invitedAt?	string	Format: date-time Description When the member was invited	4Players/cortex-typescript-sdk/src/types.ts:3627
joinedAt?	string	Format: date-time Description When the member joined	4Players/cortex-typescript-sdk/src/types.ts:3632
participantId	string	Description Participant ID	4Players/cortex-typescript-sdk/src/types.ts:3608
properties?	Record<string, never>	Description Custom member properties	4Players/cortex-typescript-sdk/src/types.ts:3622
readyAt?	string	Format: date-time Description When the member marked as ready	4Players/cortex-typescript-sdk/src/types.ts:3637
role	"owner" | "member"	Description Member role	4Players/cortex-typescript-sdk/src/types.ts:3620
status	"invited" | "joined" | "ready" | "left"	Description Member status	4Players/cortex-typescript-sdk/src/types.ts:3615

Defined in

4Players/cortex-typescript-sdk/src/resources/gatherings.ts:387