Class MessageApi

MessageApi - object-oriented interface

export

Hierarchy

BaseAPI
- MessageApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

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

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 MessageApi

Properties

Protected axios

axios: AxiosInstance

Protected basePath

basePath: string

Protected configuration

configuration: Configuration | undefined

Methods

deleteMessage

deleteMessage(id: number, options?: any): Promise<AxiosResponse<ReplyThread>>

- Defined in api.ts:2524
Deletes a message.

summary

Delete Message

throws

{RequiredError}

memberof

MessageApi

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

getMessage

getMessage(id: number, options?: any): Promise<AxiosResponse<Message>>

- Defined in api.ts:2536
Gets a message.

summary

Get Message

throws

{RequiredError}

memberof

MessageApi

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

getMessages

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

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

summary

Get Messages

throws

{RequiredError}

memberof

MessageApi

Parameters
- 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>>

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