Work with Reminders

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

Represents a reminder.

Reminder Methods.

The following are methods for Reminder.

getChannel()()

Signature

Return Value

Type: String

getCompleteTs()

Signature

Return Value

Type: Integer

getCreator()

Signature

Return Value

Type: String

getId()

Signature

Return Value

Type: String

getItem()

Signature

Return Value

Type: Object

getRecurrence()

Signature

Return Value

Type: Slack.Reminder.Recurrence

getText()

Signature

Return Value

Type: String

getTime()

Signature

Return Value

Type: Integer

getUser()

Signature

Return Value

Type: String

isRecurring()

Signature

Return Value

Type: Boolean

setChannel(channel)

Signature

Parameters

channel

Type: String

Return Value

Type: void

setCompleteTs(completeTs)

Signature

Parameters

completeTs

Type: Integer

Return Value

Type: void

setCreator(creator)

Signature

Parameters

creator

Type: String

Return Value

Type: void

setId(id)

Signature

Parameters

id

Type: String

Return Value

Type: void

setItem(item)

Signature

Parameters

item

Type: Object

Return Value

Type: void

setRecurrence(recurrence)

Signature

Parameters

recurrence

Type: Slack.Reminder.Recurrence

Return Value

Type: void

setRecurring(recurring)

Signature

Parameters

recurring

Type: Boolean

Return Value

Type: void

setText(text)

Signature

Parameters

text

Type: String

Return Value

Type: void

setTime(timeValue)

Signature

Parameters

timeValue

Type: Integer

Return Value

Type: void

setUser(user)

Signature

Parameters

user

Type: String

Return Value

Type: void

Reminder.Recurrence Methods

The following are methods for Reminder.Recurrence.

getFrequency()

Signature

Return Value

Type: String

getWeekdays()

Signature

Return Value

Type: List<String>

setFrequency(frequency)

Signature

Parameters

frequency

Type: String

Return Value

Type: void

setWeekdays(weekdays)

Signature

Parameters

weekdays

Type: List<String>

Return Value

Type: void

Sends a request to create a reminder.

Usage

See Slack’s reminders.add method.

RemindersAddRequest Methods

The following are methods for RemindersAddRequest.

builder()

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.

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

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

Parameters

timeValue

Type: String

Return Value

Type: Slack.RemindersAddRequest.Builder

text(text)

Required. The description of the reminder.

Signature

Parameters

text

Type: String

Return Value

Type: Slack.RemindersAddRequest.Builder

user(user)

Signature

Parameters

user

Type: String

Return Value

Type: Slack.RemindersAddRequest.Builder

Creates a reminder.

Usage

See Slack’s reminders.add method.

RemindersAddResponse Methods

This class contains standard response methods.

The following are methods for RemindersAddResponse.

getReminder()

Signature

Return Value

Type: Slack.Reminder

setReminder(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.

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

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

Return Value

Type: Slack.RemindersCompleteRequest

reminder(reminder)

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

Signature

Parameters

reminder

Type: String

Return Value

Type: Slack.RemindersCompleteRequest.Builder

teamId(teamId)

Signature

Parameters

teamId

Type: String

Return Value

Type: Slack.RemindersCompleteRequest.Builder

Marks a reminder as complete.

Usage

See Slack’s reminders.complete method.

RemindersCompleteResponse Methods

This class contains standard response methods.

Sends a request to delete a reminder.

Usage

See Slack’s reminders.delete method.

RemindersDeleteRequest Methods

The following are methods for RemindersDeleteRequest.

builder()

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

Signature

Return Value

Type: Slack.RemindersDeleteRequest.Builder

teamId(teamId)

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.

RemindersDeleteRequest.Builder Methods

The following are methods for RemindersDeleteRequest.Builder.

build()

Required. Returns an instance of Slack.RemindersDeleteRequest.

Signature

Return Value

Type: Slack.RemindersDeleteRequest

reminder(reminder)

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.

RemindersDeleteResponse Methods

This class contains standard response methods.

Sends a request to get information about a reminder.

Usage

See Slack’s reminders.info method.

RemindersInfoRequest Methods

The following are methods for RemindersInfoRequest.

builder()

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

Signature

Return Value

Type: Slack.RemindersInfoRequest.Builder

teamId(teamId)

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.

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

Parameters

reminder

Type: String

Return Value

Type: Slack.RemindersInfoRequest.Builder

Gets information about a reminder.

Usage

See Slack’s reminders.info method.

RemindersInfoResponse Methods

This class contains standard response methods.

The following are methods for RemindersInfoResponse.

getReminder()

Signature

Return Value

Type: Slack.Reminder

setReminder(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.

RemindersListRequest Methods

The following are methods for RemindersListRequest.

builder()

Signature

Return Value

Type: Slack.RemindersListRequest.Builder

teamId(teamId)

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.

RemindersListRequest.Builder Methods

The following are methods for RemindersListRequest.Builder.

build()

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.

RemindersListResponse Methods

This class contains standard response methods.

The following are methods for RemindersListResponse.

getReminders()

Signature

Return Value

Type: List<Slack.Reminder>

setReminders(reminders)

Signature

Parameters

reminders

Type: List<Slack.Reminder>

Return Value

Type: void