Skip to content

AIDK API Reference / aidk-kernel / ChannelSession

Class: ChannelSession ​

Defined in: packages/kernel/src/channel.ts:252

Channel session manages a collection of channels. Sessions persist across multiple engine executions.

Constructors ​

Constructor ​

ts
new ChannelSession(id: string): ChannelSession;

Defined in: packages/kernel/src/channel.ts:257

Parameters ​

ParameterType
idstring

Returns ​

ChannelSession

Properties ​

PropertyModifierTypeDefined in
channelsreadonlyMap<string, Channel>packages/kernel/src/channel.ts:253
createdAtreadonlynumberpackages/kernel/src/channel.ts:254
idreadonlystringpackages/kernel/src/channel.ts:257
lastActivitypublicnumberpackages/kernel/src/channel.ts:255

Methods ​

destroy() ​

ts
destroy(): void;

Defined in: packages/kernel/src/channel.ts:302

Cleanup all channels in the session.

Returns ​

void


generateId() ​

ts
static generateId(ctx: KernelContext): string;

Defined in: packages/kernel/src/channel.ts:289

Default session ID generator. Uses user context + conversation ID or trace ID. Users can override this via ChannelService config.

Parameters ​

ParameterType
ctxKernelContext

Returns ​

string


getChannel() ​

ts
getChannel(name: string): Channel;

Defined in: packages/kernel/src/channel.ts:265

Get or create a channel within this session.

Parameters ​

ParameterType
namestring

Returns ​

Channel


removeChannel() ​

ts
removeChannel(name: string): void;

Defined in: packages/kernel/src/channel.ts:276

Remove a channel from the session.

Parameters ​

ParameterType
namestring

Returns ​

void

Released under the MIT License.