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

Class RemoveClientDeviceApiRequest

java.lang.Object

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

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

All Implemented Interfaces:

VoidExecutableApiRequest

public class RemoveClientDeviceApiRequest
extends ZulipApiRequest
implements VoidExecutableApiRequest

Zulip API request builder for removing a registered device when the user logs out.

See Also:

• https://zulip.com/api/remove-client-device

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEVICE_ID

Constructor Summary

Constructors

Constructor	Description
RemoveClientDeviceApiRequest(ZulipHttpClient client, long deviceId)	Constructs a RemoveClientDeviceApiRequest.

Method Summary

Modifier and Type	Method	Description
void	execute()	Executes the Zulip API request for removing a registered device.

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

DEVICE_ID

public static final String DEVICE_ID

See Also:

• Constant Field Values

Constructor Details

RemoveClientDeviceApiRequest

public RemoveClientDeviceApiRequest(ZulipHttpClient client,
 long deviceId)

Constructs a RemoveClientDeviceApiRequest.

Parameters:

client - The Zulip HTTP client

deviceId - The ID of the device to remove

Method Details

execute

public void execute()
             throws ZulipClientException

Executes the Zulip API request for removing a registered device.

Specified by:

execute in interface VoidExecutableApiRequest

Throws:

ZulipClientException - if the request was not successful