Skip to main content

Class: ProjectScope

Scopes all project-specific resources to a single project.

Constructors​

new ProjectScope()​

new ProjectScope(ctx, projectId): ProjectScope

Internal

Parameters​

ParameterTypeDescription
ctxClientContext-
projectIdstringThe project ID this scope is bound to

Returns​

ProjectScope

Defined in​

4Players/cortex-typescript-sdk/src/project.ts:27

Properties​

PropertyModifierTypeDescriptionDefined in
projectIdreadonlystringThe project ID this scope is bound to4Players/cortex-typescript-sdk/src/project.ts:30

Accessors​

functions​

get functions(): FunctionsManager

Serverless functions management (settings, runtime, and CRUD)

Returns​

FunctionsManager

Defined in​

4Players/cortex-typescript-sdk/src/project.ts:79


gatherings​

get gatherings(): GatheringManager

Gathering management (includes members and invitations)

Returns​

GatheringManager

Defined in​

4Players/cortex-typescript-sdk/src/project.ts:73


participants​

get participants(): ParticipantManager

Participant management

Returns​

ParticipantManager

Defined in​

4Players/cortex-typescript-sdk/src/project.ts:67


plugins​

get plugins(): PluginInstanceManager

Plugin instance management

Returns​

PluginInstanceManager

Defined in​

4Players/cortex-typescript-sdk/src/project.ts:49


sanctions​

get sanctions(): SanctionManager

Sanction management

Returns​

SanctionManager

Defined in​

4Players/cortex-typescript-sdk/src/project.ts:61


sessions​

get sessions(): SessionManager

Session management

Returns​

SessionManager

Defined in​

4Players/cortex-typescript-sdk/src/project.ts:37


settings​

get settings(): ProjectSettingsManager

Project settings management

Returns​

ProjectSettingsManager

Defined in​

4Players/cortex-typescript-sdk/src/project.ts:55


webhooks​

get webhooks(): WebhookManager

Webhook subscription and event management

Returns​

WebhookManager

Defined in​

4Players/cortex-typescript-sdk/src/project.ts:43

Methods​

generateToken()​

generateToken(body): Promise<object>

Generate an ODIN Voice token for this project

Parameters​

ParameterTypeDescription
bodyobjectToken generation payload (roomId, userId)
body.roomIdstringDescription The Room ID Example my-awesome-room
body.userIdstringDescription The User ID Example my-user-id

Returns​

Promise<object>

Generated token

NameTypeDescriptionDefined in
tokenstringDescription The generated access token4Players/cortex-typescript-sdk/src/types.ts:2446

Defined in​

4Players/cortex-typescript-sdk/src/project.ts:88