Class AbstractWorkspace

Namespace

C4.Net

Assembly

C4.Net.Core.dll

Provides the shared metadata and configuration carried by all workspace representations.

[DataContract]
public abstract class AbstractWorkspace

Inheritance

object

AbstractWorkspace

Derived

EncryptedWorkspace

Workspace

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

AbstractWorkspace()

Initializes a workspace shell for serializers and derived types.

public AbstractWorkspace()

AbstractWorkspace(string, string)

Initializes shared workspace metadata and an empty configuration.

public AbstractWorkspace(string name, string description)

Parameters

name string

The workspace name.

description string

A short description of the workspace.

Properties

Configuration

Defines workspace-level access control and collaboration settings.

[DataMember(Name = "configuration", EmitDefaultValue = false)]
public WorkspaceConfiguration Configuration { get; set; }

Property Value

WorkspaceConfiguration

Description

A short description of the workspace.

[DataMember(Name = "description", EmitDefaultValue = false)]
public string Description { get; set; }

Property Value

string

Id

The ID of the workspace.

[DataMember(Name = "id", EmitDefaultValue = false)]
public long Id { get; set; }

Property Value

long

LastModifiedAgent

The name of the agent that was used to last modify this workspace (e.g. "Structurizr for .NET").

[DataMember(Name = "lastModifiedAgent", EmitDefaultValue = false)]
public string LastModifiedAgent { get; set; }

Property Value

string

LastModifiedDate

The last modified date of the workspace.

[DataMember(Name = "lastModifiedDate", EmitDefaultValue = false)]
public DateTime LastModifiedDate { get; set; }

Property Value

DateTime

LastModifiedUser

The name of the user who last modified this workspace (e.g. a username).

[DataMember(Name = "lastModifiedUser", EmitDefaultValue = false)]
public string LastModifiedUser { get; set; }

Property Value

string

Name

The name of the workspace.

[DataMember(Name = "name", EmitDefaultValue = false)]
public string Name { get; set; }

Property Value

string

Revision

The revision number of the workspace.

[DataMember(Name = "revision", EmitDefaultValue = false)]
public long Revision { get; set; }

Property Value

long

Thumbnail

The thumbnail associated with the workspace; a Base64 encoded PNG file as a Data URI (data:image/png;base64).

[DataMember(Name = "thumbnail", EmitDefaultValue = false)]
public string Thumbnail { get; set; }

Property Value

string

The thumbnail associated with the workspace; a Base64 encoded PNG file as a Data URI (data:image/png;base64).

Version

The version of the workspace.

[DataMember(Name = "version", EmitDefaultValue = false)]
public string Version { get; set; }

Property Value

string

Methods

ClearConfiguration()

Removes the workspace configuration from this instance.

public void ClearConfiguration()