Work with Do Not Disturb Mode

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

DndEndDndRequest Class 

Sends a request to end the current user’s Do Not Disturb session immediately.

Usage

See Slack’s dnd.endDnd method.

DndEndDndRequest Methods 

The following are methods for DndEndDndRequest.

builder() 

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

Signature

1public static Slack.DndEndDndRequest.Builder builder()

Return Value

Type: Slack.DndEndDndRequest.Builder


DndEndDndRequest.Builder Class 

Contains methods to build an instance of the Slack.DndEndDndRequest class.

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

DndEndDndRequest.Builder Methods 

The following are methods for DndEndDndRequest.Builder.

build() 

Required. Returns an instance of Slack.DndEndDndRequest.

Signature

1public Slack.DndEndDndRequest build()

Return Value

Type: Slack.DndEndDndRequest


DndEndDndResponse Class 

Ends the current user’s Do Not Disturb session immediately.

Usage

See Slack’s dnd.endDnd method.

DndEndDndResponse Methods 

This class contains standard response methods.


DndEndSnoozeRequest Class 

Sends a request to end the current user’s snooze mode immediately.

Usage

See Slack’s dnd.endSnooze method.

DndEndSnoozeRequest Methods 

The following are methods for DndEndSnoozeRequest.

builder() 

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

Signature

1public static Slack.DndEndSnoozeRequest.Builder builder()

Return Value

Type: Slack.DndEndSnoozeRequest.Builder


DndEndSnoozeRequest.Builder Class 

Contains methods to build an instance of the Slack.DndEndSnoozeRequest class.

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

DndEndSnoozeRequest.Builder Methods 

The following are methods for DndEndSnoozeRequest.Builder.

build() 

Required. Returns an instance of the Slack.DndEndSnoozeRequest object.

Signature

1public Slack.DndEndSnoozeRequest build()

Return Value

Type: Slack.DndEndSnoozeRequest


DndEndSnoozeResponse Class 

Ends the current user’s snooze mode immediately.

Usage

See Slack’s dnd.endSnooze method.

DndEndSnoozeResponse Methods 

This class contains standard response methods.

The following are methods for DndEndSnoozeResponse.

getNextDndEndTs() 

Gets the timestamp for when the next Do Not Disturb session ends.

Signature

1public Integer getNextDndEndTs()

Return Value

Type: Integer

getNextDndStartTs() 

Gets the timestamp for when the next Do Not Disturb session starts.

Signature

1public Integer getNextDndStartTs()

Return Value

Type: Integer

isDndEnabled() 

Specifies whether the user’s Do Not Disturb mode is enabled.

Signature

1public Boolean isDndEnabled()

Return Value

Type: Boolean

isSnoozeEnabled() 

Specifies whether snooze is enabled.

Signature

1public Boolean isSnoozeEnabled()

Return Value

Type: Boolean

setDndEnabled(dndEnabled) 

Sets whether Do Not Disturb mode is enabled .

Signature

1public void setDndEnabled(Boolean dndEnabled)

Parameters

dndEnabled

Type: Boolean

setNextDndEndTs(nextDndEndTs) 

Signature

1public void setNextDndEndTs(Integer nextDndEndTs)

Parameters

nextDndEndTs

Type: Integer

Return Value

Type: void

setNextDndStartTs(nextDndStartTs) 

Signature

1public void setNextDndStartTs(Integer nextDndStartTs)

Parameters

nextDndStartTs

Type: Integer

Return Value

Type: void

setSnoozeEnabled(snoozeEnabled) 

Signature

1public void setSnoozeEnabled(Boolean snoozeEnabled)

Parameters

snoozeEnabled

Type: Boolean

Return Value

Type: void


DndInfoRequest Class 

Sends a request to retrieve a user’s current Do Not Disturb status.

Usage

See Slack’s dnd.info method.

DndInfoRequest Methods 

The following are methods for DndInfoRequest.

builder() 

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

Signature

1public static Slack.DndInfoRequest.Builder builder()

Return Value

Type: Slack.DndInfoRequest.Builder


DndInfoRequest.Builder Class 

Contains methods to build an instance of the Slack.DndInfoRequest class.

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

DndInfoRequest.Builder Methods 

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

build() 

Required. Returns an instance of Slack.DndInfoRequest.

Signature

1public Slack.DndInfoRequest build()

Return Value

Type: Slack.DndInfoRequest

user(user) 

Signature

1public Slack.DndInfoRequest.Builder user(String user)

Parameters

user

Type: String

Return Value

Type: Slack.DndInfoRequest.Builder

teamId(teamId) 

Signature

1public Slack.DndInfoRequest.Builder teamId(String teamId)

Parameters

teamId

Type: String

Return Value

Type: Slack.DndInfoRequest.Builder

DndInfoResponse Class 

Retrieves a user’s current Do Not Disturb status.

Usage

See Slack’s dnd.info method.

DndInfoResponse Methods 

This class contains standard response methods.

The following are methods for DndInfoResponse.

getNextDndEndTs() 

Gets the timestamp for when the next Do Not Disturb session ends.

Signature

1public Integer getNextDndEndTs()

Return Value

Type: Integer

getNextDndStartTs() 

Gets the timestamp for when the next Do Not Disturb session starts.

Signature

1public Integer getNextDndStartTs()

Return Value

Type: Integer

getSnoozeEndtime() 

Gets the timestamp for when the snooze ends.

Signature

1public Integer getSnoozeEndtime()

Return Value

Type: Integer

getSnoozeRemaining() 

Gets the remaining time for the snooze.

Signature

1public Integer getSnoozeRemaining()

Return Value

Type: Integer

isDndEnabled() 

Specifies whether the user’s Do Not Disturb mode is enabled.

Signature

1public Boolean isDndEnabled()

Return Value

Type: Boolean

isSnoozeEnabled() 

Specifies whether snooze is enabled.

Signature

1public Boolean isSnoozeEnabled()

Return Value

Type: Boolean

setDndEnabled(dndEnabled) 

Sets whether Do Not Disturb mode is enabled .

Signature

1public void setDndEnabled(Boolean dndEnabled)

Parameters

dndEnabled

Type: Boolean

setNextDndEndTs(nextDndEndTs) 

Signature

1public void setNextDndEndTs(Integer nextDndEndTs)

Parameters

nextDndEndTs

Type: Integer

Return Value

Type: void

setNextDndStartTs(nextDndStartTs) 

Signature

1public void setNextDndStartTs(Integer nextDndStartTs)

Parameters

nextDndStartTs

Type: Integer

Return Value

Type: void

setSnoozeEnabled(snoozeEnabled) 

Signature

1public void setSnoozeEnabled(Boolean snoozeEnabled)

Parameters

snoozeEnabled

Type: Boolean

Return Value

Type: void

setSnoozeEndtime(snoozeEndtime) 

Signature

1public void setSnoozeEndtime(Integer snoozeEndtime)

Parameters

snoozeEndtime

Type: Integer

Return Value

Type: void

setSnoozeRemaining(snoozeRemaining) 

Signature

1public void setSnoozeRemaining(Integer snoozeRemaining)

Parameters

snoozeRemaining

Type: Integer

Return Value

Type: void


DndSetSnoozeRequest Class 

Sends a request to turn on Do Not Disturb mode for the current user, or to change its duration.

Usage

See Slack’s dnd.setSnooze method.

DndSetSnoozeRequest Methods 

The following are methods for DndSetSnoozeRequest.

builder() 

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

Signature

1public static Slack.DndSetSnoozeRequest.Builder builder()

Return Value

Type: Slack.DndSetSnoozeRequest.Builder


DndSetSnoozeRequest.Builder Class 

Contains methods to build an instance of the Slack.DndSetSnoozeRequest class.

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

DndSetSnoozeRequest.Builder Methods 

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

build() 

Required. Builds an instance of Slack.DndSetSnoozeRequest.

Signature

1public Slack.DndSetSnoozeRequest build()

Return Value

Type: Slack.DndSetSnoozeRequest

numMinutes(numMinutes) 

Signature

1public Slack.DndSetSnoozeRequest.Builder numMinutes(Integer numMinutes)

Parameters

numMinutes

Type: Integer

Return Value

Type: Slack.DndSetSnoozeRequest.Builder


DndSetSnoozeResponse Class 

Turns on Do Not Disturb mode for the current user, or changes its duration.

Usage

See Slack’s dnd.setSnooze method

DndSetSnoozeResponse Methods 

This class contains standard response methods.

The following are methods for DndSetSnoozeResponse.

getSnoozeEndtime() 

Gets the timestamp for when the snooze ends.

Signature

1public Integer getSnoozeEndtime()

Return Value

Type: Integer

getSnoozeRemaining() 

Gets the remaining time for the snooze.

Signature

1public Integer getSnoozeRemaining()

Return Value

Type: Integer

isSnoozeEnabled() 

Specifies whether snooze is enabled.

Signature

1public Boolean isSnoozeEnabled()

Return Value

Type: Boolean

setSnoozeEnabled(snoozeEnabled) 

Sets whether the user’s Do Not Disturb mode is enabled.

Signature

1public void setSnoozeEnabled(Boolean snoozeEnabled)

Parameters

snoozeEnabled

Type: Boolean

Return Value

Type: void

setSnoozeEndtime(snoozeEndtime) 

Sets when the user’s Do Not Disturb mode ends.

Signature

1public void setSnoozeEndtime(Integer snoozeEndtime)

Parameters

snoozeEndtime

Type: Integer

Return Value

Type: void

setSnoozeRemaining(snoozeRemaining) 

Sets how long more the Do Not Disturb mode lasts.

Signature

1public void setSnoozeRemaining(Integer snoozeRemaining)

Parameters

snoozeRemaining

Type: Integer

Return Value

Type: void


DndTeamInfoRequest Class 

Sends a request to retrieve the Do Not Disturb status for up to 50 users on a team.

Usage

See Slack’s dnd.teamInfo method.

DndTeamInfoRequest Methods 

The following are methods for DndTeamInfoRequest.

builder() 

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

Signature

1public static Slack.DndTeamInfoRequest.Builder builder()

Return Value

Type: Slack.DndTeamInfoRequest.Builder


DndTeamInfoRequest.Builder Class 

Contains methods to build an instance of the Slack.DndTeamInfoRequest class.

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

DndTeamInfoRequest.Builder Methods 

The following are methods for DndTeamInfoRequest.Builder.

build() 

Required. Builds an instance of Slack.DndTeamInfoRequest.

Signature

1public Slack.DndTeamInfoRequest build()

Return Value

Type: Slack.DndTeamInfoRequest

teamId(teamId) 

Signature

1public Slack.DndTeamInfoRequest.Builder teamId(String teamId)

Parameters

teamId

Type: String

Return Value

Type: Slack.DndTeamInfoRequest.Builder

users(users) 

Required. The comma-separated list of users to fetch Do Not Disturb status for.

Signature

1public Slack.DndTeamInfoRequest.Builder users(List<String> users)

Parameters

users

Type: List<String>

Return Value

Type: Slack.DndTeamInfoRequest.Builder


DndTeamInfoResponse Class 

Retrieves the Do Not Disturb status for up to 50 users on a team.

Usage

See Slack’s dnd.teamInfo method.

DndTeamInfoResponse Methods 

This class contains standard response methods.

The following are methods for DndTeamInfoResponse.

getUsers() 

Signature

1public Map<String,Slack.DndTeamInfoResponse.DndTeamMemberInfo> getUsers()

Return Value

Type: Map<String,Slack.DndTeamInfoResponse.DndTeamMemberInfo>

setUsers(users) 

Signature

1public void setUsers(Map<String,Slack.DndTeamInfoResponse.DndTeamMemberInfo> users)

Parameters

users

Type: Map<String,Slack.DndTeamInfoResponse.DndTeamMemberInfo>

Return Value

Type: void


DndTeamInfoResponse.DndTeamMemberInfo Class 

Contains methods to build an instance of the Slack.DndTeamInfoResponse class.

A DndTeamMemberInfo object is obtained by invoking one of the DndTeamInfoResponse.DndTeamMemberInfo methods defined by the DndTeamInfoResponse class.

DndTeamInfoResponse.DndTeamMemberInfo Methods 

The following are methods for DndTeamInfoResponse.DndTeamMemberInfo.

getNextDndEndTs() 

Signature

1public Integer getNextDndEndTs()

Return Value

Type: Integer

getNextDndStartTs() 

Signature

1public Integer getNextDndStartTs()

Return Value

Type: Integer

isDndEnabled() 

Signature

1public Boolean isDndEnabled()

Return Value

Type: Boolean

setDndEnabled(dndEnabled) 

Signature

1public void setDndEnabled(Boolean dndEnabled)

Parameters

dndEnabled

Type: Boolean

Return Value

Type: void

Beta Feature

This feature is not generally available. It is not part of your purchased Services. This feature is subject to change, may be discontinued with no notice at any time in SFDC’s sole discretion, and SFDC may never make this feature generally available. Make your purchase decisions only on the basis of generally available products and features. This feature is made available on an AS IS basis and use of this feature is at your sole risk.