Class ChannelAPI

A wrapper for the Foxogram channel API.

Index

Constructors

Methods

create delete edit get join leave member members

Constructors

constructor

new ChannelAPI(rest: REST): ChannelAPI
Parameters
- rest: REST
Returns ChannelAPI
- Defined in ChannelAPI.ts:22

Methods

create

create(body: RESTPostAPIChannelBody): Promise<APIChannel>
Creates a new channel.
Parameters
- body: RESTPostAPIChannelBody
Returns Promise<APIChannel>
- Defined in ChannelAPI.ts:45

delete

delete(channelId: number): Promise<APIOk>
Deletes the channel.
Parameters
- channelId: number
Returns Promise<APIOk>
- Defined in ChannelAPI.ts:64

edit

edit(channelId: number, body: RESTPatchAPIChannelBody): Promise<APIChannel>
Edits the channel.
Parameters
- channelId: number
- body: RESTPatchAPIChannelBody
Returns Promise<APIChannel>
- Defined in ChannelAPI.ts:73

get

get(channelId: number): Promise<APIChannel>
Fetches a channel.
Parameters
- channelId: number
Returns Promise<APIChannel>
- Defined in ChannelAPI.ts:55

join

join(channelId: number): Promise<APIMember>
Joins the current user to the channel.
Parameters
- channelId: number
Returns Promise<APIMember>
- Defined in ChannelAPI.ts:27

leave

leave(channelId: number): Promise<APIOk>
Leaves the current user to the channel.
Parameters
- channelId: number
Returns Promise<APIOk>
- Defined in ChannelAPI.ts:36

member

member(channelId: number, memberKey: MemberKey): Promise<APIMember>
Gets a member from the channel.
Parameters
- channelId: number
- memberKey: MemberKey
Returns Promise<APIMember>
- Defined in ChannelAPI.ts:83

members

members(channelId: number): Promise<RESTGetAPIChannelMembersResult>
Lists members in the channel.
Parameters
- channelId: number
Returns Promise<RESTGetAPIChannelMembersResult>
- Defined in ChannelAPI.ts:92