org.sagebionetworks.bridge.rest.model

Class NotificationInfo

java.lang.Object

org.sagebionetworks.bridge.rest.model.NotificationInfo

@Generated(value="io.swagger.codegen.languages.JavaClientCodegen",
           date="2024-01-08T21:27:32.920Z")
public class NotificationInfo
extends Object

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

Constructor Summary

Constructors

Constructor and Description
NotificationInfo()

Method Summary

Modifier and Type	Method and Description
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.
NotificationMessage	getMessage() The message to use for a notification and reminder, if these have been specified.
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() NotificationInfo
int	hashCode()
Boolean	isAllowSnooze() Allow the participant to “snooze” a notification or reminder (dismiss it with some amount of time before it occurs again).
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

NotificationInfo

public NotificationInfo()

Method Detail

getNotifyAt

public NotificationType getNotifyAt()

Get notifyAt

Returns:

notifyAt

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

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

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

getMessage

public NotificationMessage getMessage()

The message to use for a notification and reminder, if these have been specified. This message will be the message selected for the caller based on their language preferences.

Returns:

message

getType

public String getType()

NotificationInfo

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