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

Class ServerService

java.lang.Object

com.github.jamesnetherton.zulip.client.api.server.ServerService

All Implemented Interfaces:

ZulipService

public class ServerService
extends Object
implements ZulipService

Zulip server management APIs.

Constructor Summary

Constructors

Constructor	Description
ServerService(ZulipHttpClient client)	Constructs a ServerService.

Method Summary

Modifier and Type	Method	Description
AddApnsDeviceTokenApiRequest	addApnsDeviceToken(String token, String appId)	Adds an APNs device token to register for iOS push notifications
AddCodePlaygroundApiRequest	addCodePlayground(String name, String pygmentsLanguage, String urlTemplate)	Adds a code playground.
AddFcmRegistrationTokenApiRequest	addFcmRegistrationToken(String token)	Adds an FCM registration token.
AddLinkifierApiRequest	addLinkifier(String pattern, String urlTemplate)	Adds a linkifier.
AddRealmDomainApiRequest	addRealmDomain(String domain, boolean allowSubdomains)	Adds a domain to the set of allowed email domains in the organization.
CreateBigBlueButtonVideoCallApiRequest	createBigBlueButtonVideoCall(String meetingName)	Creates a BigBlueButton video call.
CreateConstructorGroupsVideoCallApiRequest	createConstructorGroupsVideoCall()	Creates a Constructor Groups video call URL.
CreateProfileFieldApiRequest	createCustomProfileField()	Creates a custom profile field.
CreateDataExportApiRequest	createDataExport()	Creates a data export.
CreateNextcloudTalkVideoCallApiRequest	createNextcloudTalkVideoCall(String roomName)	Creates a Nextcloud Talk video call URL.
CreateWebexVideoCallApiRequest	createWebexVideoCall()	Creates a Webex video call URL.
DeactivateEmojiApiRequest	deactivateEmoji(String emojiName)	Deactivates a custom emoji.
DeleteProfileFieldApiRequest	deleteCustomProfileField(long profileFieldId)	Deletes a custom profile field.
DeleteLinkifierApiRequest	deleteLinkifier(long id)	Deletes a linkifier.
DeleteRealmDomainApiRequest	deleteRealmDomain(String domain)	Removes a domain from the set of allowed email domains in the organization.
GetAllDataExportsApiRequest	getAllDataExports()	Gets all data exports.
GetApiKeyApiRequest	getApiKey(String username, String password)	Gets a user development API key.
GetBotStorageApiRequest	getBotStorage()	Retrieves data stored for the bot user.
GetProfileFieldsApiRequest	getCustomProfileFields()	Gets all custom profile fields.
GetDataExportConsentStateApiRequest	getDataExportConsentState()	Gets users that have consented to their private data being exported.
GetApiKeyApiRequest	getDevelopmentApiKey(String username)	Gets a user development API key.
GetAllEmojiApiRequest	getEmoji()	Gets all custom emoji.
GetLinkifiersApiRequest	getLinkifiers()	Gets all linkifiers.
GetRealmDomainsApiRequest	getRealmDomains()	Gets the allowed email domains configured in the organization.
GetServerSettingsApiRequest	getServerSettings()	Gets Zulip server organization settings.
JwtFetchApiKeyApiRequest	jwtFetchApiKey(String token)	Fetches a Zulip API key using a JWT token.
RegisterClientDeviceApiRequest	registerClientDevice()	Registers a logged-in device as an initial step before registering for E2EE push notifications.
RegisterE2EMobilePushDevice	registerE2EMobilePushDevice(TokenKind tokenKind, int pushAccountId, String pushPublicKey, String bouncerPublicKey, String encryptedPushRegistration)	Registers a E2E mobile push device.
RemoveApnsDeviceTokenApiRequest	removeApnsDeviceToken(String token)	Removes an APNs device token.
RemoveBotStorageApiRequest	removeBotStorage()	Deletes data stored for the bot user.
RemoveClientDeviceApiRequest	removeClientDevice(long deviceId)	Removes a registered device when the user logs out.
RemoveCodePlaygroundApiRequest	removeCodePlayground(long codePlaygroundId)	Removes a code playground.
RemoveFcmRegistrationTokenApiRequest	removeFcmRegistrationToken(String token)	Removes an FCM registration token.
ReorderProfileFieldsApiRequest	reorderCustomProfileFields(int... order)	Reorders custom profile fields.
ReorderLinkifiersApiRequest	reorderLinkifiers(long... order)	Reorders linkifiers.
SendE2EMobilePushTestNotification	sendE2EMobilePushTestNotification()	Sends E2E mobile push test notifications.
SendMobilePushTestNotification	sendMobilePushTestNotification()	Sends mobile push test notifications.
TestWelcomeBotCustomMessageApiRequest	testWelcomeBotCustomMessage(String welcomeMessageCustomTest)	Tests the welcome bot custom message.
UpdateBotStorageApiRequest	updateBotStorage(Map<String,String> data)	Adds or updates data stored for the bot user.
UpdateLinkifierApiRequest	updateLinkifier(long id, String pattern, String urlTemplate)	Updates a linkifier.
UpdateRealmDomainApiRequest	updateRealmDomain(String domain, boolean allowSubdomains)	Updates whether subdomains are allowed for an existing realm domain.
UpdateRealmNewUserDefaultSettingsApiRequest	updateRealmNewUserDefaultSettings()	Updates realm level default settings for new users.
UploadEmojiApiRequest	uploadEmoji(String name, File emojiFile)	Uploads a custom emoji image file.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ServerService

public ServerService(ZulipHttpClient client)

Constructs a ServerService.

Parameters:

client - The Zulip HTTP client

Method Details

addLinkifier

public AddLinkifierApiRequest addLinkifier(String pattern,
 String urlTemplate)

Adds a linkifier.

Parameters:

pattern - The regular expression that should trigger the linkifier

urlTemplate - The RFC 6570 compliant URL template used for the link

Returns:

The AddLinkifierApiRequest builder object

See Also:

• https://zulip.com/api/add-linkifier

updateLinkifier

public UpdateLinkifierApiRequest updateLinkifier(long id,
 String pattern,
 String urlTemplate)

Updates a linkifier.

Parameters:

id - The id of the linkifier to update

pattern - The regular expression that should trigger the linkifier

urlTemplate - The RFC 6570 compliant URL template used for the link

Returns:

The UpdateLinkifierApiRequest builder object

See Also:

• https://zulip.com/api/add-linkifier

deleteLinkifier

public DeleteLinkifierApiRequest deleteLinkifier(long id)

Deletes a linkifier.

Parameters:

id - The id of the linkifier to delete

Returns:

The DeleteLinkifierApiRequest builder object

See Also:

• https://zulip.com/api/remove-linkifier

getLinkifiers

public GetLinkifiersApiRequest getLinkifiers()

Gets all linkifiers.

Returns:

The GetLinkifiersApiRequest builder object

See Also:

• https://zulip.com/api/get-linkifiers

reorderLinkifiers

public ReorderLinkifiersApiRequest reorderLinkifiers(long... order)

Reorders linkifiers.

Parameters:

order - The array of linkifier ids representing their order

Returns:

The ReorderLinkifiersApiRequest builder object

See Also:

• https://zulip.com/api/reorder-linkifiers

uploadEmoji

public UploadEmojiApiRequest uploadEmoji(String name,
 File emojiFile)

Uploads a custom emoji image file.

Parameters:

name - The name of the emoji

emojiFile - The file containing the emoji image to be uploaded

Returns:

The UploadEmojiApiRequest builder object

See Also:

• https://zulip.com/help/add-custom-emoji

getEmoji

public GetAllEmojiApiRequest getEmoji()

Gets all custom emoji.

Returns:

The GetAllEmojiApiRequest builder object

See Also:

• https://zulip.com/api/get-custom-emoji

deactivateEmoji

public DeactivateEmojiApiRequest deactivateEmoji(String emojiName)

Deactivates a custom emoji.

Parameters:

emojiName - The name of the custom emoji to deactivate

Returns:

The DeactivateEmojiApiRequest builder object

See Also:

• https://zulip.com/api/deactivate-custom-emoji

getRealmDomains

public GetRealmDomainsApiRequest getRealmDomains()

Gets the allowed email domains configured in the organization.

Returns:

The GetRealmDomainsApiRequest builder object

See Also:

• https://zulip.com/api/get-realm-domains

addRealmDomain

public AddRealmDomainApiRequest addRealmDomain(String domain,
 boolean allowSubdomains)

Adds a domain to the set of allowed email domains in the organization. Requires organization owner permissions.

Parameters:

domain - The domain to add

allowSubdomains - Whether subdomains are allowed for this domain

Returns:

The AddRealmDomainApiRequest builder object

See Also:

• https://zulip.com/api/add-realm-domain

updateRealmDomain

public UpdateRealmDomainApiRequest updateRealmDomain(String domain,
 boolean allowSubdomains)

Updates whether subdomains are allowed for an existing realm domain. Requires organization owner permissions.

Parameters:

domain - The domain to update

allowSubdomains - Whether subdomains are allowed for this domain

Returns:

The UpdateRealmDomainApiRequest builder object

See Also:

• https://zulip.com/api/patch-realm-domain

deleteRealmDomain

public DeleteRealmDomainApiRequest deleteRealmDomain(String domain)

Removes a domain from the set of allowed email domains in the organization. Requires organization owner permissions.

Parameters:

domain - The domain to remove

Returns:

The DeleteRealmDomainApiRequest builder object

See Also:

• https://zulip.com/api/remove-realm-domain

getBotStorage

public GetBotStorageApiRequest getBotStorage()

Retrieves data stored for the bot user. Only available to bot user accounts.

Returns:

The GetBotStorageApiRequest builder object

See Also:

• https://zulip.com/api/get-bot-storage

updateBotStorage

public UpdateBotStorageApiRequest updateBotStorage(Map<String,String> data)

Adds or updates data stored for the bot user. Only available to bot user accounts.

Parameters:

data - Map of string key-value pairs to store

Returns:

The UpdateBotStorageApiRequest builder object

See Also:

• https://zulip.com/api/update-bot-storage

removeBotStorage

public RemoveBotStorageApiRequest removeBotStorage()

Deletes data stored for the bot user. Only available to bot user accounts.

Returns:

The RemoveBotStorageApiRequest builder object

See Also:

• https://zulip.com/api/remove-bot-storage

getServerSettings

public GetServerSettingsApiRequest getServerSettings()

Gets Zulip server organization settings.

Returns:

The GetServerSettingsApiRequest builder object

See Also:

• https://zulip.com/api/get-server-settings

getCustomProfileFields

public GetProfileFieldsApiRequest getCustomProfileFields()

Gets all custom profile fields.

Returns:

The GetProfileFieldsApiRequest builder object

See Also:

• https://zulip.com/api/get-custom-profile-fields

reorderCustomProfileFields

public ReorderProfileFieldsApiRequest reorderCustomProfileFields(int... order)

Reorders custom profile fields.

Parameters:

order - The array of custom profile field ids in the order that they should appear on the Zulip UI

Returns:

The ReorderProfileFieldsApiRequest builder object

See Also:

• https://zulip.com/api/reorder-custom-profile-fields

deleteCustomProfileField

public DeleteProfileFieldApiRequest deleteCustomProfileField(long profileFieldId)

Deletes a custom profile field.

Parameters:

profileFieldId - The id of the profile field to delete

Returns:

The DeleteProfileFieldApiRequest builder object.

createCustomProfileField

public CreateProfileFieldApiRequest createCustomProfileField()

Creates a custom profile field.

This API is only available to organization administrators.

Returns:

The CreateProfileFieldApiRequest builder object

See Also:

• https://zulip.com/api/create-custom-profile-field

getDevelopmentApiKey

public GetApiKeyApiRequest getDevelopmentApiKey(String username)

Gets a user development API key. Only available for development servers. This endpoint is not available on production servers.

Parameters:

username - The username to fetch the development API key for

Returns:

The GetApiKeyApiRequest builder object

getApiKey

public GetApiKeyApiRequest getApiKey(String username,
 String password)

Gets a user development API key. Only available for production servers. This endpoint is not available on development servers.

Parameters:

username - The username to fetch the development API key for

password - The password to fetch the development API key for

Returns:

The GetApiKeyApiRequest builder object

jwtFetchApiKey

public JwtFetchApiKeyApiRequest jwtFetchApiKey(String token)

Fetches a Zulip API key using a JWT token.

Parameters:

token - The JWT token

Returns:

The JwtFetchApiKeyApiRequest builder object

See Also:

• https://zulip.com/api/jwt-fetch-api-key

addCodePlayground

public AddCodePlaygroundApiRequest addCodePlayground(String name,
 String pygmentsLanguage,
 String urlTemplate)

Adds a code playground.

Parameters:

name - The name of the playground

pygmentsLanguage - The name of the Pygments language lexer for that programming language

urlTemplate - The URL template for the playground

Returns:

The AddCodePlaygroundApiRequest builder object

See Also:

• https://zulip.com/api/add-code-playground

removeCodePlayground

public RemoveCodePlaygroundApiRequest removeCodePlayground(long codePlaygroundId)

Removes a code playground.

Parameters:

codePlaygroundId - The id of the code playground to remove

Returns:

The RemoveCodePlaygroundApiRequest builder object

See Also:

• https://zulip.com/api/remove-code-playground

updateRealmNewUserDefaultSettings

public UpdateRealmNewUserDefaultSettingsApiRequest updateRealmNewUserDefaultSettings()

Updates realm level default settings for new users.

Returns:

The UpdateRealmNewUserDefaultSettingsApiRequest builder object

See Also:

• https://zulip.com/api/update-realm-user-settings-defaults

sendMobilePushTestNotification

public SendMobilePushTestNotification sendMobilePushTestNotification()

Sends mobile push test notifications.

Returns:

The SendMobilePushTestNotification builder object

See Also:

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

addApnsDeviceToken

public AddApnsDeviceTokenApiRequest addApnsDeviceToken(String token,
 String appId)

Adds an APNs device token to register for iOS push notifications

Parameters:

token - The token provided by the device

appId - The ID of the Zulip app that is making the request

Returns:

The AddApnsDeviceTokenApiRequest builder object

See Also:

• https://zulip.com/api/add-apns-token

removeApnsDeviceToken

public RemoveApnsDeviceTokenApiRequest removeApnsDeviceToken(String token)

Removes an APNs device token.

Parameters:

token - The token provided by the device

Returns:

The RemoveApnsDeviceTokenApiRequest builder object

See Also:

• https://zulip.com/api/remove-apns-token

addFcmRegistrationToken

public AddFcmRegistrationTokenApiRequest addFcmRegistrationToken(String token)

Adds an FCM registration token.

Parameters:

token - The token provided by the device

Returns:

The AddFcmRegistrationTokenApiRequest builder object

See Also:

• https://zulip.com/api/add-fcm-token

removeFcmRegistrationToken

public RemoveFcmRegistrationTokenApiRequest removeFcmRegistrationToken(String token)

Removes an FCM registration token.

Parameters:

token - The token provided by the device

Returns:

The RemoveFcmRegistrationTokenApiRequest builder object

See Also:

• https://zulip.com/api/remove-fcm-token

createBigBlueButtonVideoCall

public CreateBigBlueButtonVideoCallApiRequest createBigBlueButtonVideoCall(String meetingName)

Creates a BigBlueButton video call.

Parameters:

meetingName - Meeting name for the BigBlueButton video call

Returns:

The CreateBigBlueButtonVideoCallApiRequest builder object

See Also:

• https://zulip.com/api/create-big-blue-button-video-call

createConstructorGroupsVideoCall

public CreateConstructorGroupsVideoCallApiRequest createConstructorGroupsVideoCall()

Creates a Constructor Groups video call URL. Requires Constructor Groups to be configured on the Zulip server.

Returns:

The CreateConstructorGroupsVideoCallApiRequest builder object

See Also:

• https://zulip.com/api/create-constructor-groups-video-call

createNextcloudTalkVideoCall

public CreateNextcloudTalkVideoCallApiRequest createNextcloudTalkVideoCall(String roomName)

Creates a Nextcloud Talk video call URL. Requires Nextcloud Talk to be configured on the Zulip server.

Parameters:

roomName - Room name for the Nextcloud Talk conversation

Returns:

The CreateNextcloudTalkVideoCallApiRequest builder object

See Also:

• https://zulip.com/api/create-nextcloud-talk-video-call

createWebexVideoCall

public CreateWebexVideoCallApiRequest createWebexVideoCall()

Creates a Webex video call URL. Requires Webex integration to be configured on the Zulip server.

Returns:

The CreateWebexVideoCallApiRequest builder object

See Also:

• https://zulip.com/api/create-webex-video-call

getAllDataExports

public GetAllDataExportsApiRequest getAllDataExports()

Gets all data exports.

Returns:

The GetAllDataExportsApiRequest builder object

See Also:

• https://zulip.com/api/get-realm-exports

createDataExport

public CreateDataExportApiRequest createDataExport()

Creates a data export.

Returns:

The CreateDataExportApiRequest builder object

See Also:

• https://zulip.com/api/export-realm

getDataExportConsentState

public GetDataExportConsentStateApiRequest getDataExportConsentState()

Gets users that have consented to their private data being exported.

Returns:

The GetDataExportConsentStateApiRequest builder object

See Also:

• https://zulip.com/api/get-realm-export-consents

testWelcomeBotCustomMessage

public TestWelcomeBotCustomMessageApiRequest testWelcomeBotCustomMessage(String welcomeMessageCustomTest)

Tests the welcome bot custom message.

Parameters:

welcomeMessageCustomTest - The custom welcome message content

Returns:

The TestWelcomeBotCustomMessageApiRequest builder object

See Also:

• https://zulip.com/api/test-welcome-bot-custom-message

sendE2EMobilePushTestNotification

public SendE2EMobilePushTestNotification sendE2EMobilePushTestNotification()

Sends E2E mobile push test notifications.

Returns:

The SendE2EMobilePushTestNotification builder object

See Also:

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

registerE2EMobilePushDevice

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

Registers a E2E mobile push device.

Parameters:

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.

Returns:

The RegisterE2EMobilePushDevice builder object

See Also:

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

registerClientDevice

public RegisterClientDeviceApiRequest registerClientDevice()

Registers a logged-in device as an initial step before registering for E2EE push notifications.

Returns:

The RegisterClientDeviceApiRequest builder object

See Also:

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

removeClientDevice

public RemoveClientDeviceApiRequest removeClientDevice(long deviceId)

Removes a registered device when the user logs out.

Parameters:

deviceId - The ID of the device to remove

Returns:

The RemoveClientDeviceApiRequest builder object

See Also:

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