Function EmojiApiFactory

  • EmojiApi - factory interface

    Parameters

    • Optional configuration: Configuration
    • Optional basePath: string
    • Optional axios: AxiosInstance

    Returns {
        createEmoji(teamName, createEmojiBody, options?) => AxiosPromise<CreatedEmoji>;
        deleteEmoji(teamName, code, options?) => AxiosPromise<void>;
        getEmojis(teamName, include?, options?) => AxiosPromise<EmojiList>;
    }

    • createEmoji:function
      • 新しい絵文字を登録します。

        Parameters

        • teamName: string

          チーム名

        • createEmojiBody: CreateEmojiBody
        • Optional options: any

          Override http request option.

        Returns AxiosPromise<CreatedEmoji>

        Summary

        絵文字を登録する

        Throws

    • deleteEmoji:function
      • 登録したチーム固有の絵文字を削除します。

        Parameters

        • teamName: string

          チーム名

        • code: string

          絵文字コード

        • Optional options: any

          Override http request option.

        Returns AxiosPromise<void>

        Summary

        絵文字を削除する

        Throws

    • getEmojis:function
      • チームで利用可能な絵文字を取得します。URIクエリ文字列を含めない場合、チーム固有の絵文字だけを取得します。

        Parameters

        • teamName: string

          チーム名

        • Optional include: "all"

          `all`を指定すると、チーム固有の絵文字だけではなく、すべての絵文字を返します。

        • Optional options: any

          Override http request option.

        Returns AxiosPromise<EmojiList>

        Summary

        絵文字一覧を取得する

        Throws

    Export

Generated using TypeDoc