Event Channels

An EventChannel is a named grouping of EventSubscriptions.

List Event Channels

SDK Method

EventChannel.list()

Return Object

EventChannel[]

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Additional Arguments

Example Request

import EventChannel from 'files.com/lib/models/EventChannel';
import * as FilesErrors from 'files.com/lib/Errors';

try {
  const eventChannels = await EventChannel.list();
  for (const eventChannel of eventChannels) {
    // Operate on eventChannel
  }
} catch (err) {
  if (err instanceof FilesErrors.NotAuthenticatedError) {
    console.error(`Authentication Error Occurred (${err.constructor.name}): ${err.error}`);
  } else if (err instanceof FilesErrors.FilesError) {
    console.error(`Unknown Error Occurred (${err.constructor.name}): ${err.error}`);
  } else {
    throw err;
  }
}

Show Event Channel

SDK Method

EventChannel.find()

Return Object

EventChannel

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Method Arguments

ArgumentDescription
id
int64
Required		Event Channel ID.

Example Request

import EventChannel from 'files.com/lib/models/EventChannel';
import * as FilesErrors from 'files.com/lib/Errors';

try {
  const eventChannel = await EventChannel.find(id);
  // Operate on eventChannel
} catch (err) {
  if (err instanceof FilesErrors.NotAuthenticatedError) {
    console.error(`Authentication Error Occurred (${err.constructor.name}): ${err.error}`);
  } else if (err instanceof FilesErrors.FilesError) {
    console.error(`Unknown Error Occurred (${err.constructor.name}): ${err.error}`);
  } else {
    throw err;
  }
}

Create Event Channel

SDK Method

EventChannel.create()

Return Object

EventChannel

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Method Arguments

ArgumentDefaultDescription
name
string
Required		Event Channel name.
workspace_id
int64		0Workspace ID. 0 means the default workspace.
description
string		Event Channel description.
enabled
boolean		trueWhether this Event Channel can dispatch events.
default_channel
boolean		falseWhether this Event Channel is the default destination for newly published events.

Example Request

import EventChannel from 'files.com/lib/models/EventChannel';
import * as FilesErrors from 'files.com/lib/Errors';

try {
  const eventChannel = await EventChannel.create({
    name: "example",
  });
  // Operate on eventChannel
} catch (err) {
  if (err instanceof FilesErrors.NotAuthenticatedError) {
    console.error(`Authentication Error Occurred (${err.constructor.name}): ${err.error}`);
  } else if (err instanceof FilesErrors.FilesError) {
    console.error(`Unknown Error Occurred (${err.constructor.name}): ${err.error}`);
  } else {
    throw err;
  }
}

Update Event Channel

SDK Method

eventChannel.update()

Return Object

EventChannel

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Method Arguments

ArgumentDescription
name
string		Event Channel name.
workspace_id
int64		Workspace ID. 0 means the default workspace.
description
string		Event Channel description.
enabled
boolean		Whether this Event Channel can dispatch events.
default_channel
boolean		Whether this Event Channel is the default destination for newly published events.

Example Request

import EventChannel from 'files.com/lib/models/EventChannel';
import * as FilesErrors from 'files.com/lib/Errors';

try {
  // Find the eventChannel object by its id.
  const eventChannel = await EventChannel.find(id);
  await eventChannel.update({
    name: "example",
  });
} catch (err) {
  if (err instanceof FilesErrors.NotAuthenticatedError) {
    console.error(`Authentication Error Occurred (${err.constructor.name}): ${err.error}`);
  } else if (err instanceof FilesErrors.FilesError) {
    console.error(`Unknown Error Occurred (${err.constructor.name}): ${err.error}`);
  } else {
    throw err;
  }
}

Delete Event Channel

SDK Method

eventChannel.delete()

Return Object

No return value.

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Example Request

import EventChannel from 'files.com/lib/models/EventChannel';
import * as FilesErrors from 'files.com/lib/Errors';

try {
  // Find the eventChannel object by its id.
  const eventChannel = await EventChannel.find(id);
  await eventChannel.delete();
} catch (err) {
  if (err instanceof FilesErrors.NotAuthenticatedError) {
    console.error(`Authentication Error Occurred (${err.constructor.name}): ${err.error}`);
  } else if (err instanceof FilesErrors.FilesError) {
    console.error(`Unknown Error Occurred (${err.constructor.name}): ${err.error}`);
  } else {
    throw err;
  }
}

The EventChannel Object

Some of the methods above return a EventChannel object. The attributes of this object are listed below.

AttributeDescription
id
int64		Event Channel ID
name
string		Event Channel name.
workspace_id
int64		Workspace ID. 0 means the default workspace.
description
string		Event Channel description.
enabled
boolean		Whether this Event Channel can dispatch events.
default_channel
boolean		Whether this Event Channel is the default destination for newly published events.
created_at
date-time		Event Channel create date/time.
updated_at
date-time		Event Channel update date/time.