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 (
    "fmt"
    "errors"

    files_sdk "github.com/Files-com/files-sdk-go/v3"
    event_channel "github.com/Files-com/files-sdk-go/v3/eventchannel"
)

eventChannelIterator, err := event_channel.List(files_sdk.EventChannelListParams{})
if err != nil {
    var respErr files_sdk.ResponseError
    if errors.As(err, &respErr) {
        fmt.Println("Response Error Occurred (" + respErr.Type + "): " + respErr.ErrorMessage)
    } else {
        fmt.Printf("Unexpected Error: %s\n", err.Error())
    }
}

for eventChannelIterator.Next() {
    eventChannel := eventChannelIterator.eventChannel()
}
err = eventChannelIterator.Err()
if err != nil {
    var respErr files_sdk.ResponseError
    if errors.As(err, &respErr) {
        fmt.Println("Response Error Occurred (" + respErr.Type + "): " + respErr.ErrorMessage)
    } else {
        fmt.Printf("Unexpected Error: %s\n", err.Error())
    }
}

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.

EventChannelFindParams Fields

FieldDescription
Id
int64
Required		Event Channel ID.

Example Request

import (
    "fmt"
    "errors"

    files_sdk "github.com/Files-com/files-sdk-go/v3"
    event_channel "github.com/Files-com/files-sdk-go/v3/eventchannel"
)

eventChannel, err := event_channel.Find(files_sdk.EventChannelFindParams{Id: 1})
if err != nil {
    var respErr files_sdk.ResponseError
    if errors.As(err, &respErr) {
        fmt.Println("Response Error Occurred (" + respErr.Type + "): " + respErr.ErrorMessage)
    } else {
        fmt.Printf("Unexpected Error: %s\n", err.Error())
    }
}

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.

EventChannelCreateParams Fields

FieldDefaultDescription
Name
string
Required		Event Channel name.
WorkspaceId
int64		0Workspace ID. 0 means the default workspace.
Description
string		Event Channel description.
Enabled
boolean		trueWhether this Event Channel can dispatch events.
DefaultChannel
boolean		falseWhether this Event Channel is the default destination for newly published events.

Example Request

import (
    "fmt"
    "errors"

    files_sdk "github.com/Files-com/files-sdk-go/v3"
    event_channel "github.com/Files-com/files-sdk-go/v3/eventchannel"
)

eventChannel, err := event_channel.Create(files_sdk.EventChannelCreateParams{Name: "example"})
if err != nil {
    var respErr files_sdk.ResponseError
    if errors.As(err, &respErr) {
        fmt.Println("Response Error Occurred (" + respErr.Type + "): " + respErr.ErrorMessage)
    } else {
        fmt.Printf("Unexpected Error: %s\n", err.Error())
    }
}

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.

EventChannelUpdateParams Fields

FieldDescription
Id
int64
Required		Event Channel ID.
Name
string		Event Channel name.
WorkspaceId
int64		Workspace ID. 0 means the default workspace.
Description
string		Event Channel description.
Enabled
boolean		Whether this Event Channel can dispatch events.
DefaultChannel
boolean		Whether this Event Channel is the default destination for newly published events.

Example Request

import (
    "fmt"
    "errors"

    files_sdk "github.com/Files-com/files-sdk-go/v3"
    event_channel "github.com/Files-com/files-sdk-go/v3/eventchannel"
)

eventChannel, err := event_channel.Update(files_sdk.EventChannelUpdateParams{
  Id: 1,
  Name: "example"
})
if err != nil {
    var respErr files_sdk.ResponseError
    if errors.As(err, &respErr) {
        fmt.Println("Response Error Occurred (" + respErr.Type + "): " + respErr.ErrorMessage)
    } else {
        fmt.Printf("Unexpected Error: %s\n", err.Error())
    }
}

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.

EventChannelDeleteParams Fields

FieldDescription
Id
int64
Required		Event Channel ID.

Example Request

import (
    "fmt"
    "errors"

    files_sdk "github.com/Files-com/files-sdk-go/v3"
    event_channel "github.com/Files-com/files-sdk-go/v3/eventchannel"
)

err := event_channel.Delete(files_sdk.EventChannelDeleteParams{Id: 1})
if err != nil {
    var respErr files_sdk.ResponseError
    if errors.As(err, &respErr) {
        fmt.Println("Response Error Occurred (" + respErr.Type + "): " + respErr.ErrorMessage)
    } else {
        fmt.Printf("Unexpected Error: %s\n", err.Error())
    }
}

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.
WorkspaceId
int64		Workspace ID. 0 means the default workspace.
Description
string		Event Channel description.
Enabled
boolean		Whether this Event Channel can dispatch events.
DefaultChannel
boolean		Whether this Event Channel is the default destination for newly published events.
CreatedAt
date-time		Event Channel create date/time.
UpdatedAt
date-time		Event Channel update date/time.