This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Retrieves a list of galleries.
This function retrieves a list of up to 10 galleries at a given time. To list the next 10 galleries in your site's backend, use the offset
parameter.
function listGalleries(
options: ListGalleriesOptions,
): Promise<ListGalleriesResponse>;
Options to use when getting the list of galleries.
import { proGallery } from "wix-pro-gallery-backend";
export async function myListGalleriesFunction() {
try {
const galleries = await proGallery.listGalleries();
const firstGalleryId = galleries[0]._id;
const secondGalleryName = galleries[1].name;
console.log("Success! Got a list of galleries:", galleries);
return galleries;
} catch (error) {
console.error(error);
// Handle the error
}
}
/* Promise resolves to:
* {
* "galleries": [
* {
* "_createdDate": "Mon Feb 08 2021 13:44:37",
* "_id":"10874ccf-5867-4225-9550-3885079bad66",
* "items": [
* {
* "_createdDate": Tue Mar 30 2021 15:23:22,
* "_id": "534264c7-0c61-45ce-b414-891aacadf4c2",
* "_updatedDate": Tue Mar 30 2021 15:23:22,
* "description": "This is the first item in my gallery.",
* "sortOrder": 1657439075188,
* "tags": {
* "values": ["pickles","salad","burger"]
* },
* "title": "Item 1",
* "type": "VIDEO",
* "video": {
* "type": 'VIMEO',
* "videoInfo": 'https://vimeo.com/322240916',
* "duration": 5000
* }
* },
* {
* "_createdDate": Sun Jul 03 2022 12:05:15,
* "_id": "4507a07b-ab93-4326-a222-6d0bd8da0625",
* "_updatedDate": Tues Jul 05 2022 10:25:45,
* "description": "This is the second item in my gallery.",
* "sortOrder": 1857439076299,
* "title": "Item 2",
* "type": "IMAGE",
* "image": {
* "imageInfo": "wix:image://v1/25139f9568b74d8aac6286c9ac1e8186.jpg/25139f9568b74d8aac6286c9ac1e8186.jpg#originWidth=4000&originHeight=2667"
* }
* }
* ],
* "name": "My First Gallery",
* "sortOrder": "1098567432145",
* "totalItems": 2
* },
* {
* "_createdDate": "Mon Feb 08 2021 13:44:37",
* "_id":"10874ccf-5867-4225-9550-3885079bad66",
* "items": [
* {
* "_createdDate": Tues Jul 05 2022 08:02:37,
* "_id": "2297a07b-ab93-4326-a222-6d0bd8da0625",
* "_updatedDate": Tues Jul 05 2022 10:25:45,
* "description": "This is the second item in my gallery.",
* "sortOrder": 1857439076299,
* "title": "My only item",
* "type": "VIDEO",
* "video": {
* "type": 'YOUTUBE',
* "videoInfo": 'https://www.youtube.com/results?search_query=uplifting+upbeat+music',
* "duration": 2000
* }
* }
* ],
* "name": "My Second Gallery",
* "sortOrder": "5568837432149",
* "totalItems": 1
* }
* ],
* "totalGalleries": 2
* }
*/
This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.