cloud

The cloud module lets you get information about shared prototypes and design specs.

Example

// Get prototypes data
const cloud = require("cloud");
var sharedArtifacts = cloud.getSharedArtifacts();
var prototypes = sharedArtifacts.filter(artifact => (artifact.type === cloud.ArtifactType.PROTOTYPE));
prototypes.forEach(artifact => {
    console.log("Prototype URL: ", artifact.url);
});

Example

// Get design specs data
const cloud = require("cloud");
var sharedArtifacts = cloud.getSharedArtifacts();
var specs = sharedArtifacts.filter(artifact => (artifact.type === cloud.ArtifactType.SPECS));
specs.forEach(artifact => {
    console.log("Design Spec URL: ", artifact.url);
});

Since: XD 14

• cloud
  • .getSharedArtifacts() ⇒ !Array.<!PrototypeArtifact|SpecsArtifact>

Enums

ArtifactType :

PROTOTYPE, SPECS - Type of shared artifact: interactive prototype only, or developer-focused specs view (which may also include access to an interactive prototype view)

TargetPlatform :

WEB, IOS, ANDROID - Target platform for published design specs

AccessLevel :

LINKABLE, PASSWORD_PROTECTED, INVITE_ONLY - Access level of the shared link: accessible to anyone with the link, anyone with the link + password, or only specific Creative Cloud user accounts

cloud.getSharedArtifacts()

Get a list of recently shared artifacts generated from this document. Older artifacts may not be included even if the shared links are still live. Shared links that have been deleted from the server (File > Manage Published Links) may still be listed here, as this API only provides a record of recent share actions from XD - not what the links' current status on the server may be.

The list may contain a mix of PrototypeArtifact and/or SpecsArtifact, and items are listed in no particular order. If nothing has been shared from this document, an empty array is returned.

Kind: static method of cloud

Returns: !Array.<!PrototypeArtifact|SpecsArtifact>

Typedef BaseSharedArtifact

Properties common to both types.

Typedef PrototypeArtifact

Interactive prototype view generated via "Share for Review."

Typedef SpecsArtifact

Developer-oriented specs view generated via "Share for Development." This may also allow viewing the document as an interactive prototype, with default settings (fullscreenInPage: false and hotspotHints: true).