Attachments

Basic information

Attachments is an object structure which composes different types of items.

+Attachments configuration

This section describes the configuration of attachments sent to the server.

The configuration represents an array of items and implements three actions:

add @AttachmentsAddConfiguration
edit @AttachmentsEditConfiguration
delete @AttachmentsDeleteConfiguration

Attachments Upload Temp File

Some modules can have their own upload_tempfile endpoinst that will return tmpfilename to
use in add configuration with method tmpfile.

@AttachmentsUplTempFileResponse

Attachments configuration parameters vary depending on the type:

images
videos
videorefs
audios
files
polls
links

Example

[
    {
        "action":"add",
        ...parameters depending on the type of attachment...
    },
    {
        "action":"edit",
        "id":3,
        ...parameters depending on the type of attachment...
    },
    {
        "action":"delete",
        "id":2
    }
]

+Attachments structure

This section describes the structure of attachments obtained from the server.

The structure represents an object of substructures describing the following types:

images[]
videos[]
videorefs[]
audios[]
files[]
polls[]
links[]

Example

{
    "images": [{
        "id": 2,
        "user_id": 000,
        "label": "My Picture",
        "filename": "picture.png",
        "url": "http://...",
        "height": 128,
        "width": 128,
        "thumbnail_url": "http://...",
        "thumbnail_height": 227,
        "thumbnail_width": 302,
        "original": {
            "ext": "png",
            "size": 312312,
            "height": 1200,
            "width": 1920,
            "url": "https://..."
        }
    }],
    "videos": [{
        "id": 11,
        "user_id": 256,
        "label": "The best video",
        "filename": "video.mp4",
        "duration": 30.51,
        "original": {
            "ext": "mp4",
            "size": 15430247,
            "url": "http://...",
            "height": 1072,
            "width": 1072,
        },
        "presets": [{
            "label": "480p (mp4)",
            "ext": "mp4",
            "size": 2660887,
            "url": "http://...",
            "height": 480,
            "width": 480
        },
        {
            "label": "720p (mp4)",
            "ext": "mp4",
            "size": 4762231,
            "url": "http://...",
            "height": 720,
            "width": 720
        }],
        "snapshot": {
          "ext": "jpg",
          "width": 1072,
          "height": 1072,
          "url": "http://...",
        }
    }],
    "videorefs": [{
        "id": 3,
        "user_id": 000,
        "label": "Dobby is free!",
        "video_id": "EHPSY3QrgnI",
        "hoster": "youtube",
        "owner": "SirDobby276",
        "owner_id": "UCT4WKI1KIGqhuUUkT5mtdoA",
        "name": "Dobby is free!",
        "descr": "",
        "duration": 136,
        "thumbnail_url": "http://..."
    }],
    "files": [{
        "id": 1,
        "user_id": 000,
        "label": "Real File",
        "filename": "Document.html",
        "ext": "html",
        "size": 98432,
        "url": "http://..."
    }],
    "audios": [{
        "id": 5,
        "user_id": 000,
        "label": "The Best Song Ever",
        "filename": "song.mp3",
        "ext": "mp3",
        "size": 2370437,
        "duration": 118.413,
        "artist": "Jesse Harlin",
        "title": "Vode An (Brothers All)",
        "url": "http://..."
    }]
}