huanld/speckle-unity
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Bump Core Deps to 2.20 (#120)

Browse Source 
* Bump Sdk

* Fixed compiler errors
This commit is contained in:
Jedd Morgan
2024-08-08 14:31:07 +01:00
committed by GitHub
parent 2da9c917c9
commit 9cc1c1f6bf
11 changed files with 627 additions and 339 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Assets/Extra/ManualReceive.cs
+1
View File
@@ -3,6 +3,7 @@ using System.Threading.Tasks;
using Speckle.ConnectorUnity;
using Speckle.ConnectorUnity.Components;
using Speckle.Core.Api;
using Speckle.Core.Api.GraphQL.Models;
using Speckle.Core.Credentials;
using Speckle.Core.Models;
using Speckle.Core.Transports;
Packages/systems.speckle.speckle-unity/Editor/Components/StreamManagerEditor.cs
+6 -10
View File
@@ -2,7 +2,6 @@ using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using Sentry;
using Speckle.Core.Api;
using Speckle.Core.Credentials;
using Speckle.Core.Kits;
@@ -234,18 +233,15 @@ namespace Speckle.ConnectorUnity.Components.Editor
new CommitReceivedInput
{
streamId = SelectedStream.id,
commitId = Branches[SelectedBranchIndex].commits.items[
SelectedCommitIndex
].id,
commitId = Branches[SelectedBranchIndex]
.commits
.items[SelectedCommitIndex]
.id,
message = $"received commit from {HostApplications.Unity.Name} Editor",
sourceApplication = HostApplications.Unity.Name
}
);
}
catch (Exception e)
{
throw new SpeckleException(e.Message, e, true, SentryLevel.Error);
}
finally
{
EditorApplication.delayCall += EditorUtility.ClearProgressBar;
@@ -384,8 +380,8 @@ namespace Speckle.ConnectorUnity.Components.Editor
SelectedCommitIndex = EditorGUILayout.Popup(
"Commits",
SelectedCommitIndex,
Branches[SelectedBranchIndex].commits.items
.Select(x => $"{x.message} - {x.id}")
Branches[SelectedBranchIndex]
.commits.items.Select(x => $"{x.message} - {x.id}")
.ToArray(),
GUILayout.Height(20),
GUILayout.ExpandWidth(true)
Packages/systems.speckle.speckle-unity/Runtime/Components/Deprecated/Receiver.cs
+52 -69
View File
@@ -1,9 +1,4 @@
using Speckle.Core.Api;
using Speckle.Core.Api.SubscriptionModels;
using Speckle.Core.Credentials;
using Speckle.Core.Logging;
using Speckle.Core.Transports;
using System;
using System;
using System.Collections.Concurrent;
using System.Collections.Generic;
using System.Linq;
@@ -11,7 +6,12 @@ using System.Threading.Tasks;
using Sentry;
using Speckle.ConnectorUnity.Components;
using Speckle.ConnectorUnity.Utils;
using Speckle.Core.Api;
using Speckle.Core.Api.SubscriptionModels;
using Speckle.Core.Credentials;
using Speckle.Core.Kits;
using Speckle.Core.Logging;
using Speckle.Core.Transports;
using UnityEngine;
namespace Speckle.ConnectorUnity
@@ -91,23 +91,16 @@ namespace Speckle.ConnectorUnity
Task.Run(async () =>
{
try
{
var mainBranch = await Client.BranchGet(StreamId, BranchName, 1);
if (!mainBranch.commits.items.Any())
throw new Exception("This branch has no commits");
var commit = mainBranch.commits.items[0];
GetAndConvertObject(
commit.referencedObject,
commit.id,
commit.sourceApplication,
commit.authorId
);
}
catch (Exception e)
{
throw new SpeckleException(e.Message, e, true, SentryLevel.Error);
}
var mainBranch = await Client.BranchGet(StreamId, BranchName, 1);
if (!mainBranch.commits.items.Any())
throw new Exception("This branch has no commits");
var commit = mainBranch.commits.items[0];
GetAndConvertObject(
commit.referencedObject,
commit.id,
commit.sourceApplication,
commit.authorId
);
});
}
@@ -135,56 +128,46 @@ namespace Speckle.ConnectorUnity
string authorId
)
{
try
{
var transport = new ServerTransport(Client.Account, StreamId);
var @base = await Operations.Receive(
objectId,
remoteTransport: transport,
onErrorAction: OnErrorAction,
onProgressAction: OnProgressAction,
onTotalChildrenCountKnown: OnTotalChildrenCountKnown,
disposeTransports: true
);
var transport = new ServerTransport(Client.Account, StreamId);
var @base = await Operations.Receive(
objectId,
remoteTransport: transport,
onErrorAction: OnErrorAction,
onProgressAction: OnProgressAction,
onTotalChildrenCountKnown: OnTotalChildrenCountKnown,
disposeTransports: true
);
Analytics.TrackEvent(
Client.Account,
Analytics.Events.Receive,
new Dictionary<string, object>()
Analytics.TrackEvent(
Client.Account,
Analytics.Events.Receive,
new Dictionary<string, object>()
{
{ "mode", nameof(Receiver) },
{
{ "mode", nameof(Receiver) },
{
"sourceHostApp",
HostApplications.GetHostAppFromString(sourceApplication).Slug
},
{ "sourceHostAppVersion", sourceApplication ?? "" },
{ "hostPlatform", Application.platform.ToString() },
{
"isMultiplayer",
authorId != null && authorId != Client.Account.userInfo.id
},
}
);
"sourceHostApp",
HostApplications.GetHostAppFromString(sourceApplication).Slug
},
{ "sourceHostAppVersion", sourceApplication ?? "" },
{ "hostPlatform", Application.platform.ToString() },
{ "isMultiplayer", authorId != null && authorId != Client.Account.userInfo.id },
}
);
Dispatcher
.Instance()
.Enqueue(() =>
{
var root = new GameObject() { name = commitId, };
Dispatcher
.Instance()
.Enqueue(() =>
{
var root = new GameObject() { name = commitId, };
var rc = GetComponent<RecursiveConverter>();
var go = rc.RecursivelyConvertToNative(@base, root.transform);
//remove previously received object
if (DeleteOld && ReceivedData != null)
Destroy(ReceivedData);
ReceivedData = root;
OnDataReceivedAction?.Invoke(root);
});
}
catch (Exception e)
{
throw new SpeckleException(e.Message, e, true, SentryLevel.Error);
}
var rc = GetComponent<RecursiveConverter>();
var go = rc.RecursivelyConvertToNative(@base, root.transform);
//remove previously received object
if (DeleteOld && ReceivedData != null)
Destroy(ReceivedData);
ReceivedData = root;
OnDataReceivedAction?.Invoke(root);
});
try
{
Packages/systems.speckle.speckle-unity/Runtime/Components/Deprecated/Sender.cs
+29 -37
View File
@@ -1,16 +1,16 @@
using Speckle.Core.Api;
using Speckle.Core.Credentials;
using Speckle.Core.Logging;
using Speckle.Core.Models;
using Speckle.Core.Transports;
using System;
using System;
using System.Collections.Concurrent;
using System.Collections.Generic;
using System.Threading;
using System.Threading.Tasks;
using Sentry;
using Speckle.ConnectorUnity.Components;
using Speckle.Core.Api;
using Speckle.Core.Credentials;
using Speckle.Core.Kits;
using Speckle.Core.Logging;
using Speckle.Core.Models;
using Speckle.Core.Transports;
using UnityEngine;
using UnityEngine.SceneManagement;
@@ -46,7 +46,6 @@ namespace Speckle.ConnectorUnity
/// <param name="onDataSentAction">Action to run after the data has been sent</param>
/// <param name="onProgressAction">Action to run when there is download/conversion progress</param>
/// <param name="onErrorAction">Action to run on error</param>
/// <exception cref="SpeckleException"></exception>
public void Send(
string streamId,
ISet<GameObject> gameObjects,
@@ -58,39 +57,32 @@ namespace Speckle.ConnectorUnity
Action<string, Exception>? onErrorAction = null
)
{
try
{
CancelOperations();
CancelOperations();
cancellationTokenSource = new CancellationTokenSource();
cancellationTokenSource = new CancellationTokenSource();
var client = new Client(account ?? AccountManager.GetDefaultAccount()!);
transport = new ServerTransport(client.Account, streamId);
transport.CancellationToken = cancellationTokenSource.Token;
var client = new Client(account ?? AccountManager.GetDefaultAccount()!);
transport = new ServerTransport(client.Account, streamId);
transport.CancellationToken = cancellationTokenSource.Token;
var rootObjects = SceneManager.GetActiveScene().GetRootGameObjects();
var rootObjects = SceneManager.GetActiveScene().GetRootGameObjects();
var data = converter.RecursivelyConvertToSpeckle(
rootObjects,
o => gameObjects.Contains(o)
);
var data = converter.RecursivelyConvertToSpeckle(
rootObjects,
o => gameObjects.Contains(o)
);
SendData(
transport,
data,
client,
branchName,
createCommit,
cancellationTokenSource.Token,
onDataSentAction,
onProgressAction,
onErrorAction
);
}
catch (Exception e)
{
throw new SpeckleException(e.ToString(), e, true, SentryLevel.Error);
}
SendData(
transport,
data,
client,
branchName,
createCommit,
cancellationTokenSource.Token,
onDataSentAction,
onProgressAction,
onErrorAction
);
}
public static void SendData(
@@ -125,7 +117,6 @@ namespace Speckle.ConnectorUnity
long count = data.GetTotalChildrenCount();
await client.CommitCreate(
cancellationToken,
new CommitCreateInput
{
streamId = remoteTransport.StreamId,
@@ -134,7 +125,8 @@ namespace Speckle.ConnectorUnity
message = $"Sent {count} objects from Unity",
sourceApplication = HostApplications.Unity.Name,
totalChildrenCount = (int)count,
}
},
cancellationToken
);
}
Packages/systems.speckle.speckle-unity/Runtime/Components/ReceiveFromURL.cs
+1
View File
@@ -4,6 +4,7 @@ using System.Linq;
using System.Threading;
using System.Threading.Tasks;
using Speckle.Core.Api;
using Speckle.Core.Api.GraphQL.Models;
using Speckle.Core.Credentials;
using Speckle.Core.Logging;
using Speckle.Core.Models;
Packages/systems.speckle.speckle-unity/Runtime/Core/SpeckleCore2.dll
BIN
View File
Binary file not shown.
Packages/systems.speckle.speckle-unity/Runtime/Core/SpeckleCore2.pdb
BIN
View File
Binary file not shown.
Packages/systems.speckle.speckle-unity/Runtime/Core/SpeckleCore2.xml
+478 -84
View File
@@ -9,17 +9,22 @@
Base class for GraphQL API exceptions
</summary>
</member>
<member name="T:Speckle.Core.Api.SpeckleGraphQLForbiddenException`1">
<member name="T:Speckle.Core.Api.SpeckleGraphQLForbiddenException">
<summary>
Represents a "FORBIDDEN" on "UNAUTHORIZED" GraphQL error as an exception.
https://www.apollographql.com/docs/apollo-server/v2/data/errors/#unauthenticated
https://www.apollographql.com/docs/apollo-server/v2/data/errors/#forbidden
</summary>
</member>
<member name="M:Speckle.Core.Api.Client.#ctor(Speckle.Core.Credentials.Account)">
<param name="account"></param>
<exception cref="T:System.ArgumentException"><paramref name="account"/> was null</exception>
</member>
<member name="M:Speckle.Core.Api.Client.ExecuteGraphQLRequest``1(GraphQL.GraphQLRequest,System.Threading.CancellationToken)">
<exception cref="T:Speckle.Core.Api.SpeckleGraphQLForbiddenException`1">"FORBIDDEN" on "UNAUTHORIZED" response from server</exception>
<exception cref="T:Speckle.Core.Api.SpeckleGraphQLException`1">All other request errors</exception>
<exception cref="T:System.OperationCanceledException">The <paramref name="cancellationToken"/> requested a cancel</exception>
<inheritdoc/>
</member>
<member name="M:Speckle.Core.Api.Client.SubscribeTo``1(GraphQL.GraphQLRequest,System.Action{System.Object,``0})">
<inheritdoc cref="M:Speckle.Core.Api.GraphQL.ISpeckleGraphQLClient.SubscribeTo``1(GraphQL.GraphQLRequest,System.Action{System.Object,``0})"/>
</member>
<member name="M:Speckle.Core.Api.Client.StreamGetActivity(System.String,System.Nullable{System.DateTime},System.Nullable{System.DateTime},System.Nullable{System.DateTime},System.String,System.Int32,System.Threading.CancellationToken)">
<summary>
@@ -42,6 +47,8 @@
<param name="streamId">Id of the stream to get the branches from</param>
<param name="commitsLimit">Max number of commits to retrieve</param>
<returns></returns>
<seealso cref="M:Speckle.Core.Api.GraphQL.Resources.ProjectResource.GetWithModels(System.String,System.Int32,System.String,Speckle.Core.Api.GraphQL.Inputs.ProjectModelsFilter,System.Threading.CancellationToken)"/>
<seealso cref="M:Speckle.Core.Api.GraphQL.Resources.ModelResource.GetModels(System.String,System.Int32,System.String,Speckle.Core.Api.GraphQL.Inputs.ProjectModelsFilter,System.Threading.CancellationToken)"/>
</member>
<member name="M:Speckle.Core.Api.Client.StreamGetBranches(System.String,System.Int32,System.Int32,System.Threading.CancellationToken)">
<summary>
@@ -52,6 +59,8 @@
<param name="commitsLimit">Max number of commits to retrieve</param>
<param name="cancellationToken"></param>
<returns></returns>
<seealso cref="M:Speckle.Core.Api.GraphQL.Resources.ProjectResource.GetWithModels(System.String,System.Int32,System.String,Speckle.Core.Api.GraphQL.Inputs.ProjectModelsFilter,System.Threading.CancellationToken)"/>
<seealso cref="M:Speckle.Core.Api.GraphQL.Resources.ModelResource.GetModels(System.String,System.Int32,System.String,Speckle.Core.Api.GraphQL.Inputs.ProjectModelsFilter,System.Threading.CancellationToken)"/>
</member>
<member name="M:Speckle.Core.Api.Client.BranchCreate(Speckle.Core.Api.BranchCreateInput,System.Threading.CancellationToken)">
<summary>
@@ -60,6 +69,7 @@
<param name="branchInput"></param>
<param name="cancellationToken"></param>
<returns>The branch id.</returns>
<seealso cref="M:Speckle.Core.Api.GraphQL.Resources.ModelResource.Create(Speckle.Core.Api.GraphQL.Inputs.CreateModelInput,System.Threading.CancellationToken)"/>
</member>
<member name="M:Speckle.Core.Api.Client.BranchGet(System.String,System.String,System.Int32,System.Threading.CancellationToken)">
<summary>
@@ -69,6 +79,9 @@
<param name="branchName">Name of the branch to get</param>
<param name="cancellationToken"></param>
<returns>The requested branch</returns>
<remarks>Updated to Model.GetWithVersions</remarks>
<seealso cref="M:Speckle.Core.Api.GraphQL.Resources.ModelResource.Get(System.String,System.String,System.Threading.CancellationToken)"/>
<seealso cref="M:Speckle.Core.Api.GraphQL.Resources.ModelResource.GetWithVersions(System.String,System.String,System.Int32,System.String,Speckle.Core.Api.GraphQL.Inputs.ModelVersionsFilter,System.Threading.CancellationToken)"/>
</member>
<member name="M:Speckle.Core.Api.Client.ModelGet(System.String,System.String,System.Threading.CancellationToken)">
<summary>
@@ -78,6 +91,7 @@
<param name="projectId">Id of the project to get the model from</param>
<param name="modelId">Id of the model</param>
<returns></returns>
<seealso cref="M:Speckle.Core.Api.GraphQL.Resources.ModelResource.Get(System.String,System.String,System.Threading.CancellationToken)"/>
</member>
<member name="M:Speckle.Core.Api.Client.BranchUpdate(Speckle.Core.Api.BranchUpdateInput,System.Threading.CancellationToken)">
<summary>
@@ -85,6 +99,7 @@
</summary>
<param name="branchInput"></param>
<returns>The stream's id.</returns>
<seealso cref="M:Speckle.Core.Api.GraphQL.Resources.ModelResource.Update(Speckle.Core.Api.GraphQL.Inputs.UpdateModelInput,System.Threading.CancellationToken)"/>
</member>
<member name="M:Speckle.Core.Api.Client.BranchDelete(Speckle.Core.Api.BranchDeleteInput,System.Threading.CancellationToken)">
<summary>
@@ -93,6 +108,7 @@
<param name="branchInput"></param>
<param name="cancellationToken"></param>
<returns></returns>
<seealso cref="M:Speckle.Core.Api.GraphQL.Resources.ModelResource.Delete(Speckle.Core.Api.GraphQL.Inputs.DeleteModelInput,System.Threading.CancellationToken)"/>
</member>
<member name="M:Speckle.Core.Api.Client.StreamGetComments(System.String,System.Int32,System.String,System.Threading.CancellationToken)">
<summary>
@@ -103,6 +119,7 @@
<param name="cursor">Time to filter the comments with</param>
<param name="cancellationToken"></param>
<returns></returns>
<seealso cref="M:Speckle.Core.Api.GraphQL.Resources.CommentResource.GetProjectComments(System.String,System.Int32,System.String,Speckle.Core.Api.GraphQL.Inputs.ProjectCommentsFilter,System.Int32,System.String,System.Threading.CancellationToken)"/>
</member>
<member name="M:Speckle.Core.Api.Client.StreamGetCommentScreenshot(System.String,System.String,System.Threading.CancellationToken)">
<summary>
@@ -112,6 +129,7 @@
<param name="streamId">Id of the stream to get the comment from</param>
<param name="cancellationToken"></param>
<returns></returns>
<seealso cref="M:Speckle.Core.Api.GraphQL.Resources.CommentResource.GetProjectComments(System.String,System.Int32,System.String,Speckle.Core.Api.GraphQL.Inputs.ProjectCommentsFilter,System.Int32,System.String,System.Threading.CancellationToken)"/>
</member>
<member name="M:Speckle.Core.Api.Client.CommitGet(System.String,System.String,System.Threading.CancellationToken)">
<summary>
@@ -121,6 +139,7 @@
<param name="commitId">Id of the commit to get</param>
<param name="cancellationToken"></param>
<returns></returns>
<seealso cref="M:Speckle.Core.Api.GraphQL.Resources.VersionResource.Get(System.String,System.String,System.String,System.Threading.CancellationToken)"/>
</member>
<member name="M:Speckle.Core.Api.Client.StreamGetCommits(System.String,System.Int32,System.Threading.CancellationToken)">
<summary>
@@ -130,6 +149,7 @@
<param name="limit">Max number of commits to get</param>
<param name="cancellationToken"></param>
<returns>The requested commits</returns>
<seealso cref="M:Speckle.Core.Api.GraphQL.Resources.VersionResource.GetVersions(System.String,System.String,System.Int32,System.String,Speckle.Core.Api.GraphQL.Inputs.ModelVersionsFilter,System.Threading.CancellationToken)"/>
</member>
<member name="M:Speckle.Core.Api.Client.CommitCreate(Speckle.Core.Api.CommitCreateInput,System.Threading.CancellationToken)">
<summary>
@@ -137,6 +157,7 @@
</summary>
<param name="commitInput"></param>
<returns>The commit id.</returns>
<seealso cref="M:Speckle.Core.Api.GraphQL.Resources.VersionResource.Create(Speckle.Core.Api.CommitCreateInput,System.Threading.CancellationToken)"/>
</member>
<member name="M:Speckle.Core.Api.Client.CommitUpdate(Speckle.Core.Api.CommitUpdateInput,System.Threading.CancellationToken)">
<summary>
@@ -145,6 +166,7 @@
<param name="commitInput"></param>
<param name="cancellationToken"></param>
<returns>The stream's id.</returns>
<seealso cref="M:Speckle.Core.Api.GraphQL.Resources.VersionResource.Update(Speckle.Core.Api.GraphQL.Inputs.UpdateVersionInput,System.Threading.CancellationToken)"/>
</member>
<member name="M:Speckle.Core.Api.Client.CommitDelete(Speckle.Core.Api.CommitDeleteInput,System.Threading.CancellationToken)">
<summary>
@@ -153,6 +175,7 @@
<param name="commitInput"></param>
<param name="cancellationToken"></param>
<returns></returns>
<seealso cref="M:Speckle.Core.Api.GraphQL.Resources.VersionResource.Delete(Speckle.Core.Api.GraphQL.Inputs.DeleteVersionsInput,System.Threading.CancellationToken)"/>
</member>
<member name="M:Speckle.Core.Api.Client.CommitReceived(Speckle.Core.Api.CommitReceivedInput,System.Threading.CancellationToken)">
<summary>
@@ -162,6 +185,7 @@
<param name="commitReceivedInput"></param>
<param name="cancellationToken"></param>
<returns></returns>
<seealso cref="M:Speckle.Core.Api.GraphQL.Resources.VersionResource.Received(Speckle.Core.Api.CommitReceivedInput,System.Threading.CancellationToken)"/>
</member>
<member name="M:Speckle.Core.Api.Client.ObjectGet(System.String,System.String,System.Threading.CancellationToken)">
<summary>
@@ -181,27 +205,12 @@
<param name="cancellationToken"></param>
<returns></returns>
</member>
<member name="M:Speckle.Core.Api.Client.StreamGrantPermission(Speckle.Core.Api.StreamPermissionInput)">
<summary>
Grants permissions to a user on a given stream.
</summary>
<param name="permissionInput"></param>
<returns></returns>
</member>
<member name="M:Speckle.Core.Api.Client.StreamGrantPermission(System.Threading.CancellationToken,Speckle.Core.Api.StreamPermissionInput)">
<summary>
Grants permissions to a user on a given stream.
</summary>
<param name="cancellationToken"></param>
<param name="permissionInput"></param>
<returns></returns>
</member>
<member name="M:Speckle.Core.Api.Client.GetServerVersion(System.Threading.CancellationToken)">
<summary>
Gets the version of the current server. Useful for guarding against unsupported api calls on newer or older servers.
</summary>
<param name="cancellationToken">[Optional] defaults to an empty cancellation token</param>
<returns><see cref="T:Speckle.Core.Api.Version"/> object excluding any strings (eg "2.7.2-alpha.6995" becomes "2.7.2.6995")</returns>
<returns><see cref="P:Speckle.Core.Api.Client.Version"/> object excluding any strings (eg "2.7.2-alpha.6995" becomes "2.7.2.6995")</returns>
<exception cref="T:Speckle.Core.Logging.SpeckleException"></exception>
</member>
<member name="M:Speckle.Core.Api.Client.IsStreamAccessible(System.String,System.Threading.CancellationToken)">
@@ -221,6 +230,8 @@
<param name="branchesLimit">Max number of branches to retrieve</param>
<param name="cancellationToken"></param>
<returns></returns>
<seealso cref="M:Speckle.Core.Api.GraphQL.Resources.ProjectResource.Get(System.String,System.Threading.CancellationToken)"/>
<seealso cref="M:Speckle.Core.Api.GraphQL.Resources.ProjectResource.GetWithModels(System.String,System.Int32,System.String,Speckle.Core.Api.GraphQL.Inputs.ProjectModelsFilter,System.Threading.CancellationToken)"/>
</member>
<member name="M:Speckle.Core.Api.Client.StreamsGet(System.Int32,System.Threading.CancellationToken)">
<summary>
@@ -229,6 +240,7 @@
<param name="limit">Max number of streams to return</param>
<param name="cancellationToken"></param>
<returns></returns>
<seealso cref="M:Speckle.Core.Api.GraphQL.Resources.ActiveUserResource.GetProjects(System.Int32,System.String,Speckle.Core.Api.GraphQL.Inputs.UserProjectsFilter,System.Threading.CancellationToken)"/>
</member>
<member name="M:Speckle.Core.Api.Client.FavoriteStreamsGet(System.Int32,System.Threading.CancellationToken)">
<summary>
@@ -246,6 +258,7 @@
<param name="limit">Max number of streams to return</param>
<param name="cancellationToken"></param>
<returns></returns>
<seealso cref="M:Speckle.Core.Api.GraphQL.Resources.ActiveUserResource.GetProjects(System.Int32,System.String,Speckle.Core.Api.GraphQL.Inputs.UserProjectsFilter,System.Threading.CancellationToken)"/>
</member>
<member name="M:Speckle.Core.Api.Client.StreamCreate(Speckle.Core.Api.StreamCreateInput,System.Threading.CancellationToken)">
<summary>
@@ -254,6 +267,7 @@
<param name="streamInput"></param>
<param name="cancellationToken"></param>
<returns>The stream's id.</returns>
<seealso cref="M:Speckle.Core.Api.GraphQL.Resources.ProjectResource.Create(Speckle.Core.Api.GraphQL.Inputs.ProjectCreateInput,System.Threading.CancellationToken)"/>
</member>
<member name="M:Speckle.Core.Api.Client.StreamUpdate(Speckle.Core.Api.StreamUpdateInput,System.Threading.CancellationToken)">
<summary>
@@ -262,6 +276,7 @@
<param name="streamInput">Note: the id field needs to be a valid stream id.</param>
<param name="cancellationToken"></param>
<returns>The stream's id.</returns>
<seealso cref="M:Speckle.Core.Api.GraphQL.Resources.ProjectResource.Update(Speckle.Core.Api.GraphQL.Inputs.ProjectUpdateInput,System.Threading.CancellationToken)"/>
</member>
<member name="M:Speckle.Core.Api.Client.StreamDelete(System.String,System.Threading.CancellationToken)">
<summary>
@@ -270,6 +285,7 @@
<param name="id">Id of the stream to be deleted</param>
<param name="cancellationToken"></param>
<returns></returns>
<seealso cref="M:Speckle.Core.Api.GraphQL.Resources.ProjectResource.Delete(System.String,System.Threading.CancellationToken)"/>
</member>
<member name="M:Speckle.Core.Api.Client.StreamRevokePermission(Speckle.Core.Api.StreamRevokePermissionInput,System.Threading.CancellationToken)">
<summary>
@@ -287,6 +303,7 @@
<param name="cancellationToken"></param>
<returns></returns>
<exception cref="T:Speckle.Core.Logging.SpeckleException"></exception>
<seealso cref="M:Speckle.Core.Api.GraphQL.Resources.ProjectResource.UpdateRole(Speckle.Core.Api.GraphQL.Inputs.ProjectUpdateRoleInput,System.Threading.CancellationToken)"/>
</member>
<member name="M:Speckle.Core.Api.Client.StreamGetPendingCollaborators(System.String,System.Threading.CancellationToken)">
<summary>
@@ -296,6 +313,7 @@
<param name="streamId"></param>
<param name="cancellationToken"></param>
<returns></returns>
<seealso cref="M:Speckle.Core.Api.GraphQL.Resources.ProjectResource.GetWithTeam(System.String,System.Threading.CancellationToken)"/>
</member>
<member name="M:Speckle.Core.Api.Client.StreamInviteCreate(Speckle.Core.Api.StreamInviteCreateInput,System.Threading.CancellationToken)">
<summary>
@@ -304,6 +322,7 @@
<param name="inviteCreateInput"></param>
<param name="cancellationToken"></param>
<returns></returns>
<seealso cref="M:Speckle.Core.Api.GraphQL.Resources.ProjectInviteResource.Create(System.String,Speckle.Core.Api.GraphQL.Inputs.ProjectInviteCreateInput,System.Threading.CancellationToken)"/>
</member>
<member name="M:Speckle.Core.Api.Client.StreamInviteCancel(System.String,System.String,System.Threading.CancellationToken)">
<summary>
@@ -313,6 +332,7 @@
<param name="inviteId">Id of the invite to cancel</param>
<param name="cancellationToken"></param>
<returns></returns>
<seealso cref="M:Speckle.Core.Api.GraphQL.Resources.ProjectInviteResource.Cancel(System.String,System.String,System.Threading.CancellationToken)"/>
</member>
<member name="M:Speckle.Core.Api.Client.StreamInviteUse(System.String,System.String,System.Boolean,System.Threading.CancellationToken)">
<summary>
@@ -324,6 +344,15 @@
<param name="cancellationToken"></param>
<returns></returns>
<exception cref="T:Speckle.Core.Logging.SpeckleException"></exception>
<seealso cref="M:Speckle.Core.Api.GraphQL.Resources.ProjectInviteResource.Use(Speckle.Core.Api.GraphQL.Inputs.ProjectInviteUseInput,System.Threading.CancellationToken)"/>
</member>
<member name="M:Speckle.Core.Api.Client.GetAllPendingInvites(System.Threading.CancellationToken)">
<summary>
</summary>
<param name="cancellationToken"></param>
<returns></returns>
<seealso cref="M:Speckle.Core.Api.GraphQL.Resources.ProjectInviteResource.Use(Speckle.Core.Api.GraphQL.Inputs.ProjectInviteUseInput,System.Threading.CancellationToken)"/>
</member>
<member name="M:Speckle.Core.Api.Client.ActiveUserGet(System.Threading.CancellationToken)">
<summary>
@@ -331,6 +360,7 @@
</summary>
<param name="cancellationToken"></param>
<returns></returns>
<seealso cref="M:Speckle.Core.Api.GraphQL.Resources.ActiveUserResource.Get(System.Threading.CancellationToken)"/>
</member>
<member name="M:Speckle.Core.Api.Client.OtherUserGet(System.String,System.Threading.CancellationToken)">
<summary>
@@ -339,6 +369,7 @@
<param name="id">Id of the user you are looking for</param>
<param name="cancellationToken"></param>
<returns></returns>
<seealso cref="M:Speckle.Core.Api.GraphQL.Resources.OtherUserResource.Get(System.String,System.Threading.CancellationToken)"/>
</member>
<member name="M:Speckle.Core.Api.Client.UserSearch(System.String,System.Int32,System.Threading.CancellationToken)">
<summary>
@@ -347,6 +378,7 @@
<param name="query">String to search for. Must be at least 3 characters</param>
<param name="limit">Max number of users to return</param>
<returns></returns>
<seealso cref="M:Speckle.Core.Api.GraphQL.Resources.OtherUserResource.Get(System.String,System.Threading.CancellationToken)"/>
</member>
<member name="M:Speckle.Core.Api.Client.SubscribeBranchCreated(System.String)">
<summary>
@@ -412,8 +444,349 @@
Gets the version of the current server. Useful for guarding against unsupported api calls on newer or older servers.
</summary>
<param name="cancellationToken">[Optional] defaults to an empty cancellation token</param>
<returns><see cref="T:Speckle.Core.Api.Version"/> object excluding any strings (eg "2.7.2-alpha.6995" becomes "2.7.2.6995")</returns>
<exception cref="T:Speckle.Core.Api.SpeckleGraphQLException"></exception>
<returns><see cref="T:Speckle.Core.Api.GraphQL.Models.Version"/> object excluding any strings (eg "2.7.2-alpha.6995" becomes "2.7.2.6995")</returns>
<exception cref="T:Speckle.Core.Api.SpeckleGraphQLException`1"></exception>
</member>
<member name="M:Speckle.Core.Api.GraphQL.ISpeckleGraphQLClient.ExecuteGraphQLRequest``1(GraphQL.GraphQLRequest,System.Threading.CancellationToken)">
<exception cref="T:Speckle.Core.Api.SpeckleGraphQLForbiddenException">"FORBIDDEN" on "UNAUTHORIZED" response from server</exception>
<exception cref="T:Speckle.Core.Api.SpeckleGraphQLException">All other request errors</exception>
<exception cref="T:System.OperationCanceledException">The <paramref name="cancellationToken"/> requested a cancel</exception>
<exception cref="T:System.ObjectDisposedException">This <see cref="T:Speckle.Core.Api.Client"/> already been disposed</exception>
</member>
<member name="M:Speckle.Core.Api.GraphQL.ISpeckleGraphQLClient.SubscribeTo``1(GraphQL.GraphQLRequest,System.Action{System.Object,``0})">
<exception cref="T:Speckle.Core.Api.SpeckleGraphQLForbiddenException">"FORBIDDEN" on "UNAUTHORIZED" response from server</exception>
<exception cref="T:Speckle.Core.Api.SpeckleGraphQLException">All other request errors</exception>
<exception cref="T:System.ObjectDisposedException">This <see cref="T:Speckle.Core.Api.Client"/> already been disposed</exception>
</member>
<member name="T:Speckle.Core.Api.GraphQL.Os">
<summary>
OS
NOTE: do not edit order and only append new items as they are serialized to ints
</summary>
</member>
<member name="T:Speckle.Core.Api.GraphQL.Architecture">
<summary>
Architecture
NOTE: do not edit order and only append new items as they are serialized to ints
</summary>
</member>
<member name="P:Speckle.Core.Api.GraphQL.Models.ServerInfo.frontend2">
<remarks>
This field is not returned from the GQL API,
it should be populated after construction from the response headers.
see <see cref="T:Speckle.Core.Credentials.AccountManager"/>
</remarks>
</member>
<member name="P:Speckle.Core.Api.GraphQL.Models.ServerInfo.url">
<remarks>
This field is not returned from the GQL API,
it should be populated after construction.
see <see cref="T:Speckle.Core.Credentials.AccountManager"/>
</remarks>
</member>
<member name="P:Speckle.Core.Api.GraphQL.Models.ServerMigration.movedTo">
<summary>
New URI where this server is now deployed
</summary>
</member>
<member name="P:Speckle.Core.Api.GraphQL.Models.ServerMigration.movedFrom">
<summary>
Previous URI where this server used to be deployed
</summary>
</member>
<member name="M:Speckle.Core.Api.GraphQL.Resources.ActiveUserResource.Get(System.Threading.CancellationToken)">
<summary>
Gets the currently active user profile.
</summary>
<param name="cancellationToken"></param>
<returns></returns>
<returns>the requested user, or null if the user does not exist (i.e. <see cref="T:Speckle.Core.Api.Client"/> was initialised with an unauthenticated account)</returns>
<inheritdoc cref="M:Speckle.Core.Api.GraphQL.ISpeckleGraphQLClient.ExecuteGraphQLRequest``1(GraphQL.GraphQLRequest,System.Threading.CancellationToken)"/>
</member>
<member name="M:Speckle.Core.Api.GraphQL.Resources.ActiveUserResource.GetProjects(System.Int32,System.String,Speckle.Core.Api.GraphQL.Inputs.UserProjectsFilter,System.Threading.CancellationToken)">
<param name="limit">Max number of projects to fetch</param>
<param name="cursor">Optional cursor for pagination</param>
<param name="filter">Optional filter</param>
<param name="cancellationToken"></param>
<returns></returns>
<inheritdoc cref="M:Speckle.Core.Api.GraphQL.ISpeckleGraphQLClient.ExecuteGraphQLRequest``1(GraphQL.GraphQLRequest,System.Threading.CancellationToken)"/>
</member>
<member name="M:Speckle.Core.Api.GraphQL.Resources.ActiveUserResource.ProjectInvites(System.Threading.CancellationToken)">
<param name="cancellationToken"></param>
<returns></returns>
<inheritdoc cref="M:Speckle.Core.Api.GraphQL.ISpeckleGraphQLClient.ExecuteGraphQLRequest``1(GraphQL.GraphQLRequest,System.Threading.CancellationToken)"/>
</member>
<member name="M:Speckle.Core.Api.GraphQL.Resources.CommentResource.GetProjectComments(System.String,System.Int32,System.String,Speckle.Core.Api.GraphQL.Inputs.ProjectCommentsFilter,System.Int32,System.String,System.Threading.CancellationToken)">
<param name="projectId"></param>
<param name="limit">Max number of comments to fetch</param>
<param name="cursor">Optional cursor for pagination</param>
<param name="filter">Optional filter</param>
<param name="repliesLimit">Max number of comment replies to fetch</param>
<param name="repliesCursor">Optional cursor for pagination</param>
<param name="cancellationToken"></param>
<returns></returns>
<inheritdoc cref="M:Speckle.Core.Api.GraphQL.ISpeckleGraphQLClient.ExecuteGraphQLRequest``1(GraphQL.GraphQLRequest,System.Threading.CancellationToken)"/>
</member>
<member name="M:Speckle.Core.Api.GraphQL.Resources.CommentResource.Create(Speckle.Core.Api.GraphQL.Inputs.CreateCommentInput,System.Threading.CancellationToken)">
<remarks>
This function only exists here to be able to integration tests the queries.
The process of creating a comment is more complex and javascript specific than we can expose to our SDKs at this time.
</remarks>
<param name="input"></param>
<param name="cancellationToken"></param>
<returns></returns>
<inheritdoc cref="M:Speckle.Core.Api.GraphQL.ISpeckleGraphQLClient.ExecuteGraphQLRequest``1(GraphQL.GraphQLRequest,System.Threading.CancellationToken)"/>
</member>
<member name="M:Speckle.Core.Api.GraphQL.Resources.CommentResource.Edit(Speckle.Core.Api.GraphQL.Inputs.EditCommentInput,System.Threading.CancellationToken)">
<remarks><inheritdoc cref="M:Speckle.Core.Api.GraphQL.Resources.CommentResource.Create(Speckle.Core.Api.GraphQL.Inputs.CreateCommentInput,System.Threading.CancellationToken)"/></remarks>
<param name="input"></param>
<param name="cancellationToken"></param>
<returns></returns>
<inheritdoc cref="M:Speckle.Core.Api.GraphQL.ISpeckleGraphQLClient.ExecuteGraphQLRequest``1(GraphQL.GraphQLRequest,System.Threading.CancellationToken)"/>
</member>
<member name="M:Speckle.Core.Api.GraphQL.Resources.CommentResource.Archive(System.String,System.Boolean,System.Threading.CancellationToken)">
<param name="commentId"></param>
<param name="archive"></param>
<param name="cancellationToken"></param>
<returns></returns>
<inheritdoc cref="M:Speckle.Core.Api.GraphQL.ISpeckleGraphQLClient.ExecuteGraphQLRequest``1(GraphQL.GraphQLRequest,System.Threading.CancellationToken)"/>
</member>
<member name="M:Speckle.Core.Api.GraphQL.Resources.CommentResource.MarkViewed(System.String,System.Threading.CancellationToken)">
<param name="commentId"></param>
<param name="cancellationToken"></param>
<returns></returns>
<inheritdoc cref="M:Speckle.Core.Api.GraphQL.ISpeckleGraphQLClient.ExecuteGraphQLRequest``1(GraphQL.GraphQLRequest,System.Threading.CancellationToken)"/>
</member>
<member name="M:Speckle.Core.Api.GraphQL.Resources.CommentResource.Reply(Speckle.Core.Api.GraphQL.Inputs.CreateCommentReplyInput,System.Threading.CancellationToken)">
<remarks><inheritdoc cref="M:Speckle.Core.Api.GraphQL.Resources.CommentResource.Create(Speckle.Core.Api.GraphQL.Inputs.CreateCommentInput,System.Threading.CancellationToken)"/></remarks>
<param name="input"></param>
<param name="cancellationToken"></param>
<returns></returns>
<inheritdoc cref="M:Speckle.Core.Api.GraphQL.ISpeckleGraphQLClient.ExecuteGraphQLRequest``1(GraphQL.GraphQLRequest,System.Threading.CancellationToken)"/>
</member>
<member name="M:Speckle.Core.Api.GraphQL.Resources.ModelResource.Get(System.String,System.String,System.Threading.CancellationToken)">
<param name="modelId"></param>
<param name="projectId"></param>
<param name="cancellationToken"></param>
<returns></returns>
<inheritdoc cref="M:Speckle.Core.Api.GraphQL.ISpeckleGraphQLClient.ExecuteGraphQLRequest``1(GraphQL.GraphQLRequest,System.Threading.CancellationToken)"/>
<seealso cref="M:Speckle.Core.Api.GraphQL.Resources.ModelResource.GetWithVersions(System.String,System.String,System.Int32,System.String,Speckle.Core.Api.GraphQL.Inputs.ModelVersionsFilter,System.Threading.CancellationToken)"/>
</member>
<member name="M:Speckle.Core.Api.GraphQL.Resources.ModelResource.GetWithVersions(System.String,System.String,System.Int32,System.String,Speckle.Core.Api.GraphQL.Inputs.ModelVersionsFilter,System.Threading.CancellationToken)">
<param name="projectId"></param>
<param name="modelId"></param>
<param name="versionsLimit">Max number of versions to fetch</param>
<param name="versionsCursor">Optional cursor for pagination</param>
<param name="versionsFilter">Optional versions filter</param>
<param name="cancellationToken"></param>
<returns></returns>
<inheritdoc cref="M:Speckle.Core.Api.GraphQL.ISpeckleGraphQLClient.ExecuteGraphQLRequest``1(GraphQL.GraphQLRequest,System.Threading.CancellationToken)"/>
<see cref="M:Speckle.Core.Api.GraphQL.Resources.ModelResource.Get(System.String,System.String,System.Threading.CancellationToken)"/>
</member>
<member name="M:Speckle.Core.Api.GraphQL.Resources.ModelResource.GetModels(System.String,System.Int32,System.String,Speckle.Core.Api.GraphQL.Inputs.ProjectModelsFilter,System.Threading.CancellationToken)">
<param name="projectId"></param>
<param name="modelsLimit">Max number of models to fetch</param>
<param name="modelsCursor">Optional cursor for pagination</param>
<param name="modelsFilter">Optional models filter</param>
<param name="cancellationToken"></param>
<returns></returns>
<inheritdoc cref="M:Speckle.Core.Api.GraphQL.ISpeckleGraphQLClient.ExecuteGraphQLRequest``1(GraphQL.GraphQLRequest,System.Threading.CancellationToken)"/>
</member>
<member name="M:Speckle.Core.Api.GraphQL.Resources.ModelResource.Create(Speckle.Core.Api.GraphQL.Inputs.CreateModelInput,System.Threading.CancellationToken)">
<param name="input"></param>
<param name="cancellationToken"></param>
<returns></returns>
<inheritdoc cref="M:Speckle.Core.Api.GraphQL.ISpeckleGraphQLClient.ExecuteGraphQLRequest``1(GraphQL.GraphQLRequest,System.Threading.CancellationToken)"/>
</member>
<member name="M:Speckle.Core.Api.GraphQL.Resources.ModelResource.Delete(Speckle.Core.Api.GraphQL.Inputs.DeleteModelInput,System.Threading.CancellationToken)">
<param name="input"></param>
<param name="cancellationToken"></param>
<returns></returns>
<inheritdoc cref="M:Speckle.Core.Api.GraphQL.ISpeckleGraphQLClient.ExecuteGraphQLRequest``1(GraphQL.GraphQLRequest,System.Threading.CancellationToken)"/>
</member>
<member name="M:Speckle.Core.Api.GraphQL.Resources.ModelResource.Update(Speckle.Core.Api.GraphQL.Inputs.UpdateModelInput,System.Threading.CancellationToken)">
<param name="input"></param>
<param name="cancellationToken"></param>
<returns></returns>
<inheritdoc cref="M:Speckle.Core.Api.GraphQL.ISpeckleGraphQLClient.ExecuteGraphQLRequest``1(GraphQL.GraphQLRequest,System.Threading.CancellationToken)"/>
</member>
<member name="M:Speckle.Core.Api.GraphQL.Resources.OtherUserResource.Get(System.String,System.Threading.CancellationToken)">
<summary>
</summary>
<param name="id"></param>
<param name="cancellationToken"></param>
<returns>the requested user, or null if the user does not exist</returns>
<inheritdoc cref="M:Speckle.Core.Api.GraphQL.ISpeckleGraphQLClient.ExecuteGraphQLRequest``1(GraphQL.GraphQLRequest,System.Threading.CancellationToken)"/>
</member>
<member name="M:Speckle.Core.Api.GraphQL.Resources.OtherUserResource.UserSearch(System.String,System.Int32,System.String,System.Boolean,System.Boolean,System.Threading.CancellationToken)">
<summary>
Searches for a user on the server.
</summary>
<param name="query">String to search for. Must be at least 3 characters</param>
<param name="limit">Max number of users to fetch</param>
<param name="cursor">Optional cursor for pagination</param>
<param name="archived"></param>
<param name="emailOnly"></param>
<param name="cancellationToken"></param>
<returns></returns>
<inheritdoc cref="M:Speckle.Core.Api.GraphQL.ISpeckleGraphQLClient.ExecuteGraphQLRequest``1(GraphQL.GraphQLRequest,System.Threading.CancellationToken)"/>
</member>
<member name="M:Speckle.Core.Api.GraphQL.Resources.ProjectInviteResource.Create(System.String,Speckle.Core.Api.GraphQL.Inputs.ProjectInviteCreateInput,System.Threading.CancellationToken)">
<param name="projectId"></param>
<param name="input"></param>
<param name="cancellationToken"></param>
<returns></returns>
<inheritdoc cref="M:Speckle.Core.Api.GraphQL.ISpeckleGraphQLClient.ExecuteGraphQLRequest``1(GraphQL.GraphQLRequest,System.Threading.CancellationToken)"/>
</member>
<member name="M:Speckle.Core.Api.GraphQL.Resources.ProjectInviteResource.Use(Speckle.Core.Api.GraphQL.Inputs.ProjectInviteUseInput,System.Threading.CancellationToken)">
<param name="input"></param>
<param name="cancellationToken"></param>
<returns></returns>
<inheritdoc cref="M:Speckle.Core.Api.GraphQL.ISpeckleGraphQLClient.ExecuteGraphQLRequest``1(GraphQL.GraphQLRequest,System.Threading.CancellationToken)"/>
</member>
<member name="M:Speckle.Core.Api.GraphQL.Resources.ProjectInviteResource.Get(System.String,System.String,System.Threading.CancellationToken)">
<param name="projectId"></param>
<param name="token"></param>
<param name="cancellationToken"></param>
<returns>The invite, or null if no invite exists</returns>
<inheritdoc cref="M:Speckle.Core.Api.GraphQL.ISpeckleGraphQLClient.ExecuteGraphQLRequest``1(GraphQL.GraphQLRequest,System.Threading.CancellationToken)"/>
</member>
<member name="M:Speckle.Core.Api.GraphQL.Resources.ProjectInviteResource.Cancel(System.String,System.String,System.Threading.CancellationToken)">
<param name="projectId"></param>
<param name="inviteId"></param>
<param name="cancellationToken"></param>
<returns></returns>
<inheritdoc cref="M:Speckle.Core.Api.GraphQL.ISpeckleGraphQLClient.ExecuteGraphQLRequest``1(GraphQL.GraphQLRequest,System.Threading.CancellationToken)"/>
</member>
<member name="M:Speckle.Core.Api.GraphQL.Resources.ProjectResource.Get(System.String,System.Threading.CancellationToken)">
<param name="projectId"></param>
<param name="cancellationToken"></param>
<returns></returns>
<inheritdoc cref="M:Speckle.Core.Api.GraphQL.ISpeckleGraphQLClient.ExecuteGraphQLRequest``1(GraphQL.GraphQLRequest,System.Threading.CancellationToken)"/>
<seealso cref="M:Speckle.Core.Api.GraphQL.Resources.ProjectResource.GetWithModels(System.String,System.Int32,System.String,Speckle.Core.Api.GraphQL.Inputs.ProjectModelsFilter,System.Threading.CancellationToken)"/>
<seealso cref="M:Speckle.Core.Api.GraphQL.Resources.ProjectResource.GetWithTeam(System.String,System.Threading.CancellationToken)"/>
</member>
<member name="M:Speckle.Core.Api.GraphQL.Resources.ProjectResource.GetWithModels(System.String,System.Int32,System.String,Speckle.Core.Api.GraphQL.Inputs.ProjectModelsFilter,System.Threading.CancellationToken)">
<param name="projectId"></param>
<param name="modelsLimit">Max number of models to fetch</param>
<param name="modelsCursor">Optional cursor for pagination</param>
<param name="modelsFilter">Optional models filter</param>
<param name="cancellationToken"></param>
<returns></returns>
<inheritdoc cref="M:Speckle.Core.Api.GraphQL.ISpeckleGraphQLClient.ExecuteGraphQLRequest``1(GraphQL.GraphQLRequest,System.Threading.CancellationToken)"/>
<seealso cref="M:Speckle.Core.Api.GraphQL.Resources.ProjectResource.Get(System.String,System.Threading.CancellationToken)"/>
<seealso cref="M:Speckle.Core.Api.GraphQL.Resources.ProjectResource.GetWithTeam(System.String,System.Threading.CancellationToken)"/>
</member>
<member name="M:Speckle.Core.Api.GraphQL.Resources.ProjectResource.GetWithTeam(System.String,System.Threading.CancellationToken)">
<param name="projectId"></param>
<param name="cancellationToken"></param>
<returns></returns>
<inheritdoc cref="M:Speckle.Core.Api.GraphQL.ISpeckleGraphQLClient.ExecuteGraphQLRequest``1(GraphQL.GraphQLRequest,System.Threading.CancellationToken)"/>
<seealso cref="M:Speckle.Core.Api.GraphQL.Resources.ProjectResource.Get(System.String,System.Threading.CancellationToken)"/>
<seealso cref="M:Speckle.Core.Api.GraphQL.Resources.ProjectResource.GetWithModels(System.String,System.Int32,System.String,Speckle.Core.Api.GraphQL.Inputs.ProjectModelsFilter,System.Threading.CancellationToken)"/>
</member>
<member name="M:Speckle.Core.Api.GraphQL.Resources.ProjectResource.Create(Speckle.Core.Api.GraphQL.Inputs.ProjectCreateInput,System.Threading.CancellationToken)">
<param name="input"></param>
<param name="cancellationToken"></param>
<returns></returns>
<inheritdoc cref="M:Speckle.Core.Api.GraphQL.ISpeckleGraphQLClient.ExecuteGraphQLRequest``1(GraphQL.GraphQLRequest,System.Threading.CancellationToken)"/>
</member>
<member name="M:Speckle.Core.Api.GraphQL.Resources.ProjectResource.Update(Speckle.Core.Api.GraphQL.Inputs.ProjectUpdateInput,System.Threading.CancellationToken)">
<param name="input"></param>
<param name="cancellationToken"></param>
<returns></returns>
<inheritdoc cref="M:Speckle.Core.Api.GraphQL.ISpeckleGraphQLClient.ExecuteGraphQLRequest``1(GraphQL.GraphQLRequest,System.Threading.CancellationToken)"/>
</member>
<member name="M:Speckle.Core.Api.GraphQL.Resources.ProjectResource.Delete(System.String,System.Threading.CancellationToken)">
<param name="projectId">The id of the Project to delete</param>
<param name="cancellationToken"></param>
<returns></returns>
<inheritdoc cref="M:Speckle.Core.Api.GraphQL.ISpeckleGraphQLClient.ExecuteGraphQLRequest``1(GraphQL.GraphQLRequest,System.Threading.CancellationToken)"/>
</member>
<member name="M:Speckle.Core.Api.GraphQL.Resources.ProjectResource.UpdateRole(Speckle.Core.Api.GraphQL.Inputs.ProjectUpdateRoleInput,System.Threading.CancellationToken)">
<param name="input"></param>
<param name="cancellationToken"></param>
<inheritdoc cref="M:Speckle.Core.Api.GraphQL.ISpeckleGraphQLClient.ExecuteGraphQLRequest``1(GraphQL.GraphQLRequest,System.Threading.CancellationToken)"/>
</member>
<member name="M:Speckle.Core.Api.GraphQL.Resources.SubscriptionResource.CreateUserProjectsUpdatedSubscription">
<summary>Track newly added or deleted projects owned by the active user</summary>
<remarks>
You should add event listeners to the returned <see cref="T:Speckle.Core.Api.GraphQL.Resources.Subscription`1"/> object.<br/>
You can add multiple listeners to a <see cref="T:Speckle.Core.Api.GraphQL.Resources.Subscription`1"/>, and this should be preferred over creating many subscriptions.<br/>
You should ensure proper disposal of the <see cref="T:Speckle.Core.Api.GraphQL.Resources.Subscription`1"/> when you're done (see <see cref="T:System.IDisposable"/>)<br/>
Disposing of the <see cref="T:Speckle.Core.Api.Client"/> or <see cref="T:Speckle.Core.Api.GraphQL.Resources.SubscriptionResource"/> will also dispose any <see cref="T:Speckle.Core.Api.GraphQL.Resources.Subscription`1"/>s it created.
</remarks>
<inheritdoc cref="M:Speckle.Core.Api.GraphQL.ISpeckleGraphQLClient.SubscribeTo``1(GraphQL.GraphQLRequest,System.Action{System.Object,``0})"/>
</member>
<member name="M:Speckle.Core.Api.GraphQL.Resources.SubscriptionResource.CreateProjectCommentsUpdatedSubscription(Speckle.Core.Api.GraphQL.Inputs.ViewerUpdateTrackingTarget)">
<summary>Subscribe to updates to resource comments/threads. Optionally specify resource ID string to only receive updates regarding comments for those resources</summary>
<remarks><inheritdoc cref="M:Speckle.Core.Api.GraphQL.Resources.SubscriptionResource.CreateUserProjectsUpdatedSubscription"/></remarks>
<inheritdoc cref="M:Speckle.Core.Api.GraphQL.ISpeckleGraphQLClient.SubscribeTo``1(GraphQL.GraphQLRequest,System.Action{System.Object,``0})"/>
</member>
<member name="M:Speckle.Core.Api.GraphQL.Resources.SubscriptionResource.CreateProjectModelsUpdatedSubscription(System.String,System.Collections.Generic.IReadOnlyList{System.String})">
<summary>Subscribe to changes to a project's models. Optionally specify <paramref name="modelIds"/> to track</summary>
<remarks><inheritdoc cref="M:Speckle.Core.Api.GraphQL.Resources.SubscriptionResource.CreateUserProjectsUpdatedSubscription"/></remarks>
<inheritdoc cref="M:Speckle.Core.Api.GraphQL.ISpeckleGraphQLClient.SubscribeTo``1(GraphQL.GraphQLRequest,System.Action{System.Object,``0})"/>
</member>
<member name="M:Speckle.Core.Api.GraphQL.Resources.SubscriptionResource.CreateProjectUpdatedSubscription(System.String)">
<summary>Track updates to a specific project</summary>
<remarks><inheritdoc cref="M:Speckle.Core.Api.GraphQL.Resources.SubscriptionResource.CreateUserProjectsUpdatedSubscription"/></remarks>
<inheritdoc cref="M:Speckle.Core.Api.GraphQL.ISpeckleGraphQLClient.SubscribeTo``1(GraphQL.GraphQLRequest,System.Action{System.Object,``0})"/>
</member>
<member name="M:Speckle.Core.Api.GraphQL.Resources.SubscriptionResource.CreateProjectVersionsUpdatedSubscription(System.String)">
<summary>Subscribe to changes to a project's versions.</summary>
<remarks><inheritdoc cref="M:Speckle.Core.Api.GraphQL.Resources.SubscriptionResource.CreateUserProjectsUpdatedSubscription"/></remarks>
<inheritdoc cref="M:Speckle.Core.Api.GraphQL.ISpeckleGraphQLClient.SubscribeTo``1(GraphQL.GraphQLRequest,System.Action{System.Object,``0})"/>
</member>
<member name="M:Speckle.Core.Api.GraphQL.Resources.VersionResource.Get(System.String,System.String,System.String,System.Threading.CancellationToken)">
<param name="projectId"></param>
<param name="modelId"></param>
<param name="versionId"></param>
<param name="cancellationToken"></param>
<returns></returns>
<inheritdoc cref="M:Speckle.Core.Api.GraphQL.ISpeckleGraphQLClient.ExecuteGraphQLRequest``1(GraphQL.GraphQLRequest,System.Threading.CancellationToken)"/>
</member>
<member name="M:Speckle.Core.Api.GraphQL.Resources.VersionResource.GetVersions(System.String,System.String,System.Int32,System.String,Speckle.Core.Api.GraphQL.Inputs.ModelVersionsFilter,System.Threading.CancellationToken)">
<param name="projectId"></param>
<param name="modelId"></param>
<param name="limit">Max number of versions to fetch</param>
<param name="cursor">Optional cursor for pagination</param>
<param name="filter">Optional filter</param>
<param name="cancellationToken"></param>
<inheritdoc cref="M:Speckle.Core.Api.GraphQL.ISpeckleGraphQLClient.ExecuteGraphQLRequest``1(GraphQL.GraphQLRequest,System.Threading.CancellationToken)"/>
</member>
<member name="M:Speckle.Core.Api.GraphQL.Resources.VersionResource.Create(Speckle.Core.Api.CommitCreateInput,System.Threading.CancellationToken)">
<param name="cancellationToken"></param>
<returns></returns>
<inheritdoc cref="M:Speckle.Core.Api.GraphQL.ISpeckleGraphQLClient.ExecuteGraphQLRequest``1(GraphQL.GraphQLRequest,System.Threading.CancellationToken)"/>
</member>
<member name="M:Speckle.Core.Api.GraphQL.Resources.VersionResource.Update(Speckle.Core.Api.GraphQL.Inputs.UpdateVersionInput,System.Threading.CancellationToken)">
<param name="input"></param>
<param name="cancellationToken"></param>
<inheritdoc cref="M:Speckle.Core.Api.GraphQL.ISpeckleGraphQLClient.ExecuteGraphQLRequest``1(GraphQL.GraphQLRequest,System.Threading.CancellationToken)"/>
</member>
<member name="M:Speckle.Core.Api.GraphQL.Resources.VersionResource.MoveToModel(Speckle.Core.Api.GraphQL.Inputs.MoveVersionsInput,System.Threading.CancellationToken)">
<param name="input"></param>
<param name="cancellationToken"></param>
<returns></returns>
<inheritdoc cref="M:Speckle.Core.Api.GraphQL.ISpeckleGraphQLClient.ExecuteGraphQLRequest``1(GraphQL.GraphQLRequest,System.Threading.CancellationToken)"/>
</member>
<member name="M:Speckle.Core.Api.GraphQL.Resources.VersionResource.Delete(Speckle.Core.Api.GraphQL.Inputs.DeleteVersionsInput,System.Threading.CancellationToken)">
<param name="cancellationToken"></param>
<returns></returns>
<inheritdoc cref="M:Speckle.Core.Api.GraphQL.ISpeckleGraphQLClient.ExecuteGraphQLRequest``1(GraphQL.GraphQLRequest,System.Threading.CancellationToken)"/>
</member>
<member name="M:Speckle.Core.Api.GraphQL.Resources.VersionResource.Received(Speckle.Core.Api.CommitReceivedInput,System.Threading.CancellationToken)">
<param name="commitReceivedInput"></param>
<param name="cancellationToken"></param>
<returns></returns>
<inheritdoc cref="M:Speckle.Core.Api.GraphQL.ISpeckleGraphQLClient.ExecuteGraphQLRequest``1(GraphQL.GraphQLRequest,System.Threading.CancellationToken)"/>
</member>
<member name="T:Speckle.Core.Api.GraphQL.StreamRoles">
<summary>
These are the default roles used by the server
</summary>
</member>
<member name="P:Speckle.Core.Api.Stream.branch">
<summary>
@@ -430,62 +803,6 @@
Set only in the case that you've requested this through <see cref="M:Speckle.Core.Api.Client.StreamGetCommits(System.String,System.Int32,System.Threading.CancellationToken)"/>
</summary>
</member>
<member name="T:Speckle.Core.Api.ActiveUserData">
<summary>
GraphQL DTO model for active user data
</summary>
</member>
<member name="P:Speckle.Core.Api.ActiveUserData.activeUser">
<summary>
User profile of the active user.
</summary>
</member>
<member name="T:Speckle.Core.Api.LimitedUserData">
<summary>
GraphQL DTO model for limited user data. Mostly referring to other user's profile.
</summary>
</member>
<member name="P:Speckle.Core.Api.LimitedUserData.otherUser">
<summary>
The limited user profile of another (non active user)
</summary>
</member>
<member name="P:Speckle.Core.Api.ServerInfo.frontend2">
<remarks>
This field is not returned from the GQL API,
it should populated on construction from the response headers.
see <see cref="T:Speckle.Core.Credentials.AccountManager"/>
</remarks>
</member>
<member name="P:Speckle.Core.Api.ServerInfo.url">
<remarks>
This field is not returned from the GQL API,
it should populated on construction.
see <see cref="T:Speckle.Core.Credentials.AccountManager"/>
</remarks>
</member>
<member name="P:Speckle.Core.Api.ServerMigration.movedTo">
<summary>
New URI where this server is now deployed
</summary>
</member>
<member name="P:Speckle.Core.Api.ServerMigration.movedFrom">
<summary>
Previous URI where this server used to be deployed
</summary>
</member>
<member name="T:Speckle.Core.Api.Os">
<summary>
OS
NOTE: do not edit order and only append new items as they are serialized to ints
</summary>
</member>
<member name="T:Speckle.Core.Api.Architecture">
<summary>
Architecture
NOTE: do not edit order and only append new items as they are serialized to ints
</summary>
</member>
<member name="M:Speckle.Core.Api.Helpers.Receive(System.String,Speckle.Core.Credentials.Account,System.Action{System.Collections.Concurrent.ConcurrentDictionary{System.String,System.Int32}},System.Action{System.Int32})">
<summary>
Helper method to Receive from a Speckle Server.
@@ -784,6 +1101,15 @@
⚠️ Not all limits are reflected here!
</remarks>
</member>
<member name="F:Speckle.Core.Api.ServerLimits.DEFAULT_PAGINATION_REQUEST">
<summary>the default `limit` argument value for paginated requests</summary>
</member>
<member name="P:Speckle.Core.Credentials.Account.id">
<remarks>
The account id is unique to user and server url.
</remarks>
<exception cref="T:System.InvalidOperationException">Account object invalid: missing required info</exception>
</member>
<member name="M:Speckle.Core.Credentials.Account.GetLocalIdentifier">
<summary>
Retrieves the local identifier for the current user.
@@ -843,6 +1169,11 @@
The Default Server URL for authentication, can be overridden by placing a file with the alternatrive url in the Speckle folder or with an ENV_VAR
</summary>
</member>
<member name="M:Speckle.Core.Credentials.AccountManager.GetAccount(System.String)">
<param name="id">The Id of the account to fetch</param>
<returns></returns>
<exception cref="T:Speckle.Core.Credentials.SpeckleAccountManagerException">Account with <paramref name="id"/> was not found</exception>
</member>
<member name="M:Speckle.Core.Credentials.AccountManager.UpgradeAccount(System.String)">
<summary>
Upgrades an account from the account.serverInfo.movedFrom account to the account.serverInfo.movedTo account
@@ -994,7 +1325,7 @@
Verifies that the state of the stream wrapper represents a valid Speckle resource e.g. points to a valid stream/branch etc.
</summary>
<param name="acc">The account to use to verify the current state of the stream wrapper</param>
<exception cref="T:System.ArgumentException">The <see cref="T:Speckle.Core.Api.ServerInfo"/> of the provided <paramref name="acc"/> is invalid or does not match the <see cref="T:Speckle.Core.Credentials.StreamWrapper"/>'s <see cref="P:Speckle.Core.Credentials.StreamWrapper.ServerUrl"/></exception>
<exception cref="T:System.ArgumentException">The <see cref="T:Speckle.Core.Api.GraphQL.Models.ServerInfo"/> of the provided <paramref name="acc"/> is invalid or does not match the <see cref="T:Speckle.Core.Credentials.StreamWrapper"/>'s <see cref="P:Speckle.Core.Credentials.StreamWrapper.ServerUrl"/></exception>
<exception cref="T:System.Net.Http.HttpRequestException">You are not connected to the internet</exception>
<exception cref="T:Speckle.Core.Logging.SpeckleException">Verification of the current state of the stream wrapper with provided <paramref name="acc"/> was unsuccessful. The <paramref name="acc"/> could be invalid, or lack permissions for the <see cref="P:Speckle.Core.Credentials.StreamWrapper.StreamId"/>, or the <see cref="P:Speckle.Core.Credentials.StreamWrapper.StreamId"/> or <see cref="P:Speckle.Core.Credentials.StreamWrapper.BranchName"/> are invalid</exception>
</member>
@@ -2181,6 +2512,13 @@
<param name="speckleObject">The Base object to check.</param>
<returns>True if the object is displayable, false otherwise.</returns>
</member>
<member name="M:Speckle.Core.Models.Extensions.BaseExtensions.TraverseWithPath(Speckle.Core.Models.Base,Speckle.Core.Models.Extensions.BaseExtensions.BaseRecursionBreaker)">
<summary>
A variation of the OG Traversal extension from Alan, but with tracking the object path as well.
</summary>
<param name="recursionBreaker"> Delegate condition to stop traverse.</param>
<returns>List of base objects with their collection path.</returns>
</member>
<member name="T:Speckle.Core.Models.Abstract">
<summary>
Wrapper around other, third party, classes that are not coming from a speckle kit.
@@ -2234,13 +2572,20 @@
</remarks>
</member>
<member name="M:Speckle.Core.Models.GraphTraversal.DefaultTraversal.CreateTraverseFunc(Speckle.Core.Kits.ISpeckleConverter)">
<summary><inheritdoc cref="M:Speckle.Core.Models.GraphTraversal.DefaultTraversal.CreateLegacyTraverseFunc(System.Func{Speckle.Core.Models.Base,System.Boolean})"/></summary>
<remarks><inheritdoc cref="M:Speckle.Core.Models.GraphTraversal.DefaultTraversal.CreateLegacyTraverseFunc(System.Func{Speckle.Core.Models.Base,System.Boolean})"/></remarks>
<param name="converter"></param>
<returns></returns>
</member>
<member name="M:Speckle.Core.Models.GraphTraversal.DefaultTraversal.CreateLegacyTraverseFunc(System.Func{Speckle.Core.Models.Base,System.Boolean})">
<summary>
Default traversal rule that ideally should be used by all connectors
Legacy traversal rule that was dependent on the converter
</summary>
<remarks>
Treats convertable objects <see cref="M:Speckle.Core.Kits.ISpeckleConverter.CanConvertToNative(Speckle.Core.Models.Base)"/> and objects with displayValues as "convertable" such that only elements and dynamic props will be traversed
New code should use <see cref="M:Speckle.Core.Models.GraphTraversal.DefaultTraversal.CreateTraversalFunc"/> instead.
</remarks>
<param name="converter"></param>
<param name="canConvertToNative"></param>
<returns></returns>
</member>
<member name="M:Speckle.Core.Models.GraphTraversal.DefaultTraversal.CreateRevitTraversalFunc(Speckle.Core.Kits.ISpeckleConverter)">
@@ -2248,9 +2593,10 @@
Traverses until finds a convertable object then HALTS deeper traversal
</summary>
<remarks>
Current Revit connector does traversal,
The DUI2 Revit connector does traversal,
so this traversal is a shallow traversal for directly convertable objects,
and a deep traversal for all other types
New code should use <see cref="M:Speckle.Core.Models.GraphTraversal.DefaultTraversal.CreateTraversalFunc"/> instead.
</remarks>
<param name="converter"></param>
<returns></returns>
@@ -2259,6 +2605,9 @@
<summary>
Traverses until finds a convertable object (or fallback) then traverses members
</summary>
<remarks>
New code should use <see cref="M:Speckle.Core.Models.GraphTraversal.DefaultTraversal.CreateTraversalFunc"/> instead.
</remarks>
<param name="converter"></param>
<returns></returns>
</member>
@@ -2293,6 +2642,18 @@
<param name="o"></param>
<returns></returns>
</member>
<member name="P:Speckle.Core.Models.GraphTraversal.ITraversalRule.ShouldReturn">
<summary>
When <see langword="false"/>,
<see cref="T:Speckle.Core.Models.Base"/> objects for which this rule applies,
will be filtered out from the traversal output
(but still traversed normally, as per the <see cref="M:Speckle.Core.Models.GraphTraversal.ITraversalRule.MembersToTraverse(Speckle.Core.Models.Base)"/>)
</summary>
<remarks>
This property was added to allow for easier filtering of the return of <see cref="M:Speckle.Core.Models.GraphTraversal.GraphTraversal`1.Traverse(Speckle.Core.Models.Base)"/>.
Without the option to set some rules as false, it was necessary to duplicate part of the rules in a <see cref="M:System.Linq.Enumerable.Where``1(System.Collections.Generic.IEnumerable{``0},System.Func{``0,System.Boolean})"/>
</remarks>
</member>
<member name="T:Speckle.Core.Models.GraphTraversal.DefaultRule">
<summary>
The "traverse none" rule that always holds true
@@ -2310,7 +2671,7 @@
</member>
<member name="T:Speckle.Core.Models.GraphTraversal.ITraversalBuilderWhen">
<summary>
Interface for traversal rule in a building (unusable) state
Builder Pattern Interface for a traversal rule in a partially built (unusable state)
</summary>
</member>
<member name="M:Speckle.Core.Models.GraphTraversal.ITraversalBuilderWhen.When(Speckle.Core.Models.GraphTraversal.WhenCondition)">
@@ -2327,7 +2688,7 @@
</member>
<member name="T:Speckle.Core.Models.GraphTraversal.ITraversalBuilderTraverse">
<summary>
Interface for traversal rule in a building (unusable) state
Builder Pattern Interface for a traversal rule in a partially built (unusable state)
</summary>
</member>
<member name="M:Speckle.Core.Models.GraphTraversal.ITraversalBuilderTraverse.ContinueTraversing(Speckle.Core.Models.GraphTraversal.SelectMembers)">
@@ -2335,6 +2696,32 @@
<param name="membersToTraverse">Function returning the members that should be traversed for objects where this rule holds <see langword = "true"/></param>
<returns>Traversal rule in a usable state</returns>
</member>
<member name="T:Speckle.Core.Models.GraphTraversal.ITraversalBuilderReturn">
<summary>
Builder Pattern Interface for a traversal rule in a usable state, with an (optional) final step to set the value of <see cref="P:Speckle.Core.Models.GraphTraversal.ITraversalRule.ShouldReturn"/>
</summary>
</member>
<member name="M:Speckle.Core.Models.GraphTraversal.ITraversalBuilderReturn.ShouldReturnToOutput(System.Boolean)">
<seealso cref="M:Speckle.Core.Models.GraphTraversal.ITraversalRule.MembersToTraverse(Speckle.Core.Models.Base)"/>
<param name="shouldReturn">value to set <see cref="P:Speckle.Core.Models.GraphTraversal.ITraversalRule.ShouldReturn"/></param>
<returns>Traversal rule in a usable state</returns>
</member>
<member name="M:Speckle.Core.Models.GraphTraversal.TraversalContextExtensions.GetPropertyPath(Speckle.Core.Models.GraphTraversal.TraversalContext)">
<summary>
Walks up the tree, returning <see cref="P:Speckle.Core.Models.GraphTraversal.TraversalContext.PropName"/> values, starting with <paramref name="context"/>,
walking up <see cref="P:Speckle.Core.Models.GraphTraversal.TraversalContext.Parent"/> nodes
</summary>
<param name="context"></param>
<returns></returns>
</member>
<member name="M:Speckle.Core.Models.GraphTraversal.TraversalContextExtensions.GetAscendantOfType``1(Speckle.Core.Models.GraphTraversal.TraversalContext)">
<summary>
Walks up the tree, returning all <typeparamref name="T"/> typed ascendant, starting the <typeparamref name="T"/> closest <paramref name="context"/>,
walking up <see cref="P:Speckle.Core.Models.GraphTraversal.TraversalContext.Parent"/> nodes
</summary>
<param name="context"></param>
<returns></returns>
</member>
<member name="T:Speckle.Core.Models.NestingInstructions">
<summary>
Container for a reference to a parent's applicationId and an Action to
@@ -2460,6 +2847,13 @@
Flushes kit's (discriminator, type) cache. Useful if you're dynamically loading more kits at runtime, that provide better coverage of what you're deserialising, and it's now somehow poisoned because the higher level types were not originally available.
</summary>
</member>
<member name="M:Speckle.Core.Serialisation.SerializationUtilities.ValueConverter.IsGenericList(System.Type)">
<summary>
Tests that the given <paramref name="type"/> is assignable from a generic type def <see cref="T:System.Collections.Generic.List`1"/>
</summary>
<param name="type"></param>
<returns></returns>
</member>
<member name="T:Speckle.Core.Transports.ITransport">
<summary>
Interface defining the contract for transport implementations.
Packages/systems.speckle.speckle-unity/Runtime/Objects/Objects.dll
BIN
View File
Binary file not shown.
Packages/systems.speckle.speckle-unity/Runtime/Objects/Objects.pdb
BIN
View File
Binary file not shown.
Packages/systems.speckle.speckle-unity/Runtime/Objects/Objects.xml
+60 -139
View File
@@ -21,6 +21,16 @@
<param name="componentPropertiesList"></param>
<returns></returns>
</member>
<member name="T:Objects.BuiltElements.Archicad.ElementShape.PolylineSegment">
<remarks>
This class is only used for Archicad interop
</remarks>
</member>
<member name="T:Objects.BuiltElements.Archicad.ElementShape.Polyline">
<remarks>
This class is only used for Archicad interop
</remarks>
</member>
<member name="M:Objects.BuiltElements.Archicad.Property.ToBase(System.Collections.Generic.List{Objects.BuiltElements.Archicad.Property})">
<summary>
Turns a List of Property into a Base so that it can be used with the Speckle properties prop
@@ -40,11 +50,41 @@
SchemaBuilder constructor for an Area
</summary>
</member>
<member name="P:Objects.BuiltElements.Baseline.name">
<summary>
The name of this baseline
</summary>
</member>
<member name="P:Objects.BuiltElements.Baseline.alignment">
<summary>
The horizontal component of this baseline
</summary>
</member>
<member name="P:Objects.BuiltElements.Baseline.profile">
<summary>
The vertical component of this baseline
</summary>
</member>
<member name="T:Objects.BuiltElements.Baseline`2">
<summary>
Generic instance class
</summary>
</member>
<member name="P:Objects.BuiltElements.Civil.CivilAlignment.parent">
<summary>
Name of parent alignment if this is an offset alignment
</summary>
</member>
<member name="P:Objects.BuiltElements.Civil.CivilBaselineRegion.name">
<summary>
The name of the region
</summary>
</member>
<member name="P:Objects.BuiltElements.Civil.CivilBaselineRegion.assemblyId">
<summary>
The id of the assembly of the region
</summary>
</member>
<member name="P:Objects.BuiltElements.Civil.CivilProfile.pvis">
<summary>
Points of vertical intersection
@@ -288,73 +328,6 @@
True = Type Parameter, False = Instance Parameter
</summary>
</member>
<member name="M:Objects.BuiltElements.Revit.RevitColumn.#ctor(System.String,System.String,Objects.ICurve,Objects.BuiltElements.Level,Objects.BuiltElements.Level,System.Double,System.Double,System.Boolean,System.Double,System.Collections.Generic.List{Objects.BuiltElements.Revit.Parameter})">
<summary>
SchemaBuilder constructor for a Revit column
</summary>
<param name="family"></param>
<param name="type"></param>
<param name="baseLine"></param>
<param name="level"></param>
<param name="topLevel"></param>
<param name="baseOffset"></param>
<param name="topOffset"></param>
<param name="structural"></param>
<param name="rotation"></param>
<param name="parameters"></param>
<remarks>Assign units when using this constructor due to <paramref name="baseOffset"/> and <paramref name="topOffset"/> params</remarks>
</member>
<member name="M:Objects.BuiltElements.Revit.RevitDuct.#ctor(System.String,System.String,Objects.Geometry.Line,System.String,System.String,Objects.BuiltElements.Level,System.Double,System.Double,System.Double,System.Double,System.Collections.Generic.List{Objects.BuiltElements.Revit.Parameter})">
<summary>
SchemaBuilder constructor for a Revit duct (deprecated)
</summary>
<param name="family"></param>
<param name="type"></param>
<param name="baseLine"></param>
<param name="systemName"></param>
<param name="systemType"></param>
<param name="level"></param>
<param name="width"></param>
<param name="height"></param>
<param name="diameter"></param>
<param name="velocity"></param>
<param name="parameters"></param>
<remarks>Assign units when using this constructor due to <paramref name="width"/>, <paramref name="height"/>, and <paramref name="diameter"/> params</remarks>
</member>
<member name="M:Objects.BuiltElements.Revit.RevitDuct.#ctor(System.String,System.String,Objects.ICurve,System.String,System.String,Objects.BuiltElements.Level,System.Double,System.Double,System.Double,System.Double,System.Collections.Generic.List{Objects.BuiltElements.Revit.Parameter})">
<summary>
SchemaBuilder constructor for a Revit duct
</summary>
<param name="family"></param>
<param name="type"></param>
<param name="baseCurve"></param>
<param name="systemName"></param>
<param name="systemType"></param>
<param name="level"></param>
<param name="width"></param>
<param name="height"></param>
<param name="diameter"></param>
<param name="velocity"></param>
<param name="parameters"></param>
<remarks>Assign units when using this constructor due to <paramref name="width"/>, <paramref name="height"/>, and <paramref name="diameter"/> params</remarks>
</member>
<member name="M:Objects.BuiltElements.Revit.RevitFlexDuct.#ctor(System.String,System.String,Objects.ICurve,System.String,System.String,Objects.BuiltElements.Level,System.Double,System.Double,System.Double,Objects.Geometry.Vector,Objects.Geometry.Vector,System.Double,System.Collections.Generic.List{Objects.BuiltElements.Revit.Parameter})">
<summary>
SchemaBuilder constructor for a Revit flex duct
</summary>
<param name="family"></param>
<param name="type"></param>
<param name="baseCurve"></param>
<param name="systemName"></param>
<param name="systemType"></param>
<param name="level"></param>
<param name="width"></param>
<param name="height"></param>
<param name="diameter"></param>
<param name="velocity"></param>
<param name="parameters"></param>
<remarks>Assign units when using this constructor due to <paramref name="width"/>, <paramref name="height"/>, and <paramref name="diameter"/> params</remarks>
</member>
<member name="T:Objects.BuiltElements.Revit.RevitElement">
<summary>
A generic Revit element for which we don't have direct conversions
@@ -459,40 +432,6 @@
<param name="parameters"></param>
<remarks>Assign units when using this constructor due to <paramref name="start"/> and <paramref name="end"/> params</remarks>
</member>
<member name="M:Objects.BuiltElements.Revit.RevitWall.#ctor(System.String,System.String,Objects.ICurve,Objects.BuiltElements.Level,Objects.BuiltElements.Level,System.Double,System.Double,System.Boolean,System.Boolean,System.Collections.Generic.List{Speckle.Core.Models.Base},System.Collections.Generic.List{Objects.BuiltElements.Revit.Parameter})">
<summary>
SchemaBuilder constructor for a Revit wall
</summary>
<param name="family"></param>
<param name="type"></param>
<param name="baseLine"></param>
<param name="level"></param>
<param name="topLevel"></param>
<param name="baseOffset"></param>
<param name="topOffset"></param>
<param name="flipped"></param>
<param name="structural"></param>
<param name="elements"></param>
<param name="parameters"></param>
<remarks>Assign units when using this constructor due to <paramref name="baseOffset"/> and <paramref name="topOffset"/> params</remarks>
</member>
<member name="M:Objects.BuiltElements.Revit.RevitWall.#ctor(System.String,System.String,Objects.ICurve,Objects.BuiltElements.Level,System.Double,System.Double,System.Double,System.Boolean,System.Boolean,System.Collections.Generic.List{Speckle.Core.Models.Base},System.Collections.Generic.List{Objects.BuiltElements.Revit.Parameter})">
<summary>
SchemaBuilder constructor for a Revit wall
</summary>
<param name="family"></param>
<param name="type"></param>
<param name="baseLine"></param>
<param name="level"></param>
<param name="height"></param>
<param name="baseOffset"></param>
<param name="topOffset"></param>
<param name="flipped"></param>
<param name="structural"></param>
<param name="elements"></param>
<param name="parameters"></param>
<remarks>Assign units when using this constructor due to <paramref name="height"/>, <paramref name="baseOffset"/>, and <paramref name="topOffset"/> params</remarks>
</member>
<member name="M:Objects.BuiltElements.Room.#ctor(System.String,System.String,Objects.BuiltElements.Level,Objects.Geometry.Point)">
<summary>
SchemaBuilder constructor for a Room
@@ -505,15 +444,6 @@
</summary>
<remarks>Assign units when using this constructor due to <see cref="P:Objects.BuiltElements.Room.height"/> prop</remarks>
</member>
<member name="M:Objects.BuiltElements.Wall.#ctor(System.Double,Objects.ICurve,System.Collections.Generic.List{Speckle.Core.Models.Base})">
<summary>
SchemaBuilder constructor for a Speckle wall
</summary>
<param name="height"></param>
<param name="baseLine"></param>
<param name="elements"></param>
<remarks>Assign units when using this constructor due to <paramref name="height"/> param</remarks>
</member>
<member name="T:Objects.Geometry.Arc">
<summary>
Represents a sub-curve of a three-dimensional circle.
@@ -1978,6 +1908,16 @@
if a native displayable object cannot be converted.
</summary>
</member>
<member name="T:Objects.ICivilCalculatedObject">
<summary>
Represents a calculated object for civil disciplines
</summary>
</member>
<member name="P:Objects.ICivilCalculatedObject.codes">
<summary>
<see cref="P:Objects.ICivilCalculatedObject.codes"/> for this calculated object.
</summary>
</member>
<member name="T:Objects.ObjectsKit">
<summary>
The default Speckle Kit
@@ -2088,6 +2028,16 @@
</summary>
<returns></returns>
</member>
<member name="P:Objects.Other.Civil.CivilDataField.context">
<summary>
The context type of the Civil3D part
</summary>
</member>
<member name="T:Objects.Other.DataField">
<summary>
Generic class for a data field
</summary>
</member>
<member name="T:Objects.Other.Dimension">
<summary>
Dimension class
@@ -2457,35 +2407,6 @@
<param name="orientationNode"></param>
<param name="orientationAngle"></param>
</member>
<member name="M:Objects.Structural.Geometry.Element1D.#ctor(Objects.Geometry.Line,Objects.Structural.Properties.Property1D,Objects.Structural.Geometry.ElementType1D,System.String,Objects.Structural.Geometry.Restraint,Objects.Structural.Geometry.Restraint,Objects.Geometry.Vector,Objects.Geometry.Vector,Objects.Geometry.Plane)">
<summary>
SchemaBuilder constructor for structural 1D element (based on local axis)
</summary>
<param name="baseLine"></param>
<param name="property"></param>
<param name="type"></param>
<param name="name"></param>
<param name="end1Releases"></param>
<param name="end2Releases"></param>
<param name="end1Offset"></param>
<param name="end2Offset"></param>
<param name="localAxis"></param>
</member>
<member name="M:Objects.Structural.Geometry.Element1D.#ctor(Objects.Geometry.Line,Objects.Structural.Properties.Property1D,Objects.Structural.Geometry.ElementType1D,System.String,Objects.Structural.Geometry.Restraint,Objects.Structural.Geometry.Restraint,Objects.Geometry.Vector,Objects.Geometry.Vector,Objects.Structural.Geometry.Node,System.Double)">
<summary>
SchemaBuilder constructor for structural 1D element (based on orientation node and angle)
</summary>
<param name="baseLine"></param>
<param name="property"></param>
<param name="type"></param>
<param name="name"></param>
<param name="end1Releases"></param>
<param name="end2Releases"></param>
<param name="end1Offset"></param>
<param name="end2Offset"></param>
<param name="orientationNode"></param>
<param name="orientationAngle"></param>
</member>
<member name="M:Objects.Structural.Geometry.Storey.#ctor(System.String,System.Double)">
<summary>
A storey in the structural model