Options for deploying a solution item and for creating the solution index item representing the deployment

interface IDeploySolutionOptions {
    additionalTypeKeywords?: string[];
    consoleProgress?: boolean;
    description?: string;
    enableItemReuse?: boolean;
    jobId?: string;
    progressCallback?: ISolutionProgressCallback;
    snippet?: string;
    storageAuthentication?: UserSession;
    storageVersion?: number;
    tags?: string[];
    templateDictionary?: any;
    thumbnail?: File;
    thumbnailurl?: string;
    title?: string;
}

Properties

additionalTypeKeywords?: string[]

Additional typeKeywords (beyond always-added ["Solution", "Deployed"]) to be added to Solution item; default: []

consoleProgress?: boolean

Should progress be echoed to the debugging console? default: false

description?: string

Description to be given to created Solution item; default: copied from solution item

enableItemReuse?: boolean

When true items with source-itemId type keyword will be reused; default: false

jobId?: string

Calling-program-supplied id, perhaps used to distinguish between concurrent deployments or deletions; default: id of solution being deployed

progressCallback?: ISolutionProgressCallback

Packet of supplemental information provided from certain progress states, e.g., Finished deleting an item or deploying a Solution item

snippet?: string

Snippet to be given to created Solution item; default: copied from solution item

storageAuthentication?: UserSession

Credentials for the organization with the source items; default: authentication supplied for deployment destination

storageVersion?: number

Version of storage read from Solution item. DO NOT USE--it is overwritten by function deploySolutionFromTemplate

tags?: string[]

Tags to be given to created Solution item; default: copied from solution item

templateDictionary?: any

Facts to be used for creating the Solution item; default: {}

thumbnail?: File

Thumbnail file to be given to created Solution item; default: null; has priority over thumbnailurl

thumbnailurl?: string

URL to thumbnail to be given to created Solution item, but see thumbnail property; default: copied from solution item

title?: string

Title to be given to deployed Solution item; default: copied from solution item