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

Class RegisterClientDeviceApiRequest

java.lang.Object

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

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

All Implemented Interfaces:

ExecutableApiRequest<Long>

public class RegisterClientDeviceApiRequest
extends ZulipApiRequest
implements ExecutableApiRequest<Long>

Zulip API request builder for registering a logged-in device as an initial step before registering for E2EE push notifications.

See Also:

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

Constructor Summary

Constructors

Constructor	Description
RegisterClientDeviceApiRequest(ZulipHttpClient client)	Constructs a RegisterClientDeviceApiRequest.

Method Summary

Modifier and Type	Method	Description
Long	execute()	Executes the Zulip API request for registering a logged-in 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

Constructor Details

RegisterClientDeviceApiRequest

public RegisterClientDeviceApiRequest(ZulipHttpClient client)

Constructs a RegisterClientDeviceApiRequest.

Parameters:

client - The Zulip HTTP client

Method Details

execute

public Long execute()
             throws ZulipClientException

Executes the Zulip API request for registering a logged-in device.

Specified by:

execute in interface ExecutableApiRequest<Long>

Returns:

The ID of the newly registered device

Throws:

ZulipClientException - if the request was not successful