- Overview
- Basic concepts
- Getting started
- Creating plugin template
- Plugin structure
- Coding plugin
- Building plugin
- Config
- Adding plugin
- Storybook
- How to create plugin step by step
- Basic concepts
- How it works
- authentication
- backup
- capabilities
-
files
-
Files
- Add template files
- Change version history
- Check the form draft
- Copy a file
- Create a file
- Create a file in the "My documents" section
- Create a text file in the "My documents" section
- Create a txt file
- Create an HTML file
- Create an HTML file in the "My documents" section
- Create the editing session
- Create thumbnails
- Delete a file
- Delete template files
- Get changes URL
- Get file download link
- Get file download link asynchronously
- Get file information
- Get file properties
- Get file versions
- Get reference data
- Get third-party file information
- Get users with the access to the protected file
- Get version history
- Lock a file
- Open a file
- Restore a file version
- Returns primary external link
- Save file edits
- Save file properties to a file
- Save file properties to files
- Start file editing
- Track file editing
- Update a file
-
Folders
- Create a folder
- Delete a folder
- Get a folder by ID
- Get filtered sections
- Get folder information
- Get new folder items
- Get subfolders
- Get the "My documents" section
- Get the "Private Room" section
- Get the "Trash" section
- Get the folder path
- Insert a file
- Insert a file to the "My documents" section
- Rename a folder
- Upload a file
- Upload a file to the "My documents" section
- Operations
-
Rooms
- Accept an invitation
- Add room tags
- Archive a room
- Create a room
- Create a room logo
- Create a tag
- Create a third-party room
- Delete tags
- Get primary external link
- Get room access rights
- Get room information
- Get room links
- Get rooms
- Get tags
- Pin a room
- Remove a room
- Remove a room logo
- Remove room tags
- Rename a room
- Resend room invitations
- Set an external or invitation link
- Set room access rights
- Unarchive a room
- Unpin a room
- Upload an image for room logo
-
Settings
- Ask a new file name
- Change the ability to store the forcesaved files
- Change the ability to upload original formats
- Change the archive format (using body parameters)
- Change the default access rights
- Change the external sharing ability
- Change the external sharing ability on social networks
- Change the forcasaving ability
- Change the third-party settings access
- Check the document service URL
- Check the Private Room availability
- Confirm the file deletion
- Get file settings
- Get the Documents information
- Get the trash bin auto-clearing setting
- Update a file version if it exists
- Update the trash bin auto-clearing setting
- Third-party integration
-
Files
-
people
- Contacts
- Password
- Photos
-
Profiles
- Add a user
- Delete a user
- Delete my profile
- Delete users
- Get a profile by user email
- Get a profile by user name
- Get my profile
- Get profiles
- Invite users
- Register a Personal account
- Resend activation emails
- Send a notification to change a phone
- Send instructions to change email
- Send the deletion instructions
- Update a user
- Update user language
- Search
- Theme
- Third-party accounts
- User data
- User status
- User type
- portal
- security
-
settings
- Authorization
-
Common settings
- Close the admin helper notification
- Complete the Wizard settings
- Delete a color theme
- Get a color theme
- Get a portal logo
- Get hostname
- Get supporrted languages
- Get the payment settings
- Get the portal settings
- Get the socket settings
- Get time zones
- Save a color theme
- Save the DNS settings
- Save the mail domain settings
- Update the email activation settings
- Cookies
- Custom navigation
- Encryption
- Greeting settings
- IP restrictions
- License
- Login settings
- Messages
- Notifications
- Owner
- Security
- SSO
- Statistics
- Storage
- Team templates
- TFA settings
- Tips
- Webhooks
Step 3. Add plugin icons
Create the assets folder in the root plugin folder and add there all the plugin icons. The number of icons and their sizes will depend on the plugin types you implement. For the speech-to-text plugin, we need the following icons:
-
The default plugin type requires a logo image. It is equal to the logo parameter from the package.json file. The logo will be displayed in the DocSpace plugin settings. The required icon size is 48x48 px. Otherwise, it will be compressed to this size.
-
The context menu plugin uses an icon on the Convert to text button. The required icon size is 16x16 px. Otherwise, it will be compressed to this size.
This icon can be also used for the main button icon. For example, in the draw.io plugin, the same icon is used for the context and main button menu.
The draw.io plugin also uses the specific file icon near the .drawio files, which are created with the file plugin type. The preferred icon size for the table format is 32x32 px.
In this plugin, the same file icon is also used for the tile view. But it is recommended to add another icon of the 96x96 px size in this case.
