SpeckleCore2 Gets the current user. If provided, retrieves th user with this user Id Gets the current user. If provided, retrieves th user with this user Id Searches for a user on the server. String to search for. Must be at least 3 characters Max number of users to return Searches for a user on the server. String to search for. Must be at least 3 characters Max number of users to return Gets a stream by id including basic branch info (id, name, description, and total commit count). For detailed commit and branch info, use StreamGetCommits and StreamGetBranches respectively. Id of the stream to get Max number of branches to retrieve Gets a stream by id including basic branch info (id, name, description, and total commit count). For detailed commit and branch info, use StreamGetCommits and StreamGetBranches respectively. Id of the stream to get Max number of branches to retrieve Gets all streams for the current user Max number of streams to return Gets all streams for the current user Max number of streams to return Gets all favorite streams for the current user Max number of streams to return Searches the user's streams by name, description, and ID String query to search for Max number of streams to return Searches the user's streams by name, description, and ID String query to search for Max number of streams to return Creates a stream. The stream's id. Creates a stream. The stream's id. Updates a stream. Note: the id field needs to be a valid stream id. The stream's id. Updates a stream. Note: the id field needs to be a valid stream id. The stream's id. Deletes a stream. Id of the stream to be deleted Deletes a stream. Id of the stream to be deleted Grants permissions to a user on a given stream. Grants permissions to a user on a given stream. Revokes permissions of a user on a given stream. Revokes permissions of a user on a given stream. Sends an email invite to join a stream and assigns them a collaborator role. Sends an email invite to join a stream and assigns them a collaborator role. Get branches from a given stream Id of the stream to get the branches from Max number of branches to retrieve Max number of commits to retrieve Get branches from a given stream Id of the stream to get the branches from Max number of branches to retrieve Max number of commits to retrieve Creates a branch on a stream. The stream's id. Creates a branch on a stream. The stream's id. Gets a given branch from a stream. Id of the stream to get the branch from Name of the branch to get Gets a given branch from a stream. Id of the stream to get the branch from Name of the branch to get Updates a branch. The stream's id. Updates a branch. The stream's id. Deletes a stream. Deletes a stream. Gets a given commit from a stream. Id of the stream to get the commit from Id of the commit to get Gets a given commit from a stream. Id of the stream to get the commit from Id of the commit to get Gets the latest commits from a stream Id of the stream to get the commits from Max number of commits to get Gets the latest commits from a stream Id of the stream to get the commits from Max number of commits to get Creates a commit on a branch. The commit id. Creates a commit on a branch. The commit id. Updates a commit. The stream's id. Updates a commit. The stream's id. Deletes a commit. Deletes a commit. Gets the activity of a stream Id of the stream to get the commits from Only show activity after this DateTime Only show activity before this DateTime Time to filter the activity with Time to filter the activity with Max number of activity items to get Gets the activity of a stream Id of the stream to get the commits from Only show activity after this DateTime Only show activity before this DateTime Time to filter the activity with Time to filter the activity with Max number of commits to get Gets a given object from a stream. Id of the stream to get the object from Id of the object to get Gets a given object from a stream. Id of the stream to get the object from Id of the object to get Gets a given object from a stream. Gets a given object from a stream. Subscribe to events of branch created for a stream Subscribe to events of branch updated for a stream Subscribe to events of branch deleted for a stream Subscribe to events of commit created for a stream Subscribe to events of commit updated for a stream Subscribe to events of commit updated for a stream Subscribe to events of streams added for the current user Subscribe to events of streams updated for a specific streamId streamId Subscribe to events of streams removed for the current user Set only in the case that you've requested this through . Set only in the case that you've requested this through . Set only in the case that you've requested this through Helper method to Receive from a Speckle Server. Stream URL or Id to receive from. If the URL contains branchName, commitId or objectId those will be used, otherwise the latest commit from main will be received. Account to use. If not provided the default account will be used. Action invoked on progress iterations. Action invoked on internal errors. Action invoked once the total count of objects is known. Helper method to Send to a Speckle Server. Stream URL or Id to send to. If the URL contains branchName, commitId or objectId those will be used, otherwise the latest commit from main will be received. Data to send Account to use. If not provided the default account will be used. Toggle for the default cache. If set to false, it will only send to the provided transports. Action invoked on progress iterations. Action invoked on internal errors. The connector slug eg. revit, rhino, etc Convenience method to instantiate an instance of the default object serializer and settings pre-populated with it. Receives an object from a transport. The transport to receive from. Leave null to use the default cache. Action invoked on progress iterations. Action invoked on internal errors. Action invoked once the total count of objects is known. Receives an object from a transport. A cancellation token that can be used by other objects or threads to send notice of cancellation. The transport to receive from. Leave null to use the default cache. Action invoked on progress iterations. Action invoked on internal errors. Action invoked once the total count of objects is known. Sends an object via the provided transports. Defaults to the local cache. The object you want to send. Where you want to send them. Toggle for the default cache. If set to false, it will only send to the provided transports. Action that gets triggered on every progress tick (keeps track of all transports). Use this to capture and handle any errors from within the transports. The id (hash) of the object. Sends an object via the provided transports. Defaults to the local cache. The object you want to send. A cancellation token that can be used by other objects or threads to send notice of cancellation. Where you want to send them. Toggle for the default cache. If set to false, it will only send to the provided transports. Action that gets triggered on every progress tick (keeps track of all transports). Use this to capture and handle any errors from within the transports. The id (hash) of the object. Serializes a given object. Note: if you want to save and persist an object to a Speckle Transport or Server, please use any of the "Send" methods. See . A json string representation of the object. Serializes a given object. Note: if you want to save and persist an object to Speckle Transport or Server, please use any of the "Send" methods. See . Propagates notification that operations should be canceled. A json string representation of the object. Serializes a list of objects. Note: if you want to save and persist objects to speckle, please use any of the "Send" methods. Serializes a list of objects. Note: if you want to save and persist objects to speckle, please use any of the "Send" methods. Deserializes a given object. Note: if you want to pull an object from a Speckle Transport or Server, please use any of the . The json string representation of a speckle object that you want to deserialise. Deserializes a given object. Note: if you want to pull an object from a Speckle Transport or Server, please use any of the . The json string representation of a speckle object that you want to deserialise. Propagates notification that operations should be canceled. Deserializes a list of objects into an array. Note: if you want to pull an object from speckle (either local or remote), please use any of the "Receive" methods. Deserializes a dictionary object. Note: if you want to pull an object from speckle (either local or remote), please use any of the "Receive" methods. Manage accounts locally for desktop applications. Gets the basic information about a server. Server URL Gets basic user information given a token and a server. Server URL Gets basic user and server information given a token and a server. Server URL The Default Server URL for authentication, can be overridden by placing a file with the alternatrive url in the Speckle folder Gets all the accounts for a given server. Gets this environment's default account if any. If there is no default, the first found will be returned and set as default. The default account or null. Gets all the accounts present in this environment. Gets the local accounts These are accounts not handled by Manager and are stored in json format in a local directory Refetches user and server info for each account Removes an account ID of the account to remove Adds an account by propting the user to log in via a web flow Server to use to add the account, if not provied the default Server will be used Determines if the current stream wrapper contains a valid stream. Creates a StreamWrapper from a stream url or a stream id Stream Url eg: http://speckle.server/streams/8fecc9aa6d/commits/76a23d7179 or stream ID eg: 8fecc9aa6d Creates a StreamWrapper by streamId, userId and serverUrl Gets a valid account for this stream wrapper. Note: this method ensures that the stream exists and/or that the user has an account which has access to that stream. If used in a sync manner, make sure it's not blocking. Throws exception if account fetching failed. This could be due to non-existent account or stream. The valid account object for this stream. List of Host Applications - their slugs should match our ghost tags and ci/cd slugs List of Host Applications with their versions Do not change these - they must match the converter names! Used to indicate which is the main input parameter of the schema builder component. Schema info will be attached to this object. Used to ignore properties from expand objects etc Keeps track of the conversion process Decides what to do when an element being received already exists Converts a native object to a Speckle one Native object to convert Converts a list of objects to Speckle. Checks if it can convert a native object to a Speckle one Native object to convert Converts a Speckle object to a native one Speckle object to convert Converts a list of Speckle objects to a native ones. Checks if it can convert a Speckle object to a native one Speckle object to convert Returns a list of applications serviced by this converter Sets the application document that the converter is targeting The current application document Some converters need to know which other objects are being converted, in order to sort relationships between them (ie, Revit). Use this method to set them. Some converters need to know which objects have been converted before in order to update them (ie, Revit). Use this method to set them. Some converters need to be able to receive some settings to modify their internal behaviour (i.e. Rhino's Brep Meshing options). Use this method to set them. The object representing the settings for your converter. Returns all the object types (the object model) provided by this kit. Tries to load a converter for a specific app. Must be one of the Kits.Applications variables. The converter for the specific app, or null. Needed so we can properly deserialize all the Base-derived objects from Core itself. Local installations store kits in C:\Users\USERNAME\AppData\Roaming\Speckle\Kits Admin/System-wide installations in C:\ProgramData\Speckle\Kits Checks wether a specific kit exists. Gets a specific kit. Returns a list of all the kits found on this user's device. Returns a list of all the types found in all the kits on this user's device. Gets the default Speckle provided kit, "Objects". TODO: Returns all the kits with potential converters for the software app. Tells the kit manager to initialise from a specific location. Indicates if a given assembly references another which is identified by its name. The assembly which will be probed. The reference assembly name. A boolean value indicating if there is a reference. Anonymous telemetry to help us understand how to make a better Speckle. This really helps us to deliver a better open source project and product! Default Mixpanel events Event triggered when data is sent to a Speckle Server Event triggered when data is received from a Speckle Server Event triggered when a node is executed in a visual programming environment, it should contain the name of the action and the host application Event triggered when an action is executed in Desktop UI, it should contain the name of the action and the host application Event triggered when a node is first created in a visual programming environment, it should contain the name of the action and the host application Cached email Cached server URL Tracks an event without specifying the email and server. It's not always possible to know which account the user has selected, especially in visual programming. Therefore we are caching the email and server values so that they can be used also when nodes such as "Serialize" are used. If no account info is cached, we use the default account data. Name of the even Additional parameters to pass in to event Tracks an event from a specified account, anonymizes personal information Account to use, it will be anonymized Name of the event Additional parameters to pass to the event Tracks an event from a specified email and server, anonymizes personal information Email of the user, it will be anonymized Server URL, it will be anonymized Name of the event Additional parameters to pass to the event Anonymous telemetry to help us understand how to make a better Speckle. This really helps us to deliver a better open source project and product! Anonymous telemetry to help us understand how to make a better Speckle. This really helps us to deliver a better open source project and product! Set from the connectors, defines which current host application we're running on. Set from the connectors, defines which current host application we're running on - includes the version. Tries to get the SUUID set by the Manager Flags an object's property as being detachable. If set to true the default serialiser will persist it separately, and add a reference to the property's value in the original object. Only applies to properties of types derived from the Base class. Flags an object's property as being detachable. If set to true the default serialiser will persist it separately, and add a reference to the property's value in the original object. Only applies to properties of types derived from the Base class. Wether to detach the property or not. Flags a list or array as splittable into chunks during serialisation. These chunks will be recomposed on deserialisation into the original list. Note: this attribute should be used in conjunction with . Use this attribute on properties that can become very long and are not worth detaching into individual elements. Objects per chunk: for simple types, like numbers, use a high value (>10000); for other objects, use a more conservative number depending on their serialised size. Base class for all Speckle object definitions. Provides unified hashing, type extraction and serialisation. When developing a speckle kit, use this class as a parent class. Dynamic properties naming conventions: 👉 "__" at the start of a property means it will be ignored, both for hashing and serialisation (e.g., "__ignoreMe"). 👉 "@" at the start of a property name means it will be detached (when serialised with a transport) (e.g.((dynamic)obj)["@meshEquivalent"] = ...) . A speckle object's id is an unique hash based on its properties. NOTE: this field will be null unless the object was deserialised from a source. Use the function to get it. Gets the id (a unique hash) of this object. ⚠️ This method fully serializes the object, which in the case of large objects (with many sub-objects), has a tangible cost. Avoid using it! Hint: Objects that are retrieved/pulled from a server/local cache do have an id (hash) property pre-populated. Note:The hash of a decomposed object differs from the hash of a non-decomposed object. If true, will decompose the object in the process of hashing. Attempts to count the total number of detachable objects. The total count of the detachable children + 1 (itself). Creates a shallow copy of the current base object. This operation does NOT copy/duplicate the data inside each prop. The new object's property values will be pointers to the original object's property value. A shallow copy of the original object. This property will only be populated if the object is retreieved from storage. Use otherwise. Secondary, ideally host application driven, object identifier. Holds the type information of this speckle object, derived automatically from its assembly name and inheritance. Base class implementing a bunch of nice dynamic object methods, like adding and removing props dynamically. Makes c# feel like json. Orginally adapted from Rick Strahl 🤘 https://weblog.west-wind.com/posts/2012/feb/08/creating-a-dynamic-extensible-c-expando-object The actual property bag, where dynamically added props are stored. Gets properties via the dot syntax. 
((dynamic)myObject).superProperty;
 Sets properties via the dot syntax. 
((dynamic)myObject).superProperty = something;
 Sets and gets properties using the key accessor pattern. E.g.: 
((dynamic)myObject)["superProperty"] = 42;
 Gets all of the property names on this class, dynamic or not. Gets the names of the defined class properties (typed). Gets the defined (typed) properties of this object. Gets the names of the typed and dynamic properties that don't have a [SchemaIgnore] attribute. Gets the typed and dynamic properties that don't have a [SchemaIgnore] attribute. Gets the dynamically added property names only. Currently we assume having only 1 property means we auto-wrap it around a DynamicBase, therefore is a wrapper. This might change in the future. Wrapper around other, third party, classes that are not coming from a speckle kit. Serialization and deserialization of the base object happens through default Newtonsoft converters. If your object does not de/serialize correctly, this class will not prevent that from happening. Limitations: - Base object needs to be serializable. - Inline collection declarations with values do not behave correctly. - Your class needs to have a void constructor. - Probably more. File a bug! The original object. See for limitations of this approach. See for limitations of this approach. In short, this helps you chunk big things into smaller things. See the following reference. A simple wrapper to keep track of the relationship between speckle objects and their host-application siblings in cases where the cannot correspond with the (ie, on receiving operations). Keeps track of the conversion process Keeps track of errors in the conversions. Keeps track of errors in the operations of send/receive. Wrapper method around hashing functions. Defaults to md5. Chunks a list into pieces. Property that describes the type of the object. The sync transport. This transport will be used synchronously. Property that describes the type of the object. The sync transport. This transport will be used synchronously. List of transports to write to. Keeps track of wether current property pointer is marked for detachment. Keeps track of the hash chain through the object tree. Dictionary of object if and its subsequent closure table (a dictionary of hashes and min depth at which they are found). Reinitializes the lineage, and other variables that get used during the json writing process. Property that describes the type of the object. The sync transport. This transport will be used synchronously. 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. Interface defining the contract for transport implementations. Should be checked often and gracefully stop all in progress sending if requested. Used to report progress during the transport's longer operations. Used to report errors during the transport's longer operations. Optional: signals to the transport that writes are about to begin. Optional: signals to the transport that no more items will need to be written. Saves an object. The hash of the object. The full string representation of the object. Saves an object, retrieveing its serialised version from the provided transport. The hash of the object. The transport from where to retrieve it. Awaitable method to figure out whether writing is completed. Gets an object. The object's hash. Copies the parent object and all its children to the provided transport. The id of the object you want to copy. The transport you want to copy the object to. (Optional) an action that will be invoked once, when the amount of object children to be copied over is known. The string representation of the root object. Checks if objects are present in the transport List of object ids to check A dictionary with the specified object ids as keys and boolean values, whether each object is present in the transport or not An in memory storage of speckle objects. Sends data to a speckle server. TODOs: - gzip - preflight deltas on sending data - preflight deltas on receving/copying data to an existing transport? https://cymbeline.ch/2014/03/16/gzip-encoding-an-http-post-request-body/ https://cymbeline.ch/2014/03/16/gzip-encoding-an-http-post-request-body/ Callback when sending batches. Parameters: object count, total bytes sent Timer that ensures queue is consumed if less than MAX_TRANSACTION_SIZE objects are being sent. Awaits untill write completion (ie, the current queue is fully consumed). Returns true if the current write queue is empty and comitted. Adds an object to the saving queue. Directly saves the object in the db. Gets an object. Returns all the objects in the store. Note: do not use for large collections. Deletes an object. Note: do not use for any speckle object transport, as it will corrupt the database. Updates an object. Waits until the provided function returns true.