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

Class SetTypingStatusApiRequest

java.lang.Object

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

com.github.jamesnetherton.zulip.client.api.user.request.SetTypingStatusApiRequest

All Implemented Interfaces:

VoidExecutableApiRequest

public class SetTypingStatusApiRequest
extends ZulipApiRequest
implements VoidExecutableApiRequest

Zulip API request builder for setting user 'typing' status.

See Also:

• https://zulip.com/api/set-typing-status

Field Summary

Fields

Modifier and Type	Field	Description
static final String	OPERATION
static final String	STREAM_ID
static final String	TO
static final String	TOPIC
static final String	TYPE

Constructor Summary

Constructors

Constructor	Description
SetTypingStatusApiRequest(ZulipHttpClient client, TypingOperation operation, long... userIds)	Constructs a SetTypingStatusApiRequest.
SetTypingStatusApiRequest(ZulipHttpClient client, TypingOperation operation, long streamId, String topic)	Constructs a SetTypingStatusApiRequest.

Method Summary

Modifier and Type	Method	Description
void	execute()	Executes the Zulip API request for setting user 'typing' status.

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

client, 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

OPERATION

public static final String OPERATION

See Also:

• Constant Field Values

STREAM_ID

public static final String STREAM_ID

See Also:

• Constant Field Values

TO

public static final String TO

See Also:

• Constant Field Values

TOPIC

public static final String TOPIC

See Also:

• Constant Field Values

TYPE

public static final String TYPE

See Also:

• Constant Field Values

Constructor Details

SetTypingStatusApiRequest

public SetTypingStatusApiRequest(ZulipHttpClient client,
 TypingOperation operation,
 long... userIds)

Constructs a SetTypingStatusApiRequest.

Parameters:

client - The Zulip HTTP client

operation - The typing operation to apply

userIds - Array of user ids to add to set the typing status for

SetTypingStatusApiRequest

public SetTypingStatusApiRequest(ZulipHttpClient client,
 TypingOperation operation,
 long streamId,
 String topic)

Constructs a SetTypingStatusApiRequest.

Parameters:

client - The Zulip HTTP client

operation - The typing operation to apply

streamId - The id of the stream in which the message is being typed

topic - The name of the topic in which the message is being typed

Method Details

execute

public void execute()
             throws ZulipClientException

Executes the Zulip API request for setting user 'typing' status.

Specified by:

execute in interface VoidExecutableApiRequest

Throws:

ZulipClientException - if the request was not successful