API Class Overview

Top  Previous  Next

There are two client classes that act as starting points for accessing the Web3 services, the TopicMapServiceClient and the SchemaServiceClient. Both classes are located in the NetworkedPlanet.Web3.Platform.Service.Client namespace. The SchemaServiceClient has just a few methods to fetch and save a schema or list the schemas that are managed by a particular Web3 instance. All changes to a schema are made locally and when saved back to the server replace the existing schema or are stored as a new schema. The TopicMapServiceClient is used to fetch a TopicMap object. This object can be considered a context in which changes made to any topic, association or property are tracked and when Save is called on the TopicMap object the transaction is sent to the server. The TopicMap object can be used to retrieve more topics and associations from the server. When these objects are retrieved they are added into the current context. The intended way to use the API is to get an object, modify it and then save the transaction. There are no guarantees that getting an object twice will return the same wrapped client object

 

All collections in the Web3 service are paged. This means that even fetching the associations for a given topic may require a few requests if the number is large.