Work with Reminders

The following are Apex classes for the Slack reminders API methods.

Represents a reminder.

The following are methods for Reminder.

Signature

Return Value

Type: String

Signature

Return Value

Type: Integer

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: Object

Signature

Return Value

Type: Slack.Reminder.Recurrence

Signature

Return Value

Type: String

Signature

Return Value

Type: Integer

Signature

Return Value

Type: String

Signature

Return Value

Type: Boolean

Signature

Parameters

channel

Type: String

Return Value

Type: void

Signature

Parameters

completeTs

Type: Integer

Return Value

Type: void

Signature

Parameters

creator

Type: String

Return Value

Type: void

Signature

Parameters

id

Type: String

Return Value

Type: void

Signature

Parameters

item

Type: Object

Return Value

Type: void

Signature

Parameters

recurrence

Type: Slack.Reminder.Recurrence

Return Value

Type: void

Signature

Parameters

recurring

Type: Boolean

Return Value

Type: void

Signature

Parameters

text

Type: String

Return Value

Type: void

Signature

Parameters

timeValue

Type: Integer

Return Value

Type: void

Signature

Parameters

user

Type: String

Return Value

Type: void

The following are methods for Reminder.Recurrence.

Signature

Return Value

Type: String

Signature

Return Value

Type: List<String>

Signature

Parameters

frequency

Type: String

Return Value

Type: void

Signature

Parameters

weekdays

Type: List<String>

Return Value

Type: void

Sends a request to create a reminder.

Usage

See Slack’s reminders.add method.

The following are methods for RemindersAddRequest.

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

Signature

Return Value

Type: Slack.RemindersAddRequest.Builder

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.

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

Required. Returns an instance of Slack.RemindersAddRequest.

Signature

Return Value

Type: Slack.RemindersAddRequest

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

Parameters

timeValue

Type: String

Return Value

Type: Slack.RemindersAddRequest.Builder

Required. The description of the reminder.

Signature

Parameters

text

Type: String

Return Value

Type: Slack.RemindersAddRequest.Builder

Signature

Parameters

user

Type: String

Return Value

Type: Slack.RemindersAddRequest.Builder

Creates a reminder.

Usage

See Slack’s reminders.add method.

This class contains standard response methods.

The following are methods for RemindersAddResponse.

Signature

Return Value

Type: Slack.Reminder

Signature

Parameters

reminder

Type: Slack.Reminder

Return Value

Type: void

Sends a request to mark a reminder as complete.

Usage

See Slack’s reminders.complete method.

The following are methods for RemindersCompleteRequest.

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

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.

The following are methods for RemindersCompleteRequest.Builder.

Required. Returns an instance of Slack.RemindersCompleteRequest.

Signature

Return Value

Type: Slack.RemindersCompleteRequest

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

Signature

Parameters

reminder

Type: String

Return Value

Type: Slack.RemindersCompleteRequest.Builder

Signature

Parameters

teamId

Type: String

Return Value

Type: Slack.RemindersCompleteRequest.Builder

Marks a reminder as complete.

Usage

See Slack’s reminders.complete method.

This class contains standard response methods.

Sends a request to delete a reminder.

Usage

See Slack’s reminders.delete method.

The following are methods for RemindersDeleteRequest.

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

Signature

Return Value

Type: Slack.RemindersDeleteRequest.Builder

Signature

Parameters

teamId

Type: String

Return Value

Type: Slack.RemindersCompleteRequest.Builder

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.

The following are methods for RemindersDeleteRequest.Builder.

Required. Returns an instance of Slack.RemindersDeleteRequest.

Signature

Return Value

Type: Slack.RemindersDeleteRequest

Required. The ID of the reminder.

Signature

Parameters

reminder

Type: String

Return Value

Type: Slack.RemindersDeleteRequest.Builder

Deletes a reminder.

Usage

See Slack’s reminders.delete method.

This class contains standard response methods.

Sends a request to get information about a reminder.

Usage

See Slack’s reminders.info method.

The following are methods for RemindersInfoRequest.

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

Signature

Return Value

Type: Slack.RemindersInfoRequest.Builder

Signature

Parameters

teamId

Type: String

Return Value

Type: Slack.RemindersCompleteRequest.Builder

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.

The following are methods for RemindersInfoRequest.Builder.

Required. Returns an instance of Slack.RemindersInfoRequest.

Signature

public Slack.RemindersInfoRequest build()

Return Value

Type: Slack.RemindersInfoRequest

Required. The ID of the reminder.

Signature

Parameters

reminder

Type: String

Return Value

Type: Slack.RemindersInfoRequest.Builder

Gets information about a reminder.

Usage

See Slack’s reminders.info method.

This class contains standard response methods.

The following are methods for RemindersInfoResponse.

Signature

Return Value

Type: Slack.Reminder

Signature

Parameters

reminder

Type: Slack.Reminder

Return Value

Type: void

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

Usage

See Slack’s reminders.list method.

The following are methods for RemindersListRequest.

Signature

Return Value

Type: Slack.RemindersListRequest.Builder

Signature

Parameters

teamId

Type: String

Return Value

Type: Slack.RemindersCompleteRequest.Builder

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.

The following are methods for RemindersListRequest.Builder.

Required. Returns an instance of Slack.RemindersListRequest.

Signature

Return Value

Type: Slack.RemindersListRequest

Lists all reminders created by or for a given user.

Usage

See Slack’s reminders.list method.

This class contains standard response methods.

The following are methods for RemindersListResponse.

Signature

Return Value

Type: List<Slack.Reminder>

Signature

Parameters

reminders

Type: List<Slack.Reminder>

Return Value

Type: void