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

Class RegisterE2EMobilePushDevice

java.lang.Object

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

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

All Implemented Interfaces:

VoidExecutableApiRequest

public class RegisterE2EMobilePushDevice
extends ZulipApiRequest
implements VoidExecutableApiRequest

Zulip API request builder for registering a E2E mobile push device.

See Also:

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BOUNCER_PUBLIC_KEY
static final String	ENCRYPTED_PUSH_REGISTRATION
static final String	PUSH_ACCOUNT_ID
static final String	PUSH_PUBLIC_KEY
static final String	TOKEN_KIND

Constructor Summary

Constructors

Constructor	Description
RegisterE2EMobilePushDevice(ZulipHttpClient client, TokenKind tokenKind, int pushAccountId, String pushPublicKey, String bouncerPublicKey, String encryptedPushRegistration)	RegisterE2EMobilePushDevice a ZulipApiRequest.

Method Summary

Modifier and Type	Method	Description
void	execute()	Executes the Zulip API request for registering a E2E mobile push 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

TOKEN_KIND

public static final String TOKEN_KIND

See Also:

• Constant Field Values

PUSH_ACCOUNT_ID

public static final String PUSH_ACCOUNT_ID

See Also:

• Constant Field Values

PUSH_PUBLIC_KEY

public static final String PUSH_PUBLIC_KEY

See Also:

• Constant Field Values

BOUNCER_PUBLIC_KEY

public static final String BOUNCER_PUBLIC_KEY

See Also:

• Constant Field Values

ENCRYPTED_PUSH_REGISTRATION

public static final String ENCRYPTED_PUSH_REGISTRATION

See Also:

• Constant Field Values

Constructor Details

RegisterE2EMobilePushDevice

public RegisterE2EMobilePushDevice(ZulipHttpClient client,
 TokenKind tokenKind,
 int pushAccountId,
 String pushPublicKey,
 String bouncerPublicKey,
 String encryptedPushRegistration)

RegisterE2EMobilePushDevice a ZulipApiRequest.

Parameters:

client - The Zulip HTTP client

tokenKind - The TokenKind for how the token was generated

pushAccountId - Random integer to be included in mobile push notifications invalid input: '&' encrypted payloads to identify pushes as being related to this registration

pushPublicKey - Push public key encoded using an RFC 4648 standard base64 encoder

bouncerPublicKey - Bouncer public key encoded using an RFC 4648 standard base64 encoder

encryptedPushRegistration - Ciphertext generated by encrypting a PushRegistration Map using the bouncer_public_key field. Encoded using an RFC 4648 standard base64 encoder. The PushRegistration map contains fields token, token_kind, timestamp, and for iOS devices ios_app_id. The map must be JSON encoded before encryption.

Method Details

execute

public void execute()
             throws ZulipClientException

Executes the Zulip API request for registering a E2E mobile push device.

Specified by:

execute in interface VoidExecutableApiRequest

Throws:

ZulipClientException - if the request was not successful