Region |
Archive existing region. All child regions in tree are archived too.
Namespace: Gamanet.C4.SDK
Assembly: Gamanet.C4.SimpleClient (in Gamanet.C4.SimpleClient.dll) Version: 2026.0.0.733
Syntax
C#
public void Archive( SimpleRegionV1 region )
Parameters
- region SimpleRegionV1
- The region.
Implements
ISimpleClientRegionRepositoryV1.Archive(SimpleRegionV1)Example
The following example illustrates how the SimpleClient Archives the single region.
The following example illustrates how the SimpleClient Archives the single region.
C#
using System; using Gamanet.C4.SDK; using Gamanet.C4.SimpleInterfaces; public class Example { static void Main() { // Create instance of simple client var client = new SimpleClient(ConnectorConfiguration.HttpClient); ConnectionInfoV1 token; // Connect to local server var connectionResult = client.Connect(new Uri("https://localhost/"), "Support", "support", out token); if (connectionResult != ConnectionResult.Successful) { Console.WriteLine("Connection unsuccessful, result: {0}", connectionResult); return; } Console.WriteLine("Connection result: {0}", connectionResult); Console.WriteLine(); // Create Example Region var exampleRegion = new SimpleRegionV1( Guid.NewGuid(), "ExampleRegion", EntityRoot.Region, RegionCategory.Region ); // Create Example Region in database client.Regions.Create(exampleRegion); // Check whether the region was created var createdRegion = client.Regions.Get(exampleRegion.Id, Properties.None); Console.WriteLine($"Created region name: {createdRegion.Name} -> Created region archived: {createdRegion.Archived}"); client.Regions.Archive(exampleRegion); var archivedRegion = client.Regions.Get(exampleRegion.Id,Properties.None); Console.WriteLine($"Created region name: {archivedRegion.Name} -> Created region archived: {archivedRegion.Archived}"); // Disconnect from server client.Disconnect(); } }
C#
using System; using Gamanet.C4.SDK; using Gamanet.C4.SimpleInterfaces; public class Example { static void Main() { // Create instance of simple client var client = new SimpleClient(ConnectorConfiguration.HttpClient); ConnectionInfoV1 token; // Connect to local server var connectionResult = client.Connect(new Uri("https://localhost/"), "Support", "support", out token); if (connectionResult != ConnectionResult.Successful) { Console.WriteLine("Connection unsuccessful, result: {0}", connectionResult); return; } Console.WriteLine("Connection result: {0}", connectionResult); Console.WriteLine(); // create new region under region root var parentRegion = new SimpleRegionV1( Guid.NewGuid(), "Main Office", EntityRoot.Region, RegionCategory.Region); // create region in db client.Regions.Create(parentRegion); // create new region under region var region = new SimpleRegionV1( Guid.NewGuid(), "Office", parentRegion.Id, RegionCategory.Region); // create region in db client.Regions.Create(region); client.Regions.Archive(parentRegion); var result = client.Regions.GetAll(parentRegion.Id, Properties.None, true); foreach (var item in result) { Console.WriteLine($"Region name: {item.Name} -> Region archived: {item.Archived}"); } // Disconnect from server client.Disconnect(); } }
See Also