interface MAGES::SceneGraph::Editor::IStoryboardCloudClient¶

Overview¶

Defines editor-side access to a storyboard cloud source. More…

interface IStoryboardCloudClient
{
    // methods

    string LoadBaseUrl();
    TaskStoryboardSummary>> GetStoryboardsAsync(string rawBaseUrl);
    Task GetDomainJsonAsync(string rawBaseUrl, string storyboardId);
    Task GetGraphXmlAsync(string rawBaseUrl, string storyboardId);

    Task<StoryboardSummary> GetStoryboardAsync(
        string rawBaseUrl,
        string storyboardId
    );

    Task<StoryboardSummary> SaveStoryboardAsync(
        string rawBaseUrl,
        string name,
        string storyboardId,
        string graphXml,
        string domainJson,
        string projectDescription = null,
        string catalogJson = null
    );

    Task<StoryboardSummary> InstantiateNeuromonitoringTemplateAsync(
        string rawBaseUrl,
        string name = null,
        string projectDescription = null
    );

    Task<StoryboardSummary> UpdateSyncStateAsync(
        string rawBaseUrl,
        string storyboardId,
        bool unitySyncEnabled
    );
};

Detailed Documentation¶

Defines editor-side access to a storyboard cloud source.

Methods¶

string LoadBaseUrl()

Loads the persisted storyboard API base URL.

Returns:

The saved base URL.

TaskStoryboardSummary>> GetStoryboardsAsync(string rawBaseUrl)

Loads the available storyboards from the configured API.

Parameters:

Returns:

A task that resolves to the sorted storyboard list.

Task GetDomainJsonAsync(string rawBaseUrl, string storyboardId)

Downloads the JSON payload for a storyboard.

Parameters:

Returns:

A task that resolves to the storyboard JSON payload.

Task GetGraphXmlAsync(string rawBaseUrl, string storyboardId)

Downloads the draw.io XML payload for a storyboard.

Parameters:

Returns:

A task that resolves to the storyboard XML payload.

Task<StoryboardSummary> GetStoryboardAsync(
    string rawBaseUrl,
    string storyboardId
)

Loads a storyboard record by identifier.

Parameters:

Returns:

A task that resolves to the storyboard record.

Task<StoryboardSummary> SaveStoryboardAsync(
    string rawBaseUrl,
    string name,
    string storyboardId,
    string graphXml,
    string domainJson,
    string projectDescription = null,
    string catalogJson = null
)

Saves storyboard XML/domain payloads to cloud storage.

Parameters:

Returns:

A task that resolves to the saved storyboard record.

Task<StoryboardSummary> InstantiateNeuromonitoringTemplateAsync(
    string rawBaseUrl,
    string name = null,
    string projectDescription = null
)

Creates a neuromonitoring storyboard from the server-side template.

Parameters:

Returns:

A task that resolves to the created storyboard.

Task<StoryboardSummary> UpdateSyncStateAsync(
    string rawBaseUrl,
    string storyboardId,
    bool unitySyncEnabled
)

Updates the cloud sync state flag for a storyboard.

Parameters:

Returns:

A task that resolves to the updated storyboard.