Class AnnouncementCommentsService

constructor

• new AnnouncementCommentsService(httpRequest): AnnouncementCommentsService

• Parameters

  • httpRequest: BaseHttpRequest

  Returns AnnouncementCommentsService

Readonly httpRequest

announcementCommentCreate

• announcementCommentCreate(options): CancelablePromise<{
      announcementComment: AnnouncementCommentPayload;
  }>

• Create a comment on an announcement

  Throws

  ApiError

  Parameters

  • options: {
        announcementId: string;
        channelId: string;
        requestBody: {
            content: string;
        };
    }

    • announcementId: string

    • channelId: string

    • requestBody: {
          content: string;
      }

      • content: string

        The content of the announcement comment

  Returns CancelablePromise<{
      announcementComment: AnnouncementCommentPayload;
  }>

  any Success

announcementCommentDelete

• announcementCommentDelete(options): CancelablePromise<void>

• Delete an announcement comment

  Throws

  ApiError

  Parameters

  • options: {
        announcementCommentId: number;
        announcementId: string;
        channelId: string;
    }

    • announcementCommentId: number

    • announcementId: string

    • channelId: string

  Returns CancelablePromise<void>

  void

announcementCommentRead

• announcementCommentRead(options): CancelablePromise<{
      announcementComment: AnnouncementCommentPayload;
  }>

• Get a comment on the announcement

  Throws

  ApiError

  Parameters

  • options: {
        announcementCommentId: number;
        announcementId: string;
        channelId: string;
    }

    • announcementCommentId: number

    • announcementId: string

    • channelId: string

  Returns CancelablePromise<{
      announcementComment: AnnouncementCommentPayload;
  }>

  any Success

announcementCommentReadMany

• announcementCommentReadMany(options): CancelablePromise<{
      announcementComments: AnnouncementCommentPayload[];
  }>

• Get an announcement's comments

  Throws

  ApiError

  Parameters

  • options: {
        announcementId: string;
        channelId: string;
    }

    • announcementId: string

    • channelId: string

  Returns CancelablePromise<{
      announcementComments: AnnouncementCommentPayload[];
  }>

  any Success

announcementCommentUpdate

• announcementCommentUpdate(options): CancelablePromise<{
      announcementComment: AnnouncementCommentPayload;
  }>

• Update an announcement comment

  Throws

  ApiError

  Parameters

  • options: {
        announcementCommentId: number;
        announcementId: string;
        channelId: string;
        requestBody: {
            content: string;
        };
    }

    • announcementCommentId: number

    • announcementId: string

    • channelId: string

    • requestBody: {
          content: string;
      }

      • content: string

        The content of the announcement comment

  Returns CancelablePromise<{
      announcementComment: AnnouncementCommentPayload;
  }>

  any Success