Package com.github.jamesnetherton.zulip.client.api.message.request

Class ReportMessageApiRequest

java.lang.Object

com.github.jamesnetherton.zulip.client.api.core.ZulipApiRequest

com.github.jamesnetherton.zulip.client.api.message.request.ReportMessageApiRequest

All Implemented Interfaces:

VoidExecutableApiRequest

public class ReportMessageApiRequest
extends ZulipApiRequest
implements VoidExecutableApiRequest

Zulip API request builder for reporting a message for moderation.

See Also:

• https://zulip.com/api/report-message

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DESCRIPTION
static final String	REPORT_TYPE

Constructor Summary

Constructors

Constructor	Description
ReportMessageApiRequest(ZulipHttpClient client, long messageId, MessageReportReason reportReason)	Constructs a RenderMessageApiRequest.

Method Summary

Modifier and Type	Method	Description
void	execute()	Executes the Zulip API request for reporting a message for moderation.
ReportMessageApiRequest	withDescription(String description)	Sets a short description with additional context about why the current user is reporting the target message for moderation.

Methods inherited from class com.github.jamesnetherton.zulip.client.api.core.ZulipApiRequest

client, getParam, getParam, getParams, putParam, putParamAsJsonString, putParamAsWrappedObject

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

DESCRIPTION

public static final String DESCRIPTION

See Also:

• Constant Field Values

REPORT_TYPE

public static final String REPORT_TYPE

See Also:

• Constant Field Values

Constructor Details

ReportMessageApiRequest

public ReportMessageApiRequest(ZulipHttpClient client,
 long messageId,
 MessageReportReason reportReason)

Constructs a RenderMessageApiRequest.

Parameters:

client - The Zulip HTTP client

messageId - The id of the message to report

reportReason - The reason for the message report

Method Details

withDescription

public ReportMessageApiRequest withDescription(String description)

Sets a short description with additional context about why the current user is reporting the target message for moderation. If the given MessageReportReason is MessageReportReason.OTHER then a description is required.

Parameters:

description - Short description

Returns:

This ReportMessageApiRequest instance

execute

public void execute()
             throws ZulipClientException

Executes the Zulip API request for reporting a message for moderation.

Specified by:

execute in interface VoidExecutableApiRequest

Throws:

ZulipClientException - if the request was not successful