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

Class SendMobilePushTestNotification

java.lang.Object

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

com.github.jamesnetherton.zulip.client.api.server.request.SendMobilePushTestNotification

All Implemented Interfaces:

VoidExecutableApiRequest

public class SendMobilePushTestNotification
extends ZulipApiRequest
implements VoidExecutableApiRequest

Zulip API request builder for sending mobile push test notifications.

See Also:

• https://zulip.com/api/test-notify

Field Summary

Fields

Modifier and Type	Field	Description
static final String	TOKEN

Constructor Summary

Constructors

Constructor	Description
SendMobilePushTestNotification(ZulipHttpClient client)	Constructs a SendMobilePushTestNotification.

Method Summary

Modifier and Type	Method	Description
void	execute()	Executes the Zulip API request for sending mobile push test notifications.
SendMobilePushTestNotification	withToken(String token)	The push token for the device to which to send the test notification.

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

TOKEN

public static final String TOKEN

See Also:

• Constant Field Values

Constructor Details

SendMobilePushTestNotification

public SendMobilePushTestNotification(ZulipHttpClient client)

Constructs a SendMobilePushTestNotification.

Parameters:

client - The Zulip HTTP client

Method Details

withToken

public SendMobilePushTestNotification withToken(String token)

The push token for the device to which to send the test notification.

Parameters:

token - The mobile device token

Returns:

This SendMobilePushTestNotification instance

See Also:

• https://zulip.com/api/test-notify#parameter-token

execute

public void execute()
             throws ZulipClientException

Executes the Zulip API request for sending mobile push test notifications.

Specified by:

execute in interface VoidExecutableApiRequest

Throws:

ZulipClientException - if the request was not successful