Note: There is a newer version (4.0.0) of this package available. Click here to view docs for the latest version.
Module slack
ballerinax/slack Ballerina library
0.9.9
Clients
slack: Client
Client for Slack connector.
createConversation
Isolated FunctionRemote Function
Create a channel.
Parameters
- name string - Name of the channel to be created
- isPrivate boolean (default false) -
trueif a private channel,falseif a public channel
archiveConversation
Isolated FunctionRemote Function
Archive a channel.
Parameters
- channelName string - Name of the channel to archive
Return Type
- error? - An error if it is a failure or
nilif it is a success
unArchiveConversation
Isolated FunctionRemote Function
Unarchive a channel.
Parameters
- channelName string - Name of the channel to unarchive
Return Type
- error? - An error if it is a failure or
nilif it is a success
renameConversation
Isolated FunctionRemote Function
Rename a channel.
listConversations
Isolated FunctionRemote Function
function listConversations() returns Conversations|errorList all the channels in a slack team.
Return Type
- Conversations|error - An error if it is a failure or the
Conversationsrecord if it is a success
leaveConversation
Isolated FunctionRemote Function
Leave a channel.
Parameters
- channelName string - Name of the channel
Return Type
- error? - An error if it is a failure or 'nil' if it is a success
getConversationInfo
Isolated FunctionRemote Function
function getConversationInfo(string channelName, boolean includeLocale, boolean memberCount) returns Channel|errorGet information about a channel.
Parameters
- channelName string - Name of the channel
- includeLocale boolean (default false) - Set this to
trueto receive the locale for this conversation. Defaults tofalse
- memberCount boolean (default false) - Set to
trueto include the member count for the specified conversation. Defaults tofalse
removeUserFromConversation
Isolated FunctionRemote Function
Remove a user from a channel.
Return Type
- error? - An error if it is a failure or
nilif it is a success
joinConversation
Isolated FunctionRemote Function
Join an existing channel.
Parameters
- channelName string - Name of the channel
Return Type
- error? - An error if it is a failure or 'nil' if it is a success
inviteUsersToConversation
Isolated FunctionRemote Function
Invite users to a channel.
getConversationHistory
Isolated FunctionRemote Function
function getConversationHistory(string channelName, string? startOfTimeRange, string? endOfTimeRange) returns stream<MessageInfo, error>|error?Get message history of a channel.
Parameters
- channelName string - Name of the channel
- startOfTimeRange string? (default ()) - Start of time range as epoch
- endOfTimeRange string? (default ()) - End of time range as epoch
Return Type
- stream<MessageInfo, error>|error? - Stream of MessageInfo if it is a success or an error if it is a failure
getConversationMembers
Isolated FunctionRemote Function
Get userId of all the members of a channel.
Parameters
- channelName string - Name of the channel
Return Type
getUserInfoByUsername
Isolated FunctionRemote Function
Get information about a user by username.
Parameters
- username string - Slack username of the user
getUserInfoByUserId
Isolated FunctionRemote Function
Get information about a user by userId.
Parameters
- userId string - Slack userId of the user
listUserConversations
Isolated FunctionRemote Function
function listUserConversations(boolean excludeArchived, int? noOfItems, string? types, string? user) returns Conversations|errorList channels which can be accessed by a user.
Parameters
- excludeArchived boolean (default false) - Set to
trueto exclude archived channels from the list
- noOfItems int? (default ()) - Maximum number of items to return
- types string? (default ()) - A comma-separated list of any combination of
public_channel,private_channel
- user string? (default ()) - Username
Return Type
- Conversations|error - An error if it is a failure or the
Conversationsrecord if it is a success
lookupUserByEmail
Isolated FunctionRemote Function
Retrieve a single user by looking them up by their registered email address.
Parameters
- email string - An email address belonging to a user in the workspace
postMessage
Isolated FunctionRemote Function
Send a message to a channel.
Parameters
- message Message - Message parameters to be posted on Slack
updateMessage
Isolated FunctionRemote Function
function updateMessage(UpdateMessage message) returns string|errorUpdate a message.
Parameters
- message UpdateMessage - Message parameters to be updated on Slack
deleteMessage
Isolated FunctionRemote Function
Delete a message.
Parameters
- channelName string - Name of the channel
- threadTs string - Timestamp of the message to be deleted
Return Type
- error? - An error if it is a failure or 'nil' if it is a success
deleteFile
Isolated FunctionRemote Function
Delete a file.
Parameters
- fileId string - Id of the file to be deleted
Return Type
- error? - An error if it is a failure or 'nil' if it is a success
getFileInfo
Isolated FunctionRemote Function
Get information of a file.
Parameters
- fileId string - ID of the file
listFiles
Isolated FunctionRemote Function
function listFiles(string? channelName, int? count, string? tsFrom, string? tsTo, string? types, string? user) returns FileInfo[]|errorList files.
Parameters
- channelName string? (default ()) - Name of the channel
- count int? (default ()) - Number of items to return per page
- tsFrom string? (default ()) - Filter files created after this timestamp (inclusive)
- tsTo string? (default ()) - Filter files created before this timestamp (inclusive)
- types string? (default ()) - Type to filter files (ex: types=spaces,snippets)
- user string? (default ()) - Username to filter files created by a single user
Return Type
uploadFile
Isolated FunctionRemote Function
function uploadFile(string filePath, string? channelName, string? title, string? initialComment, string? threadTs) returns FileInfo|errorUpload or create a file.
Enums
slack: Parse
Represents values for Parse
Members
NONE - none
FULL - full
Records
slack: Channel
Contains information about the channel.
Fields
- id string - ID of the channel
- name string - Name of the channel
- isChannel boolean -
trueif a channel or elsefalse
- isGroup boolean -
trueif a group conversation or elsefalse
- isArchived boolean -
trueif the channel is archived
- isGeneral boolean -
trueif the channel is the "general" channel, which includes all regular members
- nameNormalized string - Normalized name
- parentConversation string - Name of the parent conversation if there is one
- creator string - The user ID of the member who created the channel
- isMember boolean? -
trueif the calling member is part of the channel
- isPrivate boolean -
trueif a private channel
- topic Topic - Contains information about the channel topic
- purpose Purpose - Contains information about the channel purpose
slack: Configuration
Closed record
Holds the parameters used to create a Client.
Fields
- bearerTokenConfig BearerTokenConfig - Bearer token configuration
- secureSocketConfig ClientSecureSocket? - Optional. Secure Socket configuration.
slack: Conversations
Contains information about conversations.
Fields
- channels Channel[] - An array of channels
- responseMetadata ResponseMetadata - Response meta data
slack: FileInfo
Contains information about the file.
Fields
- id string - File ID
- created float - Timestamp representing when the file was created
- name string - File name
- title string - File title
- user string - The user ID of the user who uploaded the file
- editable boolean -
trueif the file is stored as editable
- size int - File size in bytes
- mode string - Contains one of hosted, external, snippet, or post
- isExternal boolean -
trueif the master copy of the file is stored within the system otherwisefalse
- externalType string - Type of the external file (e.g., Dropbox or GDoc)
- isPublic boolean -
trueif the file is public
- urlPrivate string - Points to a URL for the file content
- urlPrivateDownload string - Includes headers to force a browser download
- permalink string - The URL pointing to a single page for the file containing details, comments, and a download link
- permalinkPublic string - Points to a public file itself
- lines int - The total count of the lines shown in the snippet
- linesMore int - The count of the lines not shown in the preview
- commentsCount int - The number of comments attached to the file
slack: Message
Parameters associated with posting messages in Slack.
Fields
- channelName string - Channel name
- text string - Text message
- threadTs string? - Provide another message's
tsvalue to make this message a reply
- attachments json[]? - A JSON-based array of structured attachments
- blocks json[]? - A JSON-based array of structured blocks
- iconEmoji string? - Emoji to use as the icon for this message
- iconUrl string? - URL to an image to use as the icon for this message
- linkNames boolean? - Set to
trueto find and link channel names and usernames
- mrkdwn boolean? - Set to
trueto enable Slack markup parsing
- parse Parse? - Refers how messages should be treated:
none, which is the default value orfull
- replyBroadcast boolean? - Used in conjunction with
threadTsand indicates whether the reply should be made visible to everyone in the channel or conversation
- unfurlLinks boolean? -
trueto enable unfurling of primarily text-based content or otherwisefalse
- unfurlMedia boolean? -
falseto disable unfurling of media content
- asUser boolean? -
trueto post the message as the authed user, instead of as a bot
- username string? - Bot's user name. This must be used in conjunction with
asUserset tofalseor otherwise ignored
slack: MessageInfo
Contains information about messages in a Channel.
Fields
- user string - UserId of the author
- text string - Message text
- 'type string -
- ts string - Time stamp of the message
slack: Profile
Contains information about the user profile.
Fields
- title string - Title added in the user profile
- phone string - Phone number
- skype string - Skype ID
- realName string - The real name, which the users specified in their workspace profile
- realNameNormalized string - The
real_namefield with any non-Latin characters filtered out
- displayName string - The display name, which the users have chosen to identify themselves by in their workspace profile
- displayNameNormalized string - The
display_namefield with any non-Latin characters filtered out
slack: Purpose
Contains information about the channel purpose.
Fields
- value string - Value of the purpose
- creator string - The user ID of the member who created the channel
slack: ResponseMetadata
Contains information about the response meta data.
Fields
- nextCursor string - Cursor in the second request
slack: Topic
Contains information about the channel topic.
Fields
- value string - Value of the topic
- creator string - The user ID of the member who created the topic
slack: UpdateMessage
Parameters associated with updating a message.
Fields
- channelName string - Channel name containing the message to be updated
- text string - Text message
- ts string - Timestamp of the message to be updated
- attachments json[]? - A JSON-based array of structured attachments
- blocks json[]? - A JSON-based array of structured blocks
- linkNames boolean? - Set to
trueto find and link channel names and usernames
- parse Parse? - Refers how messages should be treated
- replyBroadcast boolean? - Broadcast an existing thread reply to make it visible to everyone in the channel
slack: User
Contains information about the user.
Fields
- id string - User ID
- teamId string - Team ID
- name string - Name of the user
- deleted boolean -
trueif the user has been deactivated or elsefalse
- realName string - The real name that the users specified in their workspace profile
- tz string - The time zone
- tzLabel string - The commonly-used name of the
tztimezone
- profile Profile - Contains information about the user's workspace profile
- isAdmin boolean -
trueif the user is an admin of the current workspace
- isOwner boolean -
trueif the user is an owner of the current workspace
- isPrimaryOwner boolean -
trueif the user is the primary owner of the current workspace
- isRestricted boolean -
trueif the user is a guest user
- isBot boolean -
trueif the user is a bot user
- isAppUser boolean -
trueif the user is an authorized user of the calling app
- has2fa boolean -
trueif the user has two factor authentication