Skip to main content

Class: GatheringManager

Manages gatherings for a project.

Constructors

new GatheringManager()

new GatheringManager(ctx, projectId): GatheringManager

Internal

Parameters

ParameterType
ctxClientContext
projectIdstring

Returns

GatheringManager

Defined in

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

Methods

acceptInvitation()

acceptInvitation(invitationId, body): Promise<object>

Accept a gathering invitation

Parameters

ParameterTypeDescription
invitationIdstringInvitation ID
bodyobjectAccept payload (participantId)
body.participantIdstringDescription The accepting participant UUID

Returns

Promise<object>

Join result

NameTypeDescriptionDefined in
error?stringDescription Error message if failed4Players/cortex-typescript-sdk/src/types.ts:4462
gathering?objectDescription Gathering data4Players/cortex-typescript-sdk/src/types.ts:4458
gathering.accessPolicystringDescription Access policy4Players/cortex-typescript-sdk/src/types.ts:3669
gathering.autoStartSessionbooleanDescription Whether session starts automatically4Players/cortex-typescript-sdk/src/types.ts:3687
gathering.createdAtstringFormat: date-time Description Creation timestamp4Players/cortex-typescript-sdk/src/types.ts:3702
gathering.description?stringDescription Gathering description4Players/cortex-typescript-sdk/src/types.ts:3649
gathering.endsAt?stringFormat: date-time Description Scheduled end time4Players/cortex-typescript-sdk/src/types.ts:3681
gathering.expiresAt?stringFormat: date-time Description Expiration timestamp4Players/cortex-typescript-sdk/src/types.ts:3707
gathering.idstringDescription Gathering ID4Players/cortex-typescript-sdk/src/types.ts:3641
gathering.inviterEmail?stringDescription Email address of the gathering organizer (used as Reply-To in invitation emails)4Players/cortex-typescript-sdk/src/types.ts:3653
gathering.inviterName?stringDescription Display name of the gathering organizer4Players/cortex-typescript-sdk/src/types.ts:3651
gathering.joinCodestringDescription Join code for sharing4Players/cortex-typescript-sdk/src/types.ts:3691
gathering.listedbooleanDescription Whether gathering is listed for discovery4Players/cortex-typescript-sdk/src/types.ts:3671
gathering.maxMembersnumberDescription Maximum members allowed4Players/cortex-typescript-sdk/src/types.ts:3665
gathering.memberCountnumberDescription Current member count4Players/cortex-typescript-sdk/src/types.ts:3667
gathering.members?object[]Description Members (included in detailed view)4Players/cortex-typescript-sdk/src/types.ts:3709
gathering.namestringDescription Gathering name4Players/cortex-typescript-sdk/src/types.ts:3647
gathering.ownerId?stringDescription Owner participant ID4Players/cortex-typescript-sdk/src/types.ts:3697
gathering.projectIdstringDescription Project ID4Players/cortex-typescript-sdk/src/types.ts:3643
gathering.properties?objectDescription Custom properties4Players/cortex-typescript-sdk/src/types.ts:3693
gathering.roomId?stringDescription Target ODIN room ID4Players/cortex-typescript-sdk/src/types.ts:3685
gathering.sessionId?stringDescription Created session ID4Players/cortex-typescript-sdk/src/types.ts:3689
gathering.startsAt?stringFormat: date-time Description Scheduled start time4Players/cortex-typescript-sdk/src/types.ts:3676
gathering.status| "pending" | "active" | "started" | "ended" | "cancelled" | "expired"Description Gathering status4Players/cortex-typescript-sdk/src/types.ts:3663
gathering.tenantIdstringDescription Tenant ID4Players/cortex-typescript-sdk/src/types.ts:3645
gathering.timezone?stringDescription Timezone for scheduled times4Players/cortex-typescript-sdk/src/types.ts:3683
gathering.type"lobby" | "appointment" | "open"Description Gathering type4Players/cortex-typescript-sdk/src/types.ts:3658
member?objectDescription Member data4Players/cortex-typescript-sdk/src/types.ts:4460
member.displayNamestringDescription Participant display name4Players/cortex-typescript-sdk/src/types.ts:3610
member.gatheringIdstringDescription Gathering ID4Players/cortex-typescript-sdk/src/types.ts:3606
member.idstringDescription Member record ID4Players/cortex-typescript-sdk/src/types.ts:3604
member.invitedAt?stringFormat: date-time Description When the member was invited4Players/cortex-typescript-sdk/src/types.ts:3627
member.joinedAt?stringFormat: date-time Description When the member joined4Players/cortex-typescript-sdk/src/types.ts:3632
member.participantIdstringDescription Participant ID4Players/cortex-typescript-sdk/src/types.ts:3608
member.properties?Record<string, never>Description Custom member properties4Players/cortex-typescript-sdk/src/types.ts:3622
member.readyAt?stringFormat: date-time Description When the member marked as ready4Players/cortex-typescript-sdk/src/types.ts:3637
member.role"owner" | "member"Description Member role4Players/cortex-typescript-sdk/src/types.ts:3620
member.status"invited" | "joined" | "ready" | "left"Description Member status4Players/cortex-typescript-sdk/src/types.ts:3615
successbooleanDescription Whether join was successful4Players/cortex-typescript-sdk/src/types.ts:4456

Defined in

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


create()

create(body): Promise<Gathering>

Create a new gathering

Parameters

ParameterTypeDescription
bodyobjectGathering creation payload
body.accessPolicy?"public" | "private" | "invite-only"Description Access policy for joining Example public @enum {string}
body.autoStartSession?booleanDescription Whether to auto-start transcription session when gathering starts Example true
body.description?stringDescription Description providing context about the gathering (shown in invitation emails) Example Weekly team sync to discuss project progress and blockers.
body.endsAt?stringDescription Scheduled end time (for appointments) Example 2024-01-20T16:00:00Z
body.invitationUrl?stringDescription URL where participants join the meeting (e.g., Rooms instance URL). Used in invitation emails and calendar entries as the location. Example https://myapp.rooms.chat/room/abc123
body.inviterEmail?stringDescription Email address of the person organizing the gathering. Used as the Reply-To address in invitation emails and as the ORGANIZER mailto in calendar invites so recipients can reply directly to the inviter. Example alice@example.com
body.inviterName?stringDescription Display name of the person organizing the gathering. Shown as "Invited by {name}" in invitation emails and used as the ORGANIZER CN in calendar invites. Example Alice Smith
body.listed?booleanDescription Whether gathering appears in public search Example false
body.maxMembers?numberDescription Maximum number of members (2-100) Example 8
body.namestringDescription Human-readable name for the gathering Example Friday Game Night
body.ownerId?stringDescription Participant UUID of the gathering owner. If not provided, the creator becomes the owner.
body.participants?object[]Description List of participants to invite. Each invitee receives an email invitation. For Appointment gatherings with a start date, a calendar invite (.ics) is attached.
body.properties?objectDescription Custom properties (game mode, lobby settings, etc.) Example { * "gameMode": "deathmatch", * "map": "dust2" * }
body.roomId?stringDescription Custom room ID for ODIN. If not provided, the join code will be used as the room ID. Example game-room-lobby-123
body.searchProperties?Record<string, never>Description Indexed search properties for discovery Example { * "gameMode": "deathmatch", * "skillLevel": 1200 * }
body.startsAt?stringDescription Scheduled start time (for appointments) Example 2024-01-20T15:00:00Z
body.timezone?stringDescription Timezone for scheduled times (IANA format) Example Europe/Berlin
body.type"lobby" | "appointment" | "open"Description Type of gathering Example lobby @enum {string}

Returns

Promise<Gathering>

Live Gathering object

Defined in

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


declineInvitation()

declineInvitation(invitationId): Promise<void>

Decline a gathering invitation

Parameters

ParameterTypeDescription
invitationIdstringInvitation ID

Returns

Promise<void>

Defined in

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


get()

get(gatheringId, query?): Promise<Gathering>

Get a gathering by ID

Parameters

ParameterTypeDescription
gatheringIdstringGathering ID
query?objectOptional (includeMembers)
query.includeMembers?booleanDescription If true, includes the list of members in the response

Returns

Promise<Gathering>

Live Gathering object

Defined in

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


getPendingInvitations()

getPendingInvitations(query): Promise<object[]>

Get pending invitations for a participant

Parameters

ParameterTypeDescription
queryobjectRequired participantId filter
query.participantIdstringDescription The participant UUID to check invitations for

Returns

Promise<object[]>

Array of pending invitations

Defined in

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


joinByCode()

joinByCode(body): Promise<object>

Join a gathering by code

Parameters

ParameterTypeDescription
bodyobjectJoin payload (joinCode, participantId)
body.joinCodestringDescription 8-character join code Example ABCD1234
body.participantIdstringDescription Participant ID of the joining member

Returns

Promise<object>

Join result with gathering and member data

NameTypeDescriptionDefined in
error?stringDescription Error message if failed4Players/cortex-typescript-sdk/src/types.ts:4462
gathering?objectDescription Gathering data4Players/cortex-typescript-sdk/src/types.ts:4458
gathering.accessPolicystringDescription Access policy4Players/cortex-typescript-sdk/src/types.ts:3669
gathering.autoStartSessionbooleanDescription Whether session starts automatically4Players/cortex-typescript-sdk/src/types.ts:3687
gathering.createdAtstringFormat: date-time Description Creation timestamp4Players/cortex-typescript-sdk/src/types.ts:3702
gathering.description?stringDescription Gathering description4Players/cortex-typescript-sdk/src/types.ts:3649
gathering.endsAt?stringFormat: date-time Description Scheduled end time4Players/cortex-typescript-sdk/src/types.ts:3681
gathering.expiresAt?stringFormat: date-time Description Expiration timestamp4Players/cortex-typescript-sdk/src/types.ts:3707
gathering.idstringDescription Gathering ID4Players/cortex-typescript-sdk/src/types.ts:3641
gathering.inviterEmail?stringDescription Email address of the gathering organizer (used as Reply-To in invitation emails)4Players/cortex-typescript-sdk/src/types.ts:3653
gathering.inviterName?stringDescription Display name of the gathering organizer4Players/cortex-typescript-sdk/src/types.ts:3651
gathering.joinCodestringDescription Join code for sharing4Players/cortex-typescript-sdk/src/types.ts:3691
gathering.listedbooleanDescription Whether gathering is listed for discovery4Players/cortex-typescript-sdk/src/types.ts:3671
gathering.maxMembersnumberDescription Maximum members allowed4Players/cortex-typescript-sdk/src/types.ts:3665
gathering.memberCountnumberDescription Current member count4Players/cortex-typescript-sdk/src/types.ts:3667
gathering.members?object[]Description Members (included in detailed view)4Players/cortex-typescript-sdk/src/types.ts:3709
gathering.namestringDescription Gathering name4Players/cortex-typescript-sdk/src/types.ts:3647
gathering.ownerId?stringDescription Owner participant ID4Players/cortex-typescript-sdk/src/types.ts:3697
gathering.projectIdstringDescription Project ID4Players/cortex-typescript-sdk/src/types.ts:3643
gathering.properties?objectDescription Custom properties4Players/cortex-typescript-sdk/src/types.ts:3693
gathering.roomId?stringDescription Target ODIN room ID4Players/cortex-typescript-sdk/src/types.ts:3685
gathering.sessionId?stringDescription Created session ID4Players/cortex-typescript-sdk/src/types.ts:3689
gathering.startsAt?stringFormat: date-time Description Scheduled start time4Players/cortex-typescript-sdk/src/types.ts:3676
gathering.status| "pending" | "active" | "started" | "ended" | "cancelled" | "expired"Description Gathering status4Players/cortex-typescript-sdk/src/types.ts:3663
gathering.tenantIdstringDescription Tenant ID4Players/cortex-typescript-sdk/src/types.ts:3645
gathering.timezone?stringDescription Timezone for scheduled times4Players/cortex-typescript-sdk/src/types.ts:3683
gathering.type"lobby" | "appointment" | "open"Description Gathering type4Players/cortex-typescript-sdk/src/types.ts:3658
member?objectDescription Member data4Players/cortex-typescript-sdk/src/types.ts:4460
member.displayNamestringDescription Participant display name4Players/cortex-typescript-sdk/src/types.ts:3610
member.gatheringIdstringDescription Gathering ID4Players/cortex-typescript-sdk/src/types.ts:3606
member.idstringDescription Member record ID4Players/cortex-typescript-sdk/src/types.ts:3604
member.invitedAt?stringFormat: date-time Description When the member was invited4Players/cortex-typescript-sdk/src/types.ts:3627
member.joinedAt?stringFormat: date-time Description When the member joined4Players/cortex-typescript-sdk/src/types.ts:3632
member.participantIdstringDescription Participant ID4Players/cortex-typescript-sdk/src/types.ts:3608
member.properties?Record<string, never>Description Custom member properties4Players/cortex-typescript-sdk/src/types.ts:3622
member.readyAt?stringFormat: date-time Description When the member marked as ready4Players/cortex-typescript-sdk/src/types.ts:3637
member.role"owner" | "member"Description Member role4Players/cortex-typescript-sdk/src/types.ts:3620
member.status"invited" | "joined" | "ready" | "left"Description Member status4Players/cortex-typescript-sdk/src/types.ts:3615
successbooleanDescription Whether join was successful4Players/cortex-typescript-sdk/src/types.ts:4456

Defined in

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


list()

list(query?): Promise<object>

List gatherings for this project

Parameters

ParameterTypeDescription
query?objectOptional filters (type, status, listed, limit, offset)
query.limit?numberDescription Number of items to return
query.listed?booleanDescription Filter to only listed gatherings
query.offset?numberDescription Number of items to skip
query.status?| "pending" | "active" | "started" | "ended" | "cancelled" | "expired"Description Filter by gathering status
query.type?"lobby" | "appointment" | "open"Description Filter by gathering type

Returns

Promise<object>

Gatherings list with total count

NameTypeDescriptionDefined in
gatheringsobject[]Description List of gatherings4Players/cortex-typescript-sdk/src/types.ts:4407
totalnumberDescription Total count (for pagination)4Players/cortex-typescript-sdk/src/types.ts:4409

Defined in

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


lookupByCode()

lookupByCode(joinCode): Promise<object>

Look up a gathering by join code (without joining)

Parameters

ParameterTypeDescription
joinCodestring8-character join code

Returns

Promise<object>

Gathering details

NameTypeDescriptionDefined in
accessPolicystringDescription Access policy4Players/cortex-typescript-sdk/src/types.ts:3669
autoStartSessionbooleanDescription Whether session starts automatically4Players/cortex-typescript-sdk/src/types.ts:3687
createdAtstringFormat: date-time Description Creation timestamp4Players/cortex-typescript-sdk/src/types.ts:3702
description?stringDescription Gathering description4Players/cortex-typescript-sdk/src/types.ts:3649
endsAt?stringFormat: date-time Description Scheduled end time4Players/cortex-typescript-sdk/src/types.ts:3681
expiresAt?stringFormat: date-time Description Expiration timestamp4Players/cortex-typescript-sdk/src/types.ts:3707
idstringDescription Gathering ID4Players/cortex-typescript-sdk/src/types.ts:3641
inviterEmail?stringDescription Email address of the gathering organizer (used as Reply-To in invitation emails)4Players/cortex-typescript-sdk/src/types.ts:3653
inviterName?stringDescription Display name of the gathering organizer4Players/cortex-typescript-sdk/src/types.ts:3651
joinCodestringDescription Join code for sharing4Players/cortex-typescript-sdk/src/types.ts:3691
listedbooleanDescription Whether gathering is listed for discovery4Players/cortex-typescript-sdk/src/types.ts:3671
maxMembersnumberDescription Maximum members allowed4Players/cortex-typescript-sdk/src/types.ts:3665
memberCountnumberDescription Current member count4Players/cortex-typescript-sdk/src/types.ts:3667
members?object[]Description Members (included in detailed view)4Players/cortex-typescript-sdk/src/types.ts:3709
namestringDescription Gathering name4Players/cortex-typescript-sdk/src/types.ts:3647
ownerId?stringDescription Owner participant ID4Players/cortex-typescript-sdk/src/types.ts:3697
projectIdstringDescription Project ID4Players/cortex-typescript-sdk/src/types.ts:3643
properties?objectDescription Custom properties4Players/cortex-typescript-sdk/src/types.ts:3693
roomId?stringDescription Target ODIN room ID4Players/cortex-typescript-sdk/src/types.ts:3685
sessionId?stringDescription Created session ID4Players/cortex-typescript-sdk/src/types.ts:3689
startsAt?stringFormat: date-time Description Scheduled start time4Players/cortex-typescript-sdk/src/types.ts:3676
status| "pending" | "active" | "started" | "ended" | "cancelled" | "expired"Description Gathering status4Players/cortex-typescript-sdk/src/types.ts:3663
tenantIdstringDescription Tenant ID4Players/cortex-typescript-sdk/src/types.ts:3645
timezone?stringDescription Timezone for scheduled times4Players/cortex-typescript-sdk/src/types.ts:3683
type"lobby" | "appointment" | "open"Description Gathering type4Players/cortex-typescript-sdk/src/types.ts:3658

Defined in

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


watch()

watch()

watch(): CollectionSubscription<object>

Live-subscribe to gatherings. With no argument, watches the whole collection; with a gathering ID, watches that single gathering. Terminal states (started, ended, cancelled) are status updates — the gathering stays in the collection.

Returns

CollectionSubscription<object>

A CollectionSubscription (no id) or DocumentSubscription (with id)

NameTypeDescriptionDefined in
accessPolicystringDescription Access policy4Players/cortex-typescript-sdk/src/types.ts:3669
autoStartSessionbooleanDescription Whether session starts automatically4Players/cortex-typescript-sdk/src/types.ts:3687
createdAtstringFormat: date-time Description Creation timestamp4Players/cortex-typescript-sdk/src/types.ts:3702
description?stringDescription Gathering description4Players/cortex-typescript-sdk/src/types.ts:3649
endsAt?stringFormat: date-time Description Scheduled end time4Players/cortex-typescript-sdk/src/types.ts:3681
expiresAt?stringFormat: date-time Description Expiration timestamp4Players/cortex-typescript-sdk/src/types.ts:3707
idstringDescription Gathering ID4Players/cortex-typescript-sdk/src/types.ts:3641
inviterEmail?stringDescription Email address of the gathering organizer (used as Reply-To in invitation emails)4Players/cortex-typescript-sdk/src/types.ts:3653
inviterName?stringDescription Display name of the gathering organizer4Players/cortex-typescript-sdk/src/types.ts:3651
joinCodestringDescription Join code for sharing4Players/cortex-typescript-sdk/src/types.ts:3691
listedbooleanDescription Whether gathering is listed for discovery4Players/cortex-typescript-sdk/src/types.ts:3671
maxMembersnumberDescription Maximum members allowed4Players/cortex-typescript-sdk/src/types.ts:3665
memberCountnumberDescription Current member count4Players/cortex-typescript-sdk/src/types.ts:3667
members?object[]Description Members (included in detailed view)4Players/cortex-typescript-sdk/src/types.ts:3709
namestringDescription Gathering name4Players/cortex-typescript-sdk/src/types.ts:3647
ownerId?stringDescription Owner participant ID4Players/cortex-typescript-sdk/src/types.ts:3697
projectIdstringDescription Project ID4Players/cortex-typescript-sdk/src/types.ts:3643
properties?objectDescription Custom properties4Players/cortex-typescript-sdk/src/types.ts:3693
roomId?stringDescription Target ODIN room ID4Players/cortex-typescript-sdk/src/types.ts:3685
sessionId?stringDescription Created session ID4Players/cortex-typescript-sdk/src/types.ts:3689
startsAt?stringFormat: date-time Description Scheduled start time4Players/cortex-typescript-sdk/src/types.ts:3676
status| "pending" | "active" | "started" | "ended" | "cancelled" | "expired"Description Gathering status4Players/cortex-typescript-sdk/src/types.ts:3663
tenantIdstringDescription Tenant ID4Players/cortex-typescript-sdk/src/types.ts:3645
timezone?stringDescription Timezone for scheduled times4Players/cortex-typescript-sdk/src/types.ts:3683
type"lobby" | "appointment" | "open"Description Gathering type4Players/cortex-typescript-sdk/src/types.ts:3658
Defined in

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

watch(gatheringId)

watch(gatheringId): DocumentSubscription<object>
Parameters
ParameterType
gatheringIdstring
Returns

DocumentSubscription<object>

NameTypeDescriptionDefined in
accessPolicystringDescription Access policy4Players/cortex-typescript-sdk/src/types.ts:3669
autoStartSessionbooleanDescription Whether session starts automatically4Players/cortex-typescript-sdk/src/types.ts:3687
createdAtstringFormat: date-time Description Creation timestamp4Players/cortex-typescript-sdk/src/types.ts:3702
description?stringDescription Gathering description4Players/cortex-typescript-sdk/src/types.ts:3649
endsAt?stringFormat: date-time Description Scheduled end time4Players/cortex-typescript-sdk/src/types.ts:3681
expiresAt?stringFormat: date-time Description Expiration timestamp4Players/cortex-typescript-sdk/src/types.ts:3707
idstringDescription Gathering ID4Players/cortex-typescript-sdk/src/types.ts:3641
inviterEmail?stringDescription Email address of the gathering organizer (used as Reply-To in invitation emails)4Players/cortex-typescript-sdk/src/types.ts:3653
inviterName?stringDescription Display name of the gathering organizer4Players/cortex-typescript-sdk/src/types.ts:3651
joinCodestringDescription Join code for sharing4Players/cortex-typescript-sdk/src/types.ts:3691
listedbooleanDescription Whether gathering is listed for discovery4Players/cortex-typescript-sdk/src/types.ts:3671
maxMembersnumberDescription Maximum members allowed4Players/cortex-typescript-sdk/src/types.ts:3665
memberCountnumberDescription Current member count4Players/cortex-typescript-sdk/src/types.ts:3667
members?object[]Description Members (included in detailed view)4Players/cortex-typescript-sdk/src/types.ts:3709
namestringDescription Gathering name4Players/cortex-typescript-sdk/src/types.ts:3647
ownerId?stringDescription Owner participant ID4Players/cortex-typescript-sdk/src/types.ts:3697
projectIdstringDescription Project ID4Players/cortex-typescript-sdk/src/types.ts:3643
properties?objectDescription Custom properties4Players/cortex-typescript-sdk/src/types.ts:3693
roomId?stringDescription Target ODIN room ID4Players/cortex-typescript-sdk/src/types.ts:3685
sessionId?stringDescription Created session ID4Players/cortex-typescript-sdk/src/types.ts:3689
startsAt?stringFormat: date-time Description Scheduled start time4Players/cortex-typescript-sdk/src/types.ts:3676
status| "pending" | "active" | "started" | "ended" | "cancelled" | "expired"Description Gathering status4Players/cortex-typescript-sdk/src/types.ts:3663
tenantIdstringDescription Tenant ID4Players/cortex-typescript-sdk/src/types.ts:3645
timezone?stringDescription Timezone for scheduled times4Players/cortex-typescript-sdk/src/types.ts:3683
type"lobby" | "appointment" | "open"Description Gathering type4Players/cortex-typescript-sdk/src/types.ts:3658
Defined in

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