Foundry Virtual Tabletop - API Documentation - Version 14
    Preparing search index...

    Interface ShareImageConfig

    interface ShareImageConfig {
        image: string;
        showTitle?: boolean;
        title: string;
        users?: string[];
        uuid?: string;
    }
    Index

    Properties

    image: string

    The image URL to share.

    showTitle?: boolean

    If this is provided, the permissions of the related Document will be ignored and the title will be shown based on this parameter.

    title: string

    The image title.

    users?: string[]

    A list of user IDs to show the image to.

    uuid?: string

    The UUID of a foundry.abstract.Document related to the image, used to determine permission to see the image title.