Preparing search index...
The search index is not available
Rocket.Chat Apps TypeScript Definition
Rocket.Chat Apps TypeScript Definition
uikit/blocks/Blocks
IBlock
Interface IBlock
Deprecated
please prefer the rocket.chat/ui-kit components
Hierarchy
IBlock
ISectionBlock
IImageBlock
IDividerBlock
IActionsBlock
IContextBlock
IInputBlock
IConditionalBlock
Index
Properties
app
Id?
block
Id?
type
Properties
Optional
app
Id
app
Id
?:
string
Optional
block
Id
block
Id
?:
string
type
type
:
BlockType
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
app
Id
block
Id
type
Rocket.
Chat
Apps
Type
Script
Definition
App
App
Status
IApp
accessors
accessors/IApi
Extend
accessors/IApp
Accessors
accessors/IApp
Installation
Context
accessors/IApp
Uninstallation
Context
accessors/IApp
Update
Context
accessors/ICloud
Workspace
Read
accessors/IConfiguration
Extend
accessors/IConfiguration
Modify
accessors/IDiscussion
Builder
accessors/IEnvironment
Read
accessors/IEnvironment
Write
accessors/IEnvironmental
Variable
Read
accessors/IExternal
Components
Extend
accessors/IHttp
accessors/ILivechat
Creator
accessors/ILivechat
Message
Builder
accessors/ILivechat
Read
accessors/ILivechat
Updater
accessors/ILog
Entry
accessors/ILogger
accessors/IMessage
Builder
accessors/IMessage
Extender
accessors/IMessage
Read
accessors/IModeration
Modify
accessors/IModify
accessors/IModify
Creator
accessors/IModify
Deleter
accessors/IModify
Extender
accessors/IModify
Updater
accessors/INotifier
accessors/IOAuth
App
accessors/IOAuth
Apps
Modify
accessors/IOAuth
Apps
Reader
accessors/IPersistence
accessors/IPersistence
Read
accessors/IRead
accessors/IRole
Read
accessors/IRoom
Builder
accessors/IRoom
Extender
accessors/IRoom
Read
accessors/IScheduler
Extend
accessors/IScheduler
Modify
accessors/IServer
Setting
Read
accessors/IServer
Setting
Updater
accessors/IServer
Settings
Modify
accessors/ISetting
Read
accessors/ISetting
Updater
accessors/ISettings
Extend
accessors/ISlash
Commands
Extend
accessors/ISlash
Commands
Modify
accessors/IThread
Read
accessors/IUIController
accessors/IUIExtend
accessors/IUpload
Creator
accessors/IUpload
Read
accessors/IUser
Builder
accessors/IUser
Read
accessors/IUser
Updater
accessors/IVideo
Conf
Providers
Extend
accessors/IVideo
Conference
Builder
accessors/IVideo
Conference
Extend
accessors/IVideo
Conference
Read
api
api/
Api
Endpoint
api/IApi
api/IApi
Endpoint
api/IApi
Endpoint
Info
api/IApi
Endpoint
Metadata
api/IApi
Example
api/IRequest
api/IResponse
assets
assets/IAsset
assets/IAsset
Provider
cloud/IWorkspace
Token
definition/roles
email
email/IEmail
Descriptor
email/IPre
Email
Sent
email/IPre
Email
Sent
Context
exceptions
exceptions/
Apps
Engine
Exception
exceptions/
Essential
App
Disabled
Exception
exceptions/
File
Upload
Not
Allowed
Exception
exceptions/
Invalid
Setting
Value
Exception
exceptions/
User
Not
Allowed
Exception
external
Component
external
Component/IExternal
Component
external
Component/IExternal
Component
Options
external
Component/IExternal
Component
State
external
Component/IPost
External
Component
Closed
external
Component/IPost
External
Component
Opened
livechat
livechat/IDepartment
livechat/ILivechat
Event
Context
livechat/ILivechat
Message
livechat/ILivechat
Room
livechat/ILivechat
Room
Closed
Handler
livechat/ILivechat
Transfer
Data
livechat/ILivechat
Transfer
Event
Context
livechat/IPost
Livechat
Agent
Assigned
livechat/IPost
Livechat
Agent
Unassigned
livechat/IPost
Livechat
Guest
Saved
livechat/IPost
Livechat
Room
Closed
livechat/IPost
Livechat
Room
Saved
livechat/IPost
Livechat
Room
Started
livechat/IPost
Livechat
Room
Transferred
livechat/IVisitor
livechat/IVisitor
Email
livechat/IVisitor
Phone
messages
messages/IMessage
messages/IMessage
Action
messages/IMessage
Attachment
messages/IMessage
Attachment
Author
messages/IMessage
Attachment
Field
messages/IMessage
Attachment
Title
messages/IMessage
Delete
Context
messages/IMessage
File
messages/IMessage
Follow
Context
messages/IMessage
Pin
Context
messages/IMessage
Raw
messages/IMessage
Reaction
messages/IMessage
Reaction
Context
messages/IMessage
Report
Context
messages/IMessage
Star
Context
messages/IPost
Message
Deleted
messages/IPost
Message
Followed
messages/IPost
Message
Pinned
messages/IPost
Message
Reacted
messages/IPost
Message
Reported
messages/IPost
Message
Sent
messages/IPost
Message
Sent
To
Bot
messages/IPost
Message
Starred
messages/IPost
Message
Updated
messages/IPre
Message
Delete
Prevent
messages/IPre
Message
Sent
Extend
messages/IPre
Message
Sent
Modify
messages/IPre
Message
Sent
Prevent
messages/IPre
Message
Updated
Extend
messages/IPre
Message
Updated
Modify
messages/IPre
Message
Updated
Prevent
messages/
Message
Action
Buttons
Alignment
messages/
Message
Action
Type
messages/
Message
Processing
Type
metadata
metadata/
App
Interface
metadata/
App
Method
metadata/IApp
Author
Info
metadata/IApp
Info
metadata/
Rocket
Chat
Associations
oauth2/IOAuth2
oauth2/OAuth2
permissions/IPermission
persistence
persistence/IPersistence
Item
roles/IRole
rooms
rooms/IPost
Room
Create
rooms/IPost
Room
Deleted
rooms/IPost
Room
User
Joined
rooms/IPost
Room
User
Leave
rooms/IPre
Room
Create
Extend
rooms/IPre
Room
Create
Modify
rooms/IPre
Room
Create
Prevent
rooms/IPre
Room
Delete
Prevent
rooms/IPre
Room
User
Joined
rooms/IPre
Room
User
Leave
rooms/IRoom
rooms/IRoom
User
Joined
Context
rooms/IRoom
User
Leave
Context
rooms/
Room
Type
scheduler
scheduler/IOnetime
Schedule
scheduler/IProcessor
scheduler/IRecurring
Schedule
settings
settings/ISetting
settings/ISetting
Update
Context
settings/
Setting
Type
slashcommands
slashcommands/ISlash
Command
slashcommands/ISlash
Command
Preview
slashcommands/
Slash
Command
Context
ui
ui/IUIAction
Button
Descriptor
ui/UIAction
Button
Context
uikit
uikit/IUIKit
Action
Handler
uikit/IUIKit
Incoming
Interaction
uikit/IUIKit
Incoming
Interaction
Action
Button
uikit/IUIKit
Interaction
Type
uikit/IUIKit
Surface
uikit/IUIKit
View
uikit/UIKit
Incoming
Interaction
Container
uikit/UIKit
Incoming
Interaction
Types
uikit/UIKit
Interaction
Context
uikit/UIKit
Interaction
Payload
Formatter
uikit/UIKit
Interaction
Responder
uikit/blocks
uikit/blocks/
Block
Builder
uikit/blocks/
Blocks
Block
Type
Conditional
Block
Filters
Engine
IActions
Block
IBlock
IConditional
Block
IConditional
Block
Filters
IContext
Block
IDivider
Block
IImage
Block
IInput
Block
ISection
Block
uikit/blocks/
Elements
uikit/blocks/
Objects
uikit/livechat
uikit/livechat/IUIKit
Livechat
Action
Handler
uikit/livechat/IUIKit
Livechat
Incoming
Interaction
uikit/livechat/UIKit
Livechat
Incoming
Interaction
Type
uikit/livechat/UIKit
Livechat
Interaction
Context
uploads
uploads/IFile
Upload
Context
uploads/IPre
File
Upload
uploads/IUpload
uploads/IUpload
Descriptor
uploads/IUpload
Details
uploads/
Store
Type
users
users/IBot
User
users/IPost
User
Created
users/IPost
User
Deleted
users/IPost
User
Logged
In
users/IPost
User
Logged
Out
users/IPost
User
Status
Changed
users/IPost
User
Updated
users/IUser
users/IUser
Context
users/IUser
Creation
Options
users/IUser
Email
users/IUser
Lookup
users/IUser
Settings
users/IUser
Status
Context
users/IUser
Update
Contex
users/IUser
Update
Context
users/
User
Status
Connection
users/
User
Type
video
Conf
Providers
video
Conf
Providers/IVideo
Conf
Provider
video
Conf
Providers/IVideo
Conference
Options
video
Conf
Providers/
Video
Conf
Data
video
Conferences
video
Conferences/
App
Video
Conference
video
Conferences/IVideo
Conference
video
Conferences/IVideo
Conference
User
Generated using
TypeDoc
Deprecated
please prefer the rocket.chat/ui-kit components