Handle Image Selection on SharinPix Album (Developer-Oriented)

Overview

The updateAlbumSelection method lets you handle image selection within the SharinPix Album Component without requiring manual user interaction.

Prerequisites

Before implementing it, ensure your Salesforce environment meets the following requirements:

• Package Version: Ensure you have the latest SharinPix Package installed. Follow this guide to upgrade your SharinPix Managed Package to the latest version.
• Permissions: Users must have the SharinPix Lightning Components permission set assigned. For more information on permission sets, check SharinPix Permission Sets.

Method Signature

updateAlbumSelection(imageIds)

Parameters

Parameter	Type	Description
imageIds	Array of String	An array of SharinPix Public Image IDs to select. Note: To clear all current selections, pass an empty array.

Setup

To use the updateAlbumSelection method, you must implement the SharinPix Album (LWC) as a child component within your own custom Lightning Web Component.

The recommended approach is to create an 'Album Wrapper' component that encapsulates the SharinPix Album (LWC).

Sample Album Wrapper component:

<!-- albumWrapper.html -->
<template>
        <c-album
            lwc:ref="album"
            record-id={recordId}
            album-id={albumId}
            height={height}>
        </c-album>
</template>

// albumWrapper.js
import { LightningElement, api } from 'lwc'
export default class AlbumWrapper extends LightningElement {
    @api recordId
    @api albumId
    @api height = 500
    // Define the IDs of the images you want to select.
    samplePublicImageIds = ['id1', 'id2', 'id3'] //You can also pass an empty array [] to clear all selections

    selectImages() {
        this.refs.album?.updateAlbumSelection(this.samplePublicImageIds)
    }
}

When updateAlbumSelection(this.samplePublicImageIds) is invoked, the images with the IDs that were passed in the array will be selected in the SharinPix Album (LWC).

Important Notes

• Parameter Validation: Only valid string SharinPix Image Public IDs are processed. Non-string values and empty strings are automatically filtered.
• Null handling: Passing null is treated as an empty array.