Skip to main content

ChannelEvents

ChannelEvents = object

Event map type for ChannelClient. This type defines the event signatures for channel-related events.

For event name constants, see ChannelEvent.

Properties

channel.created()

channel.created: (evt: ChannelCreatedEvent) => void

Parameters

ParameterType
evtChannelCreatedEvent

Returns

void

Example

import { rootServer, ChannelEvent, ChannelCreatedEvent } from "@rootsdk/server-app";
rootServer.community.channels.on(ChannelEvent.ChannelCreated, (evt: ChannelCreatedEvent) => {
// ...
});

channel.deleted()

channel.deleted: (evt: ChannelDeletedEvent) => void

Parameters

ParameterType
evtChannelDeletedEvent

Returns

void

Example

import { rootServer, ChannelEvent, ChannelDeletedEvent } from "@rootsdk/server-app";
rootServer.community.channels.on(ChannelEvent.ChannelDeleted, (evt: ChannelDeletedEvent) => {
// ...
});

channel.edited()

channel.edited: (evt: ChannelEditedEvent) => void

Parameters

ParameterType
evtChannelEditedEvent

Returns

void

Example

import { rootServer, ChannelEvent, ChannelEditedEvent } from "@rootsdk/server-app";
rootServer.community.channels.on(ChannelEvent.ChannelEdited, (evt: ChannelEditedEvent) => {
// ...
});

channel.moved()

channel.moved: (evt: ChannelMovedEvent) => void

Parameters

ParameterType
evtChannelMovedEvent

Returns

void

Example

import { rootServer, ChannelEvent, ChannelMovedEvent } from "@rootsdk/server-app";
rootServer.community.channels.on(ChannelEvent.ChannelMoved, (evt: ChannelMovedEvent) => {
// ...
});