Class ChannelApi

ChannelApi - object-oriented interface

export

Hierarchy

BaseAPI
- ChannelApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new ChannelApi(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): ChannelApi

Inherited from BaseAPI.constructor
- Defined in base.ts:50
Parameters
- Optional configuration: Configuration
- Default value basePath: string = BASE_PATH
- Default value axios: AxiosInstance = globalAxios
Returns ChannelApi

Properties

Protected axios

axios: AxiosInstance

Protected basePath

basePath: string

Protected configuration

configuration: Configuration | undefined

Methods

createChannel

createChannel(createDirectChannelRequestCreatePublicChannelRequestCreatePrivateChannelRequest: CreateDirectChannelRequest | CreatePublicChannelRequest | CreatePrivateChannelRequest, options?: any): Promise<AxiosResponse<Channel>>

- Defined in api.ts:2105
Creates a new channel.

summary

Create Channel

throws

{RequiredError}

memberof

ChannelApi

Parameters
- createDirectChannelRequestCreatePublicChannelRequestCreatePrivateChannelRequest: CreateDirectChannelRequest | CreatePublicChannelRequest | CreatePrivateChannelRequest
  
  New channel parameters
- Optional options: any
Returns Promise<AxiosResponse<Channel>>

createChannelMember

createChannelMember(id: number, resourceReference: ResourceReference, options?: any): Promise<AxiosResponse<User>>

- Defined in api.ts:2118
Adds a user as a group channel member.

summary

Create Channel Member

throws

{RequiredError}

memberof

ChannelApi

Parameters
- id: number
- resourceReference: ResourceReference
  
  User resource reference
- Optional options: any
Returns Promise<AxiosResponse<User>>

createChannelMessage

createChannelMessage(id: number, createTextSystemMessageRequestCreateExternalFileSystemMessageRequest: CreateTextSystemMessageRequest | CreateExternalFileSystemMessageRequest, options?: any): Promise<AxiosResponse<Message>>

- Defined in api.ts:2131
Sends a new system message.

summary

Create Channel System Message

throws

{RequiredError}

memberof

ChannelApi

Parameters
- id: number
- createTextSystemMessageRequestCreateExternalFileSystemMessageRequest: CreateTextSystemMessageRequest | CreateExternalFileSystemMessageRequest
  
  New message parameters
- Optional options: any
Returns Promise<AxiosResponse<Message>>

deleteChannel

deleteChannel(id: number, options?: any): Promise<AxiosResponse<Application>>

- Defined in api.ts:2143
Deletes a channel.

summary

Delete Channel

throws

{RequiredError}

memberof

ChannelApi

Parameters
- id: number
- Optional options: any
Returns Promise<AxiosResponse<Application>>

deleteChannelMembership

deleteChannelMembership(id: number, userId: number, options?: any): Promise<AxiosResponse<Channel>>

- Defined in api.ts:2156
Deletes a user's channel membership. Removes a user from a channel.

summary

Delete Channel Membership

throws

{RequiredError}

memberof

ChannelApi

Parameters
- id: number
  
  Channel ID
- userId: number
  
  User ID
- Optional options: any
Returns Promise<AxiosResponse<Channel>>

getChannel

getChannel(id: number, options?: any): Promise<AxiosResponse<Channel>>

- Defined in api.ts:2168
Gets a channel.

summary

Get Channel

throws

{RequiredError}

memberof

ChannelApi

Parameters
- id: number
- Optional options: any
Returns Promise<AxiosResponse<Channel>>

getChannelMembers

getChannelMembers(id: number, page?: number, size?: number, options?: any): Promise<AxiosResponse<UserPage>>

- Defined in api.ts:2182
Gets a page of channel members.

summary

Get Channel Members

throws

{RequiredError}

memberof

ChannelApi

Parameters
- id: number
- Optional page: number
- Optional size: number
- Optional options: any
Returns Promise<AxiosResponse<UserPage>>

getChannelMessages

getChannelMessages(id: number, start?: number, next?: number, size?: number, relation?: "SELF" | "PREVIOUS" | "NEXT", username?: string, query?: string, options?: any): Promise<AxiosResponse<MessagePage>>

- Defined in api.ts:2200
Gets a page of channel messages.

summary

Get Channel Messages

throws

{RequiredError}

memberof

ChannelApi

Parameters
- id: number
- Optional start: number
- Optional next: number
- Optional size: number
- Optional relation: "SELF" | "PREVIOUS" | "NEXT"
- Optional username: string
- Optional query: string
- Optional options: any
Returns Promise<AxiosResponse<MessagePage>>

getChannels

getChannels(page?: number, size?: number, type?: "DIRECT" | "PUBLIC" | "PRIVATE", options?: any): Promise<AxiosResponse<ChannelPage>>

- Defined in api.ts:2214
Gets a channel page.

summary

Get Channel Page

throws

{RequiredError}

memberof

ChannelApi

Parameters
- Optional page: number
- Optional size: number
- Optional type: "DIRECT" | "PUBLIC" | "PRIVATE"
- Optional options: any
Returns Promise<AxiosResponse<ChannelPage>>

Generated using TypeDoc, the 9/1/2021 at 5:54:10 AM