kient / ChannelAPI

Class: ChannelAPI

src/api/channel/index.ts:9

Description placeholder

Extends

• APIBase

Constructors

new ChannelAPI()

new ChannelAPI(kient): ChannelAPI

src/api/api-base.ts:7

Parameters

Parameter	Type
kient	Kient

Returns

ChannelAPI

Inherited from

APIBase.constructor

Properties

Property	Modifier	Type	Inherited from	Defined in
kient	readonly	Kient	APIBase.kient	src/api/api-base.ts:5

Methods

getAuthorisedUser()

getAuthorisedUser(): Promise<Channel>

src/api/channel/index.ts:49

Returns the currently authorised user's channel details

Returns

Promise<Channel>

---

getById()

getById(id): Promise<Channel>

src/api/channel/index.ts:24

Returns a singular channel by ID

Parameters

Parameter	Type	Description
id	number	Accepts a singular user ID that will be queried for

Returns

Promise<Channel>

---

getByIds()

getByIds(ids): Promise<Channel[]>

src/api/channel/index.ts:15

Returns an array of channel by an array of user IDs

Parameters

Parameter	Type	Description
ids	number[]	Accepts an array of user IDs that will be queried for

Returns

Promise<Channel[]>

---

getBySlug()

getBySlug(slug): Promise<Channel>

src/api/channel/index.ts:42

Returns a singular channel by slug

Parameters

Parameter	Type	Description
slug	string	Accepts a singular channel slug that will be queried for

Returns

Promise<Channel>

---

getBySlugs()

getBySlugs(slugs): Promise<Channel[]>

src/api/channel/index.ts:33

Returns an array of channel by an array of channel slugs

Parameters

Parameter	Type	Description
slugs	string[]	Accepts an array of channel slugs that will be queried for

Returns

Promise<Channel[]>