Interface ArenaChannelApi

Hierarchy

ArenaChannelApi

Index

Properties

connect disconnect sort

Methods

connections contents create createBlock delete get thumb update

Properties

connect

connect: {
block(id) => Promise<ChannelConnectBlockApiResponse>;
channel(id) => Promise<ChannelConnectChannelApiResponse>;
}

Type declaration

block:function
- block(id): Promise<ChannelConnectBlockApiResponse>
- Parameters
  - id: number
  Returns Promise<ChannelConnectBlockApiResponse>
  - Defined in arena_service.ts:105
channel:function
- channel(id): Promise<ChannelConnectChannelApiResponse>
- Parameters
  - id: number
  Returns Promise<ChannelConnectChannelApiResponse>
  - Defined in arena_service.ts:106

disconnect

disconnect: {
block(id) => Promise<void>;
connection(id) => Promise<void>;
}

Type declaration

block:function
- block(id): Promise<void>
- Parameters
  - id: number
  Returns Promise<void>
  - Defined in arena_service.ts:109
connection:function
- connection(id): Promise<void>
- Parameters
  - id: number
  Returns Promise<void>
  - Defined in arena_service.ts:110

sort

sort: {
block(id, position) => Promise<void>;
channel(id, position) => Promise<void>;
}

Type declaration

block:function
- block(id, position): Promise<void>
- Parameters
  - id: number
  - position: number
  Returns Promise<void>
  - Defined in arena_service.ts:90
channel:function
- channel(id, position): Promise<void>
- Parameters
  - id: number
  - position: number
  Returns Promise<void>
  - Defined in arena_service.ts:91

Methods

connections

connections(options?): Promise<GetConnectionsApiResponse[]>
Parameters
- Optional options: PaginationAttributes
Returns Promise<GetConnectionsApiResponse[]>
- Defined in arena_service.ts:113

contents

contents(options?): Promise<GetChannelContentsApiResponse>
Parameters
- Optional options: PaginationAttributes
Returns Promise<GetChannelContentsApiResponse>
- Defined in arena_service.ts:94

create

create(status?): Promise<CreateChannelApiResponse>
Parameters
- Optional status: ChannelStatus
Returns Promise<CreateChannelApiResponse>
- Defined in arena_service.ts:79

createBlock

createBlock(data): Promise<CreateBlockApiResponse>
Parameters
- data: {
      content?: string;
      description?: string;
      source?: string;
  }
  - Optional content?: string
  - Optional description?: string
  - Optional source?: string
Returns Promise<CreateBlockApiResponse>
- Defined in arena_service.ts:98

delete

delete(): Promise<undefined>
Returns Promise<undefined>
- Defined in arena_service.ts:83

get

get(options?): Promise<GetChannelsApiResponse>
Parameters
- Optional options: PaginationAttributes
Returns Promise<GetChannelsApiResponse>
- Defined in arena_service.ts:81

thumb

thumb(): Promise<GetChannelThumbApiResponse>
Returns Promise<GetChannelThumbApiResponse>
- Defined in arena_service.ts:87

update

update(data): Promise<undefined>
Parameters
- data: {
  status?: ChannelStatus;
  title: string;
  }
  - Optional status?: ChannelStatus
  - title: string
Returns Promise<undefined>
- Defined in arena_service.ts:85

Generated using TypeDoc