---
schema_version: "1"
id: 215c16598b5f333a66e60915d21474de18f0a10d64d8177f4871896536b39309
title: Work with Reminders
collection: developer
version: current
locale: en-us
portal_url: https://docs.salesforce.com/developer/current/en-us/salesforce-slack-sdk/apex-slack-sdk/guides/apex_ref/apex_ref_reminders.md
canonical_url: https://developer.salesforce.com/docs/platform/salesforce-slack-sdk/guide/apex_ref_reminders.html
source_site: developer.salesforce.com
content_type: documentation
content_hash: c96bbe50f8ca302ee5e7309ffce8f3a57bf0e41889cc50d4399427763a12b828
products:
  - Apex SDK for Slack (Beta)
---
# Work with Reminders

The following are Apex classes for the Slack `reminders` [API methods](https://api.slack.com/methods?filter=reminders).

## Reminder Class

Represents a reminder.

### Reminder Methods.

The following are methods for `Reminder`.

#### getChannel()()

**Signature**

```java
public String getChannel()
```

**Return Value**

Type: String

#### getCompleteTs()

**Signature**

```java
public Integer getCompleteTs()
```

**Return Value**

Type: Integer

#### getCreator()

**Signature**

```java
public String getCreator()
```

**Return Value**

Type: String

#### getId()

**Signature**

```java
public String getId()
```

**Return Value**

Type: String

#### getItem()

**Signature**

```java
public Object getItem()
```

**Return Value**

Type: Object

#### getRecurrence()

**Signature**

```java
public Slack.Reminder.Recurrence getRecurrence()
```

**Return Value**

Type: Slack.Reminder.Recurrence

#### getText()

**Signature**

```java
public String getText()
```

**Return Value**

Type: String

#### getTime()

**Signature**

```java
public Integer getTime()
```

**Return Value**

Type: Integer

#### getUser()

**Signature**

```java
public String getUser()
```

**Return Value**

Type: String

#### isRecurring()

**Signature**

```java
public Boolean isRecurring()
```

**Return Value**

Type: Boolean

#### setChannel(channel)

**Signature**

```java
public void setChannel(String channel)
```

**Parameters**

_channel_

Type: String

**Return Value**

Type: void

#### setCompleteTs(completeTs)

**Signature**

```java
public void setCompleteTs(Integer completeTs)
```

**Parameters**

_completeTs_

Type: Integer

**Return Value**

Type: void

#### setCreator(creator)

**Signature**

```java
public void setCreator(String creator)
```

**Parameters**

_creator_

Type: String

**Return Value**

Type: void

#### setId(id)

**Signature**

```java
public void setId(String id)
```

**Parameters**

_id_

Type: String

**Return Value**

Type: void

#### setItem(item)

**Signature**

```java
public void setItem(Object item)
```

**Parameters**

_item_

Type: Object

**Return Value**

Type: void

#### setRecurrence(recurrence)

**Signature**

```java
public void setRecurrence(Slack.Reminder.Recurrence recurrence)
```

**Parameters**

_recurrence_

Type: Slack.Reminder.Recurrence

**Return Value**

Type: void

#### setRecurring(recurring)

**Signature**

```java
public void setRecurring(Boolean recurring)
```

**Parameters**

_recurring_

Type: Boolean

**Return Value**

Type: void

#### setText(text)

**Signature**

```java
public void setText(String text)
```

**Parameters**

_text_

Type: String

**Return Value**

Type: void

#### setTime(timeValue)

**Signature**

```java
public void setTime(Integer timeValue)
```

**Parameters**

_timeValue_

Type: Integer

**Return Value**

Type: void

#### setUser(user)

**Signature**

```java
public void setUser(String user)
```

**Parameters**

_user_

Type: String

**Return Value**

Type: void

## Reminder.Recurrence Class

### Reminder.Recurrence Methods

The following are methods for `Reminder.Recurrence`.

#### getFrequency()

**Signature**

```java
public String getFrequency()
```

**Return Value**

Type: String

#### getWeekdays()

**Signature**

```java
public List<String> getWeekdays()
```

**Return Value**

Type: List\<String\>

#### setFrequency(frequency)

**Signature**

```java
public void setFrequency(String frequency)
```

**Parameters**

_frequency_

Type: String

**Return Value**

Type: void

#### setWeekdays(weekdays)

**Signature**

```java
public void setWeekdays(List<String> weekdays)
```

**Parameters**

_weekdays_

Type: List\<String\>

**Return Value**

Type: void

## RemindersAddRequest Class

Sends a request to create a reminder.

**Usage**

See Slack’s [reminders.add method](https://api.slack.com/methods/reminders.add).

### RemindersAddRequest Methods

The following are methods for `RemindersAddRequest`.

#### builder()

Builds a request object that's used when executing the API call.

**Signature**

```java
 static Slack.RemindersAddRequest.Builder builder()
```

**Return Value**

Type: Slack.RemindersAddRequest.Builder

## RemindersAddRequest.Builder Class

Contains methods to build an instance of the `Slack.RemindersAddRequest` class.

A Builder object is obtained by invoking one of the `RemindersAddRequest.builder` methods defined by the `RemindersAddRequest` class.

### RemindersAddRequest.Builder Methods

The following are methods for `RemindersAddRequest.Builder`. These methods are optional unless specified otherwise.

#### build()

Required. Returns an instance of `Slack.RemindersAddRequest`.

**Signature**

```java
 Slack.RemindersAddRequest build()
```

**Return Value**

Type: Slack.RemindersAddRequest

#### timeValue(timeValue)

Required. The Unix timestamp for when this reminder should happen, up to five years from now. If within 24 hours, the number of seconds until the reminder. Or a natural language description (Ex. "in 15 minutes," or "every Thursday").

**Signature**

```java
 Slack.RemindersAddRequest.Builder timeValue(String timeValue)
```

**Parameters**

_timeValue_

Type: String

**Return Value**

Type: Slack.RemindersAddRequest.Builder

#### text(text)

Required. The description of the reminder.

**Signature**

```java
 Slack.RemindersAddRequest.Builder text(String text)
```

**Parameters**

_text_

Type: String

**Return Value**

Type: Slack.RemindersAddRequest.Builder

#### user(user)

**Signature**

```java
 Slack.RemindersAddRequest.Builder user(String user)
```

**Parameters**

_user_

Type: String

**Return Value**

Type: Slack.RemindersAddRequest.Builder

## RemindersAddResponse Class

Creates a reminder.

**Usage**

See Slack’s [reminders.add method](https://api.slack.com/methods/reminders.add).

### RemindersAddResponse Methods

This class contains [standard response methods](https://developer.salesforce.com/docs/platform/salesforce-slack-sdk/guide/apex_ref_response.md).

The following are methods for `RemindersAddResponse`.

#### getReminder()

**Signature**

```java
public Slack.Reminder getReminder()
```

**Return Value**

Type: Slack.Reminder

#### setReminder(reminder)

**Signature**

```java
public void setReminder(Slack.Reminder reminder)
```

**Parameters**

_reminder_

Type: Slack.Reminder

**Return Value**

Type: void

## RemindersCompleteRequest Class

Sends a request to mark a reminder as complete.

**Usage**

See Slack’s [reminders.complete method](https://api.slack.com/methods/reminders.complete).

### RemindersCompleteRequest Methods

The following are methods for `RemindersCompleteRequest`.

#### builder()

Builds a request object that's used when executing the API call.

**Signature**

public static Slack.RemindersCompleteRequest.Builder builder()

**Return Value**

Type: Slack.RemindersCompleteRequest.Builder

## RemindersCompleteRequest.Builder Class

Contains methods to build an instance of the `Slack.RemindersCompleteRequest` class.

A Builder object is obtained by invoking one of the `RemindersCompleteRequest.builder` methods defined by the `RemindersCompleteRequest` class.

### RemindersCompleteRequest.Builder Methods

The following are methods for `RemindersCompleteRequest.Builder`.

#### build()

Required. Returns an instance of `Slack.RemindersCompleteRequest`.

**Signature**

```java
 Slack.RemindersCompleteRequest build()
```

**Return Value**

Type: Slack.RemindersCompleteRequest

#### reminder(reminder)

Required. The ID of the reminder to be marked as complete.

**Signature**

```java
 Slack.RemindersCompleteRequest.Builder reminder(String reminder)
```

**Parameters**

_reminder_

Type: String

**Return Value**

Type: Slack.RemindersCompleteRequest.Builder

#### teamId(teamId)

**Signature**

```java
public Slack.RemindersCompleteRequest.Builder teamId(String teamId)
```

**Parameters**

_teamId_

Type: String

**Return Value**

Type: Slack.RemindersCompleteRequest.Builder

## RemindersCompleteResponse Class

Marks a reminder as complete.

**Usage**

See Slack’s [reminders.complete method](https://api.slack.com/methods/reminders.complete).

### RemindersCompleteResponse Methods

This class contains [standard response methods](https://developer.salesforce.com/docs/platform/salesforce-slack-sdk/guide/apex_ref_response.md).

## RemindersDeleteRequest Class

Sends a request to delete a reminder.

**Usage**

See Slack’s [reminders.delete method](https://api.slack.com/methods/reminders.delete).

### RemindersDeleteRequest Methods

The following are methods for `RemindersDeleteRequest`.

#### builder()

Builds a request object that's used when executing the API call.

**Signature**

```java
 static Slack.RemindersDeleteRequest.Builder builder()
```

**Return Value**

Type: Slack.RemindersDeleteRequest.Builder

#### teamId(teamId)

**Signature**

```java
public Slack.RemindersCompleteRequest.Builder teamId(String teamId)
```

**Parameters**

_teamId_

Type: String

**Return Value**

Type: Slack.RemindersCompleteRequest.Builder

## RemindersDeleteRequest.Builder Class

Contains methods to build an instance of the `Slack.RemindersDeleteRequest` class.

A Builder object is obtained by invoking one of the `RemindersDeleteRequest.builder` methods defined by the `RemindersDeleteRequest` class.

### RemindersDeleteRequest.Builder Methods

The following are methods for `RemindersDeleteRequest.Builder`.

#### build()

Required. Returns an instance of `Slack.RemindersDeleteRequest`.

**Signature**

```java
 Slack.RemindersDeleteRequest build()
```

**Return Value**

Type: Slack.RemindersDeleteRequest

#### reminder(reminder)

Required. The ID of the reminder.

**Signature**

```java
 Slack.RemindersDeleteRequest.Builder reminder(String reminder)
```

**Parameters**

_reminder_

Type: String

**Return Value**

Type: Slack.RemindersDeleteRequest.Builder

## RemindersDeleteResponse Class

Deletes a reminder.

**Usage**

See Slack’s [reminders.delete method](https://api.slack.com/methods/reminders.delete).

### RemindersDeleteResponse Methods

This class contains [standard response methods](https://developer.salesforce.com/docs/platform/salesforce-slack-sdk/guide/apex_ref_response.md).

## RemindersInfoRequest Class

Sends a request to get information about a reminder.

**Usage**

See Slack’s [reminders.info method](https://api.slack.com/methods/reminders.info).

### RemindersInfoRequest Methods

The following are methods for `RemindersInfoRequest`.

#### builder()

Builds a request object that's used when executing the API call.

**Signature**

```java
 static Slack.RemindersInfoRequest.Builder builder()
```

**Return Value**

Type: Slack.RemindersInfoRequest.Builder

#### teamId(teamId)

**Signature**

```java
public Slack.RemindersCompleteRequest.Builder teamId(String teamId)
```

**Parameters**

_teamId_

Type: String

**Return Value**

Type: Slack.RemindersCompleteRequest.Builder

## RemindersInfoRequest.Builder Class

Contains methods to build an instance of the `Slack.RemindersInfoRequest` class.

A Builder object is obtained by invoking one of the `RemindersInfoRequest.builder` methods defined by the `RemindersInfoRequest` class.

### RemindersInfoRequest.Builder Methods

The following are methods for `RemindersInfoRequest.Builder`.

#### build()

Required. Returns an instance of `Slack.RemindersInfoRequest`.

**Signature**

public Slack.RemindersInfoRequest build()

**Return Value**

Type: Slack.RemindersInfoRequest

#### reminder(reminder)

Required. The ID of the reminder.

**Signature**

```java
 Slack.RemindersInfoRequest.Builder reminder(String reminder)
```

**Parameters**

_reminder_

Type: String

**Return Value**

Type: Slack.RemindersInfoRequest.Builder

## RemindersInfoResponse Class

Gets information about a reminder.

**Usage**

See Slack’s [reminders.info method](https://api.slack.com/methods/reminders.info).

### RemindersInfoResponse Methods

This class contains [standard response methods](https://developer.salesforce.com/docs/platform/salesforce-slack-sdk/guide/apex_ref_response.md).

The following are methods for `RemindersInfoResponse`.

#### getReminder()

**Signature**

```java
public Slack.Reminder getReminder()
```

**Return Value**

Type: Slack.Reminder

#### setReminder(reminder)

**Signature**

```java
public void setReminder(Slack.Reminder reminder)
```

**Parameters**

_reminder_

Type: Slack.Reminder

**Return Value**

Type: void

## RemindersListRequest Class

Sends a request to list all reminders created by or for a given user.

**Usage**

See Slack’s [reminders.list method](https://api.slack.com/methods/reminders.list).

### RemindersListRequest Methods

The following are methods for `RemindersListRequest`.

#### builder()

**Signature**

```java
 static Slack.RemindersListRequest.Builder builder()
```

**Return Value**

Type: Slack.RemindersListRequest.Builder

#### teamId(teamId)

**Signature**

```java
public Slack.RemindersCompleteRequest.Builder teamId(String teamId)
```

**Parameters**

_teamId_

Type: String

**Return Value**

Type: Slack.RemindersCompleteRequest.Builder

## RemindersListRequest.Builder Class

Contains methods to build an instance of the `Slack.RemindersListRequest` class.

A Builder object is obtained by invoking one of the `RemindersListRequest.builder` methods defined by the `RemindersListRequest` class.

### RemindersListRequest.Builder Methods

The following are methods for `RemindersListRequest.Builder`.

#### build()

Required. Returns an instance of `Slack.RemindersListRequest`.

**Signature**

```java
 Slack.RemindersListRequest build()
```

**Return Value**

Type: Slack.RemindersListRequest

## RemindersListResponse Class

Lists all reminders created by or for a given user.

**Usage**

See Slack’s [reminders.list method](https://api.slack.com/methods/reminders.list).

### RemindersListResponse Methods

This class contains [standard response methods](https://developer.salesforce.com/docs/platform/salesforce-slack-sdk/guide/apex_ref_response.md).

The following are methods for `RemindersListResponse`.

#### getReminders()

**Signature**

```java
public List<Slack.Reminder> getReminders()
```

**Return Value**

Type: List<Slack.Reminder>

#### setReminders(reminders)

**Signature**

```java
public void setReminders(List<Slack.Reminder> reminders)
```

**Parameters**

_reminders_

Type: List<Slack.Reminder>

**Return Value**

Type: void