Files in Chats: Overview of Methods
To work with files, use the group of methods im.disk.*.
Quick Navigation: All Methods and Events
Method Connections with Other Objects
Chat. File operations are performed using the chat identifier CHAT_ID. You can obtain the identifier by creating a chat with the method im.chat.add or retrieving the chat identifier with im.chat.get.
Drive Files. The methods operate on Drive files using the file identifier in the parameters FILE_ID or UPLOAD_ID. You can obtain the file identifier by retrieving the list of files with disk.folder.getchildren or by uploading a file with disk.folder.uploadfile.
Add a File to a Chat
To add a file to a chat, use the method im.disk.file.commit. Specify the chat identifier CHAT_ID and one of the file identifier parameters: UPLOAD_ID or FILE_ID.
You can add multiple files using an array, for example, FILE_ID: [4837, 4839, 4841].
Save a File to Your Drive
The method im.disk.file.save allows you to save a file from the chat to your personal Drive in the Saved Files folder. If the folder does not exist, the system will create it.
Delete a File
When a file is no longer needed, it can be deleted from the chat folder using the method im.disk.file.delete. In the chat, the text Message deleted will be displayed instead of the file.
Get the Storage Folder for Chat Files
The method im.disk.folder.get retrieves the identifier of the folder where chat files are stored. This identifier can be used in Drive methods, for example:
- upload a file to the chat folder using the method disk.folder.uploadfile,
- view the list of files in the folder using the method disk.folder.getchildren.
Overview of Methods
Scope:
imWho can execute the method: chat participant
|
Method |
Description |
|
Adds a file to the chat |
|
|
Saves a file to your Drive |
|
|
Deletes a file from the chat folder |
|
|
Retrieves the storage folder for chat files |