Class EmojiApi

EmojiApi - object-oriented interface

Export

Hierarchy

BaseAPI
- EmojiApi

Index

Constructors

Properties

axios basePath configuration

Methods

createEmoji deleteEmoji getEmojis

Constructors

constructor

new EmojiApi(configuration?, basePath?, axios?): EmojiApi
Parameters
- Optional configuration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns EmojiApi
Inherited from BaseAPI.constructor
- Defined in client/base.ts:51

Properties

`Protected` axios

axios: AxiosInstance = globalAxios

`Protected` basePath

basePath: string = BASE_PATH

`Protected` configuration

configuration: undefined | Configuration

Methods

createEmoji

createEmoji(requestParameters, options?): Promise<AxiosResponse<CreatedEmoji, any>>
新しい絵文字を登録します。
Parameters
- requestParameters: EmojiApiCreateEmojiRequest
  
  Request parameters.
- Optional options: any
  
  Override http request option.
Returns Promise<AxiosResponse<CreatedEmoji, any>>

Summary
絵文字を登録する

Throws

Memberof
EmojiApi
- Defined in client/api/emoji-api.ts:508

deleteEmoji

deleteEmoji(requestParameters, options?): Promise<AxiosResponse<void, any>>
登録したチーム固有の絵文字を削除します。
Parameters
- requestParameters: EmojiApiDeleteEmojiRequest
  
  Request parameters.
- Optional options: any
  
  Override http request option.
Returns Promise<AxiosResponse<void, any>>

Summary
絵文字を削除する

Throws

Memberof
EmojiApi
- Defined in client/api/emoji-api.ts:529

getEmojis

getEmojis(requestParameters, options?): Promise<AxiosResponse<EmojiList, any>>
チームで利用可能な絵文字を取得します。URIクエリ文字列を含めない場合、チーム固有の絵文字だけを取得します。
Parameters
- requestParameters: EmojiApiGetEmojisRequest
  
  Request parameters.
- Optional options: any
  
  Override http request option.
Returns Promise<AxiosResponse<EmojiList, any>>

Summary
絵文字一覧を取得する

Throws

Memberof
EmojiApi
- Defined in client/api/emoji-api.ts:546

Generated using TypeDoc