DeviceRepository.GetAll(Guid, String, Boolean) Method

GetAll

Namespace: Gamanet.C4.SDK
Assembly: Gamanet.C4.SimpleClient (in Gamanet.C4.SimpleClient.dll) Version: 2026.0.0.733
Syntax
C#
public ISimpleCollection<SimpleDeviceV1> GetAll(
	Guid rootId,
	string prefix,
	bool includeArchived
)

Parameters

rootId  Guid
The root identifier.
prefix  String
Prefix.
includeArchived  Boolean
Include archived

Return Value

ISimpleCollection<SimpleDeviceV1>
Devices

Implements

ISimpleClientDeviceRepositoryV1.GetAll(Guid, String, Boolean)
Exceptions
ExceptionCondition
ValidationException
Example
The following example illustrates how SimpleClient provides all device by data prefix
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();

        // You need to have installed the Demo Access Device package from https://my.c4portal.com/plugins/
        var exampleBusCategory = client.EntityDefinitions.Get(Guid.Parse("4810e0c6-9391-490c-a646-ca9643dd1ca5")).Id;

        // Create the Example Device
        var exampleDevice = new SimpleDeviceV1(
            Guid.NewGuid(),
            "BUS",
            EntityRoot.Device,
            exampleBusCategory
        );

        // Create device under device root in db
        client.Devices.Create(exampleDevice);

        // Archive the example device
        client.Devices.Archive(exampleDevice);

        var devices = client.Devices.GetAll(EntityRoot.DeviceSuperRoot, "prefix_", true);

        foreach (var device in devices)
        {
            Console.WriteLine($"Is device {device.Name} archived: {device.Archived}");
        }

        // Disconnect from server
        client.Disconnect();
    }
}
The following example illustrates how SimpleClient provides all device by data prefix
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();

        // You need to have installed the Demo Access Device package from https://my.c4portal.com/plugins/
        var exampleBusCategory = client.EntityDefinitions.Get(Guid.Parse("4810e0c6-9391-490c-a646-ca9643dd1ca5")).Id;
        // Create the Example Device
        var exampleDevice = new SimpleDeviceV1(
            Guid.NewGuid(),
            "BUS",
            EntityRoot.Device,
            exampleBusCategory
        );

        // Create device under device root in db
        client.Devices.Create(exampleDevice);

        // Archive the example device
        client.Devices.Archive(exampleDevice);

        var devices = client.Devices.GetAll(EntityRoot.DeviceSuperRoot, "prefix_", false);

        Console.WriteLine("Following is the list of devices found with prefix. Archived devices are not included");
        foreach (var device in devices)
        {
            Console.WriteLine($"Device name {device.Name}");
        }

        // Disconnect from server
        client.Disconnect();
    }
}
See Also

Reference

DeviceRepository Class
GetAll Overload
Gamanet.C4.SDK Namespace