Get Started
- Overview
- Basic concepts
- Passing authentication
- authentication
- backup
- capabilities
- feed
-
files
-
Files
- Add a file to the "Recent" section
- 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 "Common" section
- Create a text file in the "My documents" section
- Create a txt file
- Create an HTML file
- Create an HTML file in the "Common" section
- 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 version history
- Lock a file
- Open a file
- Restore a file version
- 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 "Common" section
- Get the "In projects" section
- Get the "My documents" section
- Get the "Private Room" section
- Get the "Recent" section
- Get the "Shared with me" section
- Get the "Templates" section
- Get the "Trash" section
- Get the folder path
- Insert a file
- Insert a file to the "Common" section
- Insert a file to the "My documents" section
- Rename a folder
- Upload a file
- Upload a file to the "Common" section
- 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 room access rights
- Get room information
- 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 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 auto-clearing setting properties
- Get the Documents information
- Update a file version if it exists
- Update the trash bin auto-clearing setting
- Sharing
- Third-party integration
-
Files
- group
-
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
- Quota
- 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
- LDAP
- License
- Login settings
- Messages
- Notifications
- Owner
- Quota
- Security
- SSO
- Statistics
- Storage
- Team templates
- Telegram
- TFA settings
- Tips
- Versions
- Webhooks
- thirdparty
JavaScript SDK
API backend
API system
More information
Viewer
Allows you to open the SDK as a document editor for viewing by specifying the id parameter for a file.
Method
| Name | Description |
| initViewer | Initializes the SDK frame in the "viewer" mode. |
var docSpace = new DocSpace.SDK.initViewer({config});