org.sagebionetworks.bridge.rest.model

Class Notification

java.lang.Object

org.sagebionetworks.bridge.rest.model.Notification

@Generated(value="io.swagger.codegen.languages.JavaClientCodegen",
           date="2022-11-05T00:31:27.098Z")
public class Notification
extends Object

A notification to show to a participant as part of the execution of a scheduled session.

Constructor Summary

Constructors

Constructor and Description
Notification()

Method Summary

Modifier and Type	Method and Description
Notification	addMessagesItem(NotificationMessage messagesItem)
Notification	allowSnooze(Boolean allowSnooze)
boolean	equals(Object o)
String	getInterval() If a window lasts for more than twenty-four hours, a notification can be repeated on a daily repeat value.
List<NotificationMessage>	getMessages() The message to use for a notification.
NotificationType	getNotifyAt() Get notifyAt
String	getOffset() The time after a window starts or before it ends (based on the `notifyAt` property) when a notification should be shown to the user.
String	getType() Notification
int	hashCode()
Notification	interval(String interval)
Boolean	isAllowSnooze() Allow the participant to “snooze” a notification or reminder (dismiss it with some amount of time before it occurs again).
Notification	messages(List<NotificationMessage> messages)
Notification	notifyAt(NotificationType notifyAt)
Notification	offset(String offset)
void	setAllowSnooze(Boolean allowSnooze)
void	setInterval(String interval)
void	setMessages(List<NotificationMessage> messages)
void	setNotifyAt(NotificationType notifyAt)
void	setOffset(String offset)
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Notification

public Notification()

Method Detail

notifyAt

public Notification notifyAt(NotificationType notifyAt)

getNotifyAt

public NotificationType getNotifyAt()

Get notifyAt

Returns:

notifyAt

setNotifyAt

public void setNotifyAt(NotificationType notifyAt)

offset

public Notification offset(String offset)

getOffset

public String getOffset()

The time after a window starts or before it ends (based on the `notifyAt` property) when a notification should be shown to the user.

Returns:

offset

setOffset

public void setOffset(String offset)

interval

public Notification interval(String interval)

getInterval

public String getInterval()

If a window lasts for more than twenty-four hours, a notification can be repeated on a daily repeat value. Only day values are allowed.

Returns:

interval

setInterval

public void setInterval(String interval)

allowSnooze

public Notification allowSnooze(Boolean allowSnooze)

isAllowSnooze

public Boolean isAllowSnooze()

Allow the participant to “snooze” a notification or reminder (dismiss it with some amount of time before it occurs again). Cannot be true if `notifyAt` is null.

Returns:

allowSnooze

setAllowSnooze

public void setAllowSnooze(Boolean allowSnooze)

messages

public Notification messages(List<NotificationMessage> messages)

addMessagesItem

public Notification addMessagesItem(NotificationMessage messagesItem)

getMessages

public List<NotificationMessage> getMessages()

The message to use for a notification. Only one message can be included for a given language. The system will first try and select the participant’s preferred languages (from most to least preferred), then it will select an English (“en”) language default message. An English language default message *must* be provided because there is no other reasonable fallback value.

Returns:

messages

setMessages

public void setMessages(List<NotificationMessage> messages)

getType

public String getType()

Notification

Returns:

type

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object