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

Class UpdateNotificationSettingsApiRequest

java.lang.Object

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

com.github.jamesnetherton.zulip.client.api.user.request.UpdateNotificationSettingsApiRequest

All Implemented Interfaces:

ExecutableApiRequest<Map<String,Object>>

@Deprecated
public class UpdateNotificationSettingsApiRequest
extends ZulipApiRequest
implements ExecutableApiRequest<Map<String,Object>>

Deprecated.

Zulip API request builder for updating user notification settings.

See Also:

• https://zulip.com/api/update-notification-settings

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DESKTOP_ICON_COUNT_DISPLAY	Deprecated.
static final String	ENABLE_DESKTOP_NOTIFICATIONS	Deprecated.
static final String	ENABLE_DIGEST_EMAILS	Deprecated.
static final String	ENABLE_LOGIN_EMAILS	Deprecated.
static final String	ENABLE_OFFLINE_EMAIL_NOTIFICATIONS	Deprecated.
static final String	ENABLE_OFFLINE_PUSH_NOTIFICATIONS	Deprecated.
static final String	ENABLE_ONLINE_PUSH_NOTIFICATIONS	Deprecated.
static final String	ENABLE_SOUNDS	Deprecated.
static final String	ENABLE_STREAM_AUDIBLE_NOTIFICATIONS	Deprecated.
static final String	ENABLE_STREAM_DESKTOP_NOTIFICATIONS	Deprecated.
static final String	ENABLE_STREAM_EMAIL_NOTIFICATIONS	Deprecated.
static final String	ENABLE_STREAM_PUSH_NOTIFICATIONS	Deprecated.
static final String	MESSAGE_CONTENT_IN_EMAIL_NOTIFICATIONS	Deprecated.
static final String	NOTIFICATION_SOUND	Deprecated.
static final String	PM_CONTENT_IN_DESKTOP_NOTIFICATIONS	Deprecated.
static final String	PRESENCE_ENABLED	Deprecated.
static final String	REALM_NAME_IN_NOTIFICATIONS	Deprecated.
static final String	WILDCARD_MENTIONS_NOTIFY	Deprecated.

Constructor Summary

Constructors

Constructor	Description
UpdateNotificationSettingsApiRequest(ZulipHttpClient client)	Deprecated. Constructs a UpdateNotificationSettingsApiRequest.

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	execute()	Deprecated. Executes the Zulip API request for updating user notification settings.
UpdateNotificationSettingsApiRequest	withDesktopIconCountDisplay(DesktopIconCountDisplay desktopIconCountDisplay)	Deprecated. Sets whether to display an unread count summary on the Zulip UI.
UpdateNotificationSettingsApiRequest	withEnableDesktopNotifications(boolean enable)	Deprecated. Sets whether desktop notifications are enabled.
UpdateNotificationSettingsApiRequest	withEnableDigestEmails(boolean enable)	Deprecated. Sets whether digest emails are enabled.
UpdateNotificationSettingsApiRequest	withEnableLoginEmails(boolean enable)	Deprecated. Sets whether login emails are enabled.
UpdateNotificationSettingsApiRequest	withEnableOfflineEmailNotifications(boolean enable)	Deprecated. Sets whether offline email notifications are enabled.
UpdateNotificationSettingsApiRequest	withEnableOfflinePushNotifications(boolean enable)	Deprecated. Sets whether offline push notifications are enabled.
UpdateNotificationSettingsApiRequest	withEnableOnlinePushNotifications(boolean enable)	Deprecated. Sets whether online push notifications are enabled.
UpdateNotificationSettingsApiRequest	withEnableSounds(boolean enable)	Deprecated. Sets whether sounds are enabled.
UpdateNotificationSettingsApiRequest	withEnableStreamAudibleNotifications(boolean enable)	Deprecated. Sets whether stream audible notifications should be enabled.
UpdateNotificationSettingsApiRequest	withEnableStreamDesktopNotifications(boolean enable)	Deprecated. Sets whether stream desktop notifications should be enabled.
UpdateNotificationSettingsApiRequest	withEnableStreamEmailNotifications(boolean enable)	Deprecated. Sets whether stream email notifications should be enabled.
UpdateNotificationSettingsApiRequest	withEnableStreamPushNotifications(boolean enable)	Deprecated. Sets whether stream push notifications should be enabled.
UpdateNotificationSettingsApiRequest	withMessageContentInEmailNotifications(boolean messageContentInEmailNotifications)	Deprecated. Sets whether message content is present in email notifications.
UpdateNotificationSettingsApiRequest	withNotificationSound(String notificationSound)	Deprecated. Sets the notification sound
UpdateNotificationSettingsApiRequest	withPmContentInDesktopNotifications(boolean pmContentInDesktopNotifications)	Deprecated. Sets whether private message content shows in desktop notifications.
UpdateNotificationSettingsApiRequest	withPresenceEnabled(boolean enable)	Deprecated. Sets whether to display the presence status to other users when online.
UpdateNotificationSettingsApiRequest	withRealmNameInNotifications(boolean realmNameInNotifications)	Deprecated. Sets whether to include organization name in subject of missed message emails.
UpdateNotificationSettingsApiRequest	withWildcardMentionsNotify(boolean wildcardMentionsNotify)	Deprecated. Sets whether to be notified when wildcard mentions are triggered.

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

ENABLE_STREAM_DESKTOP_NOTIFICATIONS

public static final String ENABLE_STREAM_DESKTOP_NOTIFICATIONS

Deprecated.

See Also:

• Constant Field Values

ENABLE_STREAM_EMAIL_NOTIFICATIONS

public static final String ENABLE_STREAM_EMAIL_NOTIFICATIONS

Deprecated.

See Also:

• Constant Field Values

ENABLE_STREAM_PUSH_NOTIFICATIONS

public static final String ENABLE_STREAM_PUSH_NOTIFICATIONS

Deprecated.

See Also:

• Constant Field Values

ENABLE_STREAM_AUDIBLE_NOTIFICATIONS

public static final String ENABLE_STREAM_AUDIBLE_NOTIFICATIONS

Deprecated.

See Also:

• Constant Field Values

NOTIFICATION_SOUND

public static final String NOTIFICATION_SOUND

Deprecated.

See Also:

• Constant Field Values

ENABLE_DESKTOP_NOTIFICATIONS

public static final String ENABLE_DESKTOP_NOTIFICATIONS

Deprecated.

See Also:

• Constant Field Values

ENABLE_SOUNDS

public static final String ENABLE_SOUNDS

Deprecated.

See Also:

• Constant Field Values

ENABLE_OFFLINE_EMAIL_NOTIFICATIONS

public static final String ENABLE_OFFLINE_EMAIL_NOTIFICATIONS

Deprecated.

See Also:

• Constant Field Values

ENABLE_OFFLINE_PUSH_NOTIFICATIONS

public static final String ENABLE_OFFLINE_PUSH_NOTIFICATIONS

Deprecated.

See Also:

• Constant Field Values

ENABLE_ONLINE_PUSH_NOTIFICATIONS

public static final String ENABLE_ONLINE_PUSH_NOTIFICATIONS

Deprecated.

See Also:

• Constant Field Values

ENABLE_DIGEST_EMAILS

public static final String ENABLE_DIGEST_EMAILS

Deprecated.

See Also:

• Constant Field Values

ENABLE_LOGIN_EMAILS

public static final String ENABLE_LOGIN_EMAILS

Deprecated.

See Also:

• Constant Field Values

MESSAGE_CONTENT_IN_EMAIL_NOTIFICATIONS

public static final String MESSAGE_CONTENT_IN_EMAIL_NOTIFICATIONS

Deprecated.

See Also:

• Constant Field Values

PM_CONTENT_IN_DESKTOP_NOTIFICATIONS

public static final String PM_CONTENT_IN_DESKTOP_NOTIFICATIONS

Deprecated.

See Also:

• Constant Field Values

WILDCARD_MENTIONS_NOTIFY

public static final String WILDCARD_MENTIONS_NOTIFY

Deprecated.

See Also:

• Constant Field Values

DESKTOP_ICON_COUNT_DISPLAY

public static final String DESKTOP_ICON_COUNT_DISPLAY

Deprecated.

See Also:

• Constant Field Values

REALM_NAME_IN_NOTIFICATIONS

public static final String REALM_NAME_IN_NOTIFICATIONS

Deprecated.

See Also:

• Constant Field Values

PRESENCE_ENABLED

public static final String PRESENCE_ENABLED

Deprecated.

See Also:

• Constant Field Values

Constructor Details

UpdateNotificationSettingsApiRequest

public UpdateNotificationSettingsApiRequest(ZulipHttpClient client)

Deprecated.

Constructs a UpdateNotificationSettingsApiRequest.

Parameters:

client - The Zulip HTTP client

Method Details

withEnableStreamDesktopNotifications

public UpdateNotificationSettingsApiRequest withEnableStreamDesktopNotifications(boolean enable)

Deprecated.

Sets whether stream desktop notifications should be enabled.

Parameters:

enable - true to enable. false to disable

Returns:

This UpdateNotificationSettingsApiRequest instance

withEnableStreamEmailNotifications

public UpdateNotificationSettingsApiRequest withEnableStreamEmailNotifications(boolean enable)

Deprecated.

Sets whether stream email notifications should be enabled.

Parameters:

enable - true to enable. false to disable

Returns:

This UpdateNotificationSettingsApiRequest instance

withEnableStreamPushNotifications

public UpdateNotificationSettingsApiRequest withEnableStreamPushNotifications(boolean enable)

Deprecated.

Sets whether stream push notifications should be enabled.

Parameters:

enable - true to enable. false to disable

Returns:

This UpdateNotificationSettingsApiRequest instance

withEnableStreamAudibleNotifications

public UpdateNotificationSettingsApiRequest withEnableStreamAudibleNotifications(boolean enable)

Deprecated.

Sets whether stream audible notifications should be enabled.

Parameters:

enable - true to enable. false to disable

Returns:

This UpdateNotificationSettingsApiRequest instance

withNotificationSound

public UpdateNotificationSettingsApiRequest withNotificationSound(String notificationSound)

Deprecated.

Sets the notification sound

Parameters:

notificationSound - The name of the notification sound to play

Returns:

This UpdateNotificationSettingsApiRequest instance

withEnableDesktopNotifications

public UpdateNotificationSettingsApiRequest withEnableDesktopNotifications(boolean enable)

Deprecated.

Sets whether desktop notifications are enabled.

Parameters:

enable - true to enable. false to disable

Returns:

This UpdateNotificationSettingsApiRequest instance

withEnableSounds

public UpdateNotificationSettingsApiRequest withEnableSounds(boolean enable)

Deprecated.

Sets whether sounds are enabled.

Parameters:

enable - true to enable. false to disable

Returns:

This UpdateNotificationSettingsApiRequest instance

withEnableOfflineEmailNotifications

public UpdateNotificationSettingsApiRequest withEnableOfflineEmailNotifications(boolean enable)

Deprecated.

Sets whether offline email notifications are enabled.

Parameters:

enable - true to enable. false to disable

Returns:

This UpdateNotificationSettingsApiRequest instance

withEnableOfflinePushNotifications

public UpdateNotificationSettingsApiRequest withEnableOfflinePushNotifications(boolean enable)

Deprecated.

Sets whether offline push notifications are enabled.

Parameters:

enable - true to enable. false to disable

Returns:

This UpdateNotificationSettingsApiRequest instance

withEnableOnlinePushNotifications

public UpdateNotificationSettingsApiRequest withEnableOnlinePushNotifications(boolean enable)

Deprecated.

Sets whether online push notifications are enabled.

Parameters:

enable - true to enable. false to disable

Returns:

This UpdateNotificationSettingsApiRequest instance

withEnableDigestEmails

public UpdateNotificationSettingsApiRequest withEnableDigestEmails(boolean enable)

Deprecated.

Sets whether digest emails are enabled.

Parameters:

enable - true to enable. false to disable

Returns:

This UpdateNotificationSettingsApiRequest instance

withEnableLoginEmails

public UpdateNotificationSettingsApiRequest withEnableLoginEmails(boolean enable)

Deprecated.

Sets whether login emails are enabled.

Parameters:

enable - true to enable. false to disable

Returns:

This UpdateNotificationSettingsApiRequest instance

withMessageContentInEmailNotifications

public UpdateNotificationSettingsApiRequest withMessageContentInEmailNotifications(boolean messageContentInEmailNotifications)

Deprecated.

Sets whether message content is present in email notifications.

Parameters:

messageContentInEmailNotifications - true to show message content in email notifications. false to not show message content in email notifications

Returns:

This UpdateNotificationSettingsApiRequest instance

withPmContentInDesktopNotifications

public UpdateNotificationSettingsApiRequest withPmContentInDesktopNotifications(boolean pmContentInDesktopNotifications)

Deprecated.

Sets whether private message content shows in desktop notifications.

Parameters:

pmContentInDesktopNotifications - true to have private message content show in desktop notifications. false to not have private message content show in desktop notifications

Returns:

This UpdateNotificationSettingsApiRequest instance

withWildcardMentionsNotify

public UpdateNotificationSettingsApiRequest withWildcardMentionsNotify(boolean wildcardMentionsNotify)

Deprecated.

Sets whether to be notified when wildcard mentions are triggered.

Parameters:

wildcardMentionsNotify - true to be notified when wildcard mentions are triggered. false to not be notified when wildcard mentions are triggered

Returns:

This UpdateNotificationSettingsApiRequest instance

withDesktopIconCountDisplay

public UpdateNotificationSettingsApiRequest withDesktopIconCountDisplay(DesktopIconCountDisplay desktopIconCountDisplay)

Deprecated.

Sets whether to display an unread count summary on the Zulip UI.

Parameters:

desktopIconCountDisplay - The DesktopIconCountDisplay setting

Returns:

This UpdateNotificationSettingsApiRequest instance

withRealmNameInNotifications

public UpdateNotificationSettingsApiRequest withRealmNameInNotifications(boolean realmNameInNotifications)

Deprecated.

Sets whether to include organization name in subject of missed message emails.

Parameters:

realmNameInNotifications - true to include the organization name in the subject of missed message emails. false to not include the organization name in the subject of missed message emails

Returns:

This UpdateNotificationSettingsApiRequest instance

withPresenceEnabled

public UpdateNotificationSettingsApiRequest withPresenceEnabled(boolean enable)

Deprecated.

Sets whether to display the presence status to other users when online.

Parameters:

enable - true to display the presence status to other users when online. false to not display the presence status to other users when online

Returns:

This UpdateNotificationSettingsApiRequest instance

execute

public Map<String,Object> execute()
                           throws ZulipClientException

Deprecated.

Executes the Zulip API request for updating user notification settings.

Specified by:

execute in interface ExecutableApiRequest<Map<String,Object>>

Returns:

Map of updated user notification settings

Throws:

ZulipClientException - if the request was not successful