Work with Pins

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

PinsAddRequest Class 

Sends a request to pin an item to a channel.

Usage

See Slack’s pins.add method.

PinsAddRequest Methods 

The following are methods for PinsAddRequest.

builder() 

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

Signature

1public static Slack.PinsAddRequest.Builder builder()

Return Value

Type: Slack.PinsAddRequest.Builder


PinsAddRequest.Builder Class 

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

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

PinsAddRequest.Builder Methods 

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

build() 

Required. Returns an instance of Slack.PinsAddRequest.

Signature

1public Slack.PinsAddRequest build()

Return Value

Type: Slack.PinsAddRequest

channel(channel) 

Required. The channel to pin the message to.

Signature

1public Slack.PinsAddRequest.Builder channel(String channel)

Parameters

channel

Type: String

Return Value

Type: Slack.PinsAddRequest.Builder

file(file) 

Signature

1public Slack.PinsAddRequest.Builder file(String file)

Parameters

file

Type: String

Return Value

Type: Slack.PinsAddRequest.Builder

fileComment(fileComment) 

Signature

1public Slack.PinsAddRequest.Builder fileComment(String fileComment)

Parameters

fileComment

Type: String

Return Value

Type: Slack.PinsAddRequest.Builder

timestamp(timestamp) 

Required. The timestamp for the message pinned within the conversation.

Signature

1public Slack.PinsAddRequest.Builder timestamp(String timestamp)

Parameters

timestamp

Type: String

Return Value

Type: Slack.PinsAddRequest.Builder


PinsAddResponse Class 

Pins an item to a channel.

Usage

See Slack’s pins.add method.

PinsAddResponse Methods 

This class contains standard response methods.

The following are methods for PinsAddResponse.

getResponseMetadata() 

Signature

1public Slack.ErrorResponseMetadata getResponseMetadata()

Return Value

Type: Slack.ErrorResponseMetadata

setResponseMetadata(responseMetadata) 

Signature

1public void setResponseMetadata(Slack.ErrorResponseMetadata responseMetadata)

Parameters

responseMetadata

Type: Slack.ErrorResponseMetadata

Return Value

Type: void


PinsListRequest Class 

Sends a request to list items that are pinned to a channel.

Usage

See Slack’s pins.list method.

PinsListRequest Methods 

The following are methods for PinsListRequest.

builder() 

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

Signature

1public static Slack.PinsListRequest.Builder builder()

Return Value

Type: Slack.PinsListRequest.Builder


PinsListRequest.Builder Class 

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

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

PinsListRequestBuilder Methods 

The following are methods for PinsListRequest.Builder.

build() 

Required. Returns an instance of Slack.PinsListRequest.

Signature

1public Slack.PinsListRequest build()

Return Value

Type: Slack.PinsListRequest

channel(channel) 

Required. The channel to get pinned items for.

Signature

1public Slack.PinsListRequest.Builder channel(String channel)

Parameters

channel

Type: String

Return Value

Type: Slack.PinsListRequest.Builder


PinsListResponse Class 

Lists items that are pinned to a channel.

Usage

See Slack’s pins.list method.

PinsListResponse Methods 

This class contains standard response methods.

The following are methods for PinsListResponse.

getItems() 

Signature

1public List<Slack.PinsListResponse.MessageItem> getItems()

Return Value

Type: List<Slack.PinsListResponse.MessageItem>

setItems(items) 

Signature

1public void setItems(List<Slack.PinsListResponse.MessageItem> items)

Parameters

items

Type: List<Slack.PinsListResponse.MessageItem>

Return Value

Type: void


PinsListResponse.MessageItem Class 

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

PinsListResponse.MessageItem Methods 

The following are methods for PinsListResponse.MessageItem.

getChannel() 

Signature

1public String getChannel()

Return Value

Type: String

getCreatedBy() 

Signature

1public String getCreatedBy()

Return Value

Type: String

getComment() 

Signature

1public Slack.FileComment getComment()

Return Value

Type: Slack.FileComment

getFile() 

Signature

1public Slack.File getFile()

Return Value

Type: Slack.File

getMessage() 

Signature

1public Slack.Message getMessage()

Return Value

Type: Slack.Message

getType() 

Signature

1public String getType()

Return Value

Type: String

setChannel(channel) 

Signature

1public void setChannel(String channel)

Parameters

channel

Type: String

Return Value

Type: void

setComment(comment) 

Signature

1public void setComment(Slack.FileComment comment)

Parameters

comment

Type: Slack.FileComment

Return Value

Type: void

setCreated(created) 

Signature

1public void setCreated(Integer created)

Parameters

created

Type: Integer

Return Value

Type: void

setCreatedBy(createdBy) 

Signature

1public void setCreatedBy(String createdBy)

Parameters

createdBy

Type: String

Return Value

Type: void

setFile(file) 

Signature

1public void setFile(Slack.File file)

Parameters

file

Type: Slack.File

Return Value

Type: void

setMessage(message) 

Signature

1public void setMessage(Slack.Message message)

Parameters

message

Type: Slack.Message

Return Value

Type: void

setType(type) 

Signature

1public void setType(String type)

Parameters

type

Type: String

Return Value

Type: void


PinsRemoveRequest Class 

Sends a request to unpin an item from a channel.

Usage

See Slack’s pins.remove method.

PinsRemoveRequest Methods 

The following are methods for PinsRemoveRequest.

builder() 

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

Signature

1public static Slack.PinsRemoveRequest.Builder builder()

Return Value

Type: Slack.PinsRemoveRequest.Builder


PinsRemoveRequest.Builder Class 

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

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

PinsRemoveRequest.Builder Methods 

The following are methods for PinsRemoveRequest.Builder.

build() 

Required. Returns an instance of Slack.PinsRemoveRequest.

Signature

1public Slack.PinsRemoveRequest build()

Return Value

Type: Slack.PinsRemoveRequest

channel(channel) 

Required. The channel where the item is pinned to.

Signature

1public Slack.PinsRemoveRequest.Builder channel(String channel)

Parameters

channel

Type: String

Return Value

Type: Slack.PinsRemoveRequest.Builder

file(file) 

Required if fileComment(fileComment) or timestamp(timestamp) is not used.

Signature

1public Slack.PinsRemoveRequest.Builder file(String file)

Parameters

file

Type: String

Return Value

Type: Slack.PinsRemoveRequest.Builder

fileComment(fileComment) 

Required if file(file) or timestamp(timestamp) is not used.

Signature

1public Slack.PinsRemoveRequest.Builder fileComment(String fileComment)

Parameters

fileComment

Type: String

Return Value

Type: Slack.PinsRemoveRequest.Builder

timestamp(timestamp) 

Required if file(file) or fileComment(fileComment) is not used. Timestamp of the message to unpin.

Signature

1public Slack.PinsRemoveRequest.Builder timestamp(String timestamp)

Parameters

timestamp

Type: String

Return Value

Type: Slack.PinsRemoveRequest.Builder


PinsRemoveResponse Class 

Unpins an item to a channel.

Usage

See Slack’s pins.remove method.

PinsRemoveResponse Methods 

This class contains standard response methods.

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.