Channel

Object representing a fully-initialised channel.

Whenever the service returns any kind of channel info, it'll always be with this type.

Hierarchy

  • Channel

Index

Properties

Properties

color

color: number

The colour that should be associated within this channel when displaying this channel in a UI

id

Would be generated by the service - what you pass to the API calls below

name

name: string

A user-readable name for this channel, e.g: "Red"

type

type: "global" | "user"

Uniquely defines each channel type

Currently two channel types. More may be added in the future.