@vertigis/viewer-spec/messaging/schema/web-project-operation-definitions.md

VertiGIS Viewer Specification

# operation: project.create
Description: Creates app config for a project, based on the current state of the application. Web only.

Inputs: `unknown`

Outputs: `( AppConfig | HasAppConfig )`

---
# operation: project.get-share-link
Description: Returns a url share link for the provided Shared Project. Web only.

Inputs: `SharedProject`

SharedProject properties:
```json
{
  "created": {
    "description": "The created Date.",
    "isRequired": "true"
  },
  "description": {
    "description": "A description for the shared project.",
    "type": "string",
    "isRequired": "true"
  },
  "hiddenFrom": {
    "description": "Filters that determine whether the UI element is hidden from a given end-user. If both visibleTo and hiddenFrom are undefined/empty, the component will be visible to all users."
  },
  "id": {
    "description": "The unique ID for this entity.",
    "type": "string",
    "isRequired": "true"
  },
  "modified": {
    "description": "The modified Date."
  },
  "modifiedBy": {
    "description": "The username of the last modifier."
  },
  "owner": {
    "description": "The username of the owner."
  },
  "readOnly": {
    "description": "Indicates if the shared project is shared as 'read only'.",
    "type": "boolean"
  },
  "title": {
    "description": "A human-readable title for the shared project.",
    "type": "string",
    "isRequired": "true"
  },
  "visibleTo": {
    "description": "Filters that determine whether the UI element is visible to a given end-user. If both visibleTo and hiddenFrom are undefined/empty, the component will be visible to all users."
  }
}
```

Outputs: `string`

---
# operation: project.get-shared
Description: Returns a list of Shared Projects. Web only.

Inputs: `None`

Outputs: `SharedProject[]`

---
# operation: project.get-shared-content
Description: Returns a Shared Project Content. Web only.

Inputs: `SharedProject`

SharedProject properties:
```json
{
  "created": {
    "description": "The created Date.",
    "isRequired": "true"
  },
  "description": {
    "description": "A description for the shared project.",
    "type": "string",
    "isRequired": "true"
  },
  "hiddenFrom": {
    "description": "Filters that determine whether the UI element is hidden from a given end-user. If both visibleTo and hiddenFrom are undefined/empty, the component will be visible to all users."
  },
  "id": {
    "description": "The unique ID for this entity.",
    "type": "string",
    "isRequired": "true"
  },
  "modified": {
    "description": "The modified Date."
  },
  "modifiedBy": {
    "description": "The username of the last modifier."
  },
  "owner": {
    "description": "The username of the owner."
  },
  "readOnly": {
    "description": "Indicates if the shared project is shared as 'read only'.",
    "type": "boolean"
  },
  "title": {
    "description": "A human-readable title for the shared project.",
    "type": "string",
    "isRequired": "true"
  },
  "visibleTo": {
    "description": "Filters that determine whether the UI element is visible to a given end-user. If both visibleTo and hiddenFrom are undefined/empty, the component will be visible to all users."
  }
}
```

Outputs: `HasAppConfig`

---