Skip to content
Meshline
SDK 1.1.0 · TypeView source on GitHub

Developer guide · API index

Members on this page

Meshline.Sdk

Meshline.Models.Protocol

GroupState Class

Contains the relay-visible metadata, membership count, and lifecycle state of a group.

public sealed record GroupState : Meshline.Models.Protocol.ProtocolModel, System.IEquatable<Meshline.Models.Protocol.GroupState>

Inheritance System.Object → ProtocolModel → GroupState

Implements System.IEquatable<GroupState>

Properties

GroupState.Description Property

The optional human-readable description.

public string? Description { get; init; }

Property Value

System.String

GroupState.GroupId Property

The group's canonical grp_ identifier.

public string GroupId { get; init; }

Property Value

System.String

GroupState.InvitePolicy Property

The policy controlling which members can create invitations.

public Meshline.Models.Protocol.GroupInvitePolicy InvitePolicy { get; init; }

Property Value

GroupInvitePolicy

GroupState.MemberCapacity Property

The maximum permitted number of group members.

public long MemberCapacity { get; init; }

Property Value

System.Int64

GroupState.MemberCount Property

The current number of group members reported by the relay.

public long MemberCount { get; init; }

Property Value

System.Int64

GroupState.Name Property

The display name.

public string Name { get; init; }

Property Value

System.String

GroupState.Owner Property

The CAIP-10 account identifier of the current group owner.

public string Owner { get; init; }

Property Value

System.String

GroupState.Status Property

Whether the group is active or closed.

public Meshline.Models.Protocol.GroupStatus Status { get; init; }

Property Value

GroupStatus

Methods

GroupState.Validate(NetworkContext) Method

Validates member counts, capacity, lifecycle state, invitation policy, metadata, and the owner account.

public override Meshline.Validation.ProtocolViolation? Validate(Meshline.Models.NetworkContext? context=null);

Parameters

context NetworkContext

The optional network context; these field checks do not depend on it.

Returns

ProtocolViolation
The first detected protocol violation, or null if the implemented checks pass.

Exceptions

System.NotSupportedException
The group owner's account namespace is unsupported.