Package io.getstream.chat.java.models

Class Reminder

java.lang.Object

io.getstream.chat.java.models.Reminder

public class Reminder
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Reminder.ReminderCreateRequestData
static class	Reminder.ReminderCreateResponse
static class	Reminder.ReminderDeleteRequest
static class	Reminder.ReminderDeleteResponse
static class	Reminder.ReminderQueryRequestData
static class	Reminder.ReminderQueryResponse
static class	Reminder.ReminderUpdateRequestData
static class	Reminder.ReminderUpdateResponse

Constructor Summary

Constructors

Constructor	Description
Reminder()

Method Summary

Modifier and Type	Method	Description
static @NotNull Reminder.ReminderCreateRequestData.ReminderCreateRequest	createReminder(@NotNull java.lang.String messageId)	Creates a reminder for a message.
static @NotNull Reminder.ReminderDeleteRequest	deleteReminder(@NotNull java.lang.String messageId, @NotNull java.lang.String userId)	Deletes a reminder for a message.
java.util.Map<java.lang.String,java.lang.Object>	getAdditionalFields()
static @NotNull Reminder.ReminderQueryRequestData.ReminderQueryRequest	queryReminders()	Queries reminders based on filter conditions.
void	setAdditionalField(java.lang.String name, java.lang.Object value)
static @NotNull Reminder.ReminderUpdateRequestData.ReminderUpdateRequest	updateReminder(@NotNull java.lang.String messageId)	Updates a reminder for a message.

Methods inherited from class java.lang.Object

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

Constructor Detail

Reminder

public Reminder()

Method Detail

getAdditionalFields

public java.util.Map<java.lang.String,java.lang.Object> getAdditionalFields()

setAdditionalField

public void setAdditionalField(java.lang.String name,
                               java.lang.Object value)

createReminder

@NotNull
public static @NotNull Reminder.ReminderCreateRequestData.ReminderCreateRequest createReminder(@NotNull
                                                                                               @NotNull java.lang.String messageId)

Creates a reminder for a message.

Parameters:

messageId - The ID of the message to create a reminder for

Returns:

A request builder for creating a reminder

updateReminder

@NotNull
public static @NotNull Reminder.ReminderUpdateRequestData.ReminderUpdateRequest updateReminder(@NotNull
                                                                                               @NotNull java.lang.String messageId)

Updates a reminder for a message.

Parameters:

messageId - The ID of the message with the reminder

Returns:

A request builder for updating a reminder

deleteReminder

@NotNull
public static @NotNull Reminder.ReminderDeleteRequest deleteReminder(@NotNull
                                                                     @NotNull java.lang.String messageId,
                                                                     @NotNull
                                                                     @NotNull java.lang.String userId)

Deletes a reminder for a message.

Parameters:

messageId - The ID of the message with the reminder

userId - The ID of the user who owns the reminder

Returns:

A request for deleting a reminder

queryReminders

@NotNull
public static @NotNull Reminder.ReminderQueryRequestData.ReminderQueryRequest queryReminders()

Queries reminders based on filter conditions.

Returns:

A request builder for querying reminders