Event Channels

An EventChannel is a named grouping of EventSubscriptions.

List Event Channels

SDK Method

files_sdk.event_channel.list()

Return Object

ListObj[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 files_sdk

try:
  event_channels = files_sdk.event_channel.list()
  for event_channel in event_channels.auto_paging_iter():
    # Operate on event_channel
except files_sdk.error.NotAuthenticatedError as err:
  print(f"Authentication Error Occurred ({type(err).__name__}):", err)
except files_sdk.error.Error as err:
  print(f"Unknown Error Occurred ({type(err).__name__}):", err)

Show Event Channel

SDK Method

files_sdk.event_channel.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 files_sdk

try:
  event_channel = files_sdk.event_channel.find(id)
  # Operate on event_channel
except files_sdk.error.NotAuthenticatedError as err:
  print(f"Authentication Error Occurred ({type(err).__name__}):", err)
except files_sdk.error.Error as err:
  print(f"Unknown Error Occurred ({type(err).__name__}):", err)

Create Event Channel

SDK Method

files_sdk.event_channel.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 files_sdk

try:
  event_channel = files_sdk.event_channel.create({
    "name": "example"
  })
  # Operate on event_channel
except files_sdk.error.NotAuthenticatedError as err:
  print(f"Authentication Error Occurred ({type(err).__name__}):", err)
except files_sdk.error.Error as err:
  print(f"Unknown Error Occurred ({type(err).__name__}):", err)

Update Event Channel

SDK Method

event_channel.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 files_sdk

try:
  # Find the event_channel object by its id.
  event_channel = files_sdk.event_channel.find(id)
  event_channel.update({
    "name": "example"
  })
except files_sdk.error.NotAuthenticatedError as err:
  print(f"Authentication Error Occurred ({type(err).__name__}):", err)
except files_sdk.error.Error as err:
  print(f"Unknown Error Occurred ({type(err).__name__}):", err)

Delete Event Channel

SDK Method

event_channel.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 files_sdk

try:
  # Find the event_channel object by its id.
  event_channel = files_sdk.event_channel.find(id)
  event_channel.delete()
except files_sdk.error.NotAuthenticatedError as err:
  print(f"Authentication Error Occurred ({type(err).__name__}):", err)
except files_sdk.error.Error as err:
  print(f"Unknown Error Occurred ({type(err).__name__}):", 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.