PublicApiAggregatedSymbol Class

A type or a member of an PublicApiAggregatedAssembly, identified by its documentation ID.

public sealed class PublicApiAggregatedSymbol

Properties

NameDescription
Assembly
DeclaringTypeGets the aggregated type that declares the symbol, or null for top-level types.
DifferencesGets the parts of the declaration that differ between the variants.
DocumentationId
ExtensionMembersGets the members of the C# 14 extension blocks of a static class, from all the target frameworks (see PublicApiType.ExtensionBlocks). They are matched by documentation ID and sorted as PublicApiAggregatedSymbol.Members.
IsAvailableInAllTargetFrameworks
Kind
MembersGets the members of a type, from all the target frameworks. They are sorted as PublicApiType.Members.
Name
NestedTypesGets the nested types of a type, from all the target frameworks.
SymbolsGets the symbol of each target framework of PublicApiAggregatedSymbol.TargetFrameworks, in the same order.
TargetFrameworksGets the target frameworks that declare the symbol.
VariantsGets the distinct declarations of the symbol. There is a single variant when all the target frameworks share the same declaration.
public PublicApiAggregatedAssembly Assembly { get; }

No documentation is available.

Gets the aggregated type that declares the symbol, or null for top-level types.

public PublicApiAggregatedSymbol? DeclaringType { get; }

Gets the parts of the declaration that differ between the variants.

public PublicApiSymbolDifferences Differences { get; }
public string DocumentationId { get; }

Property value

string

No documentation is available.

Gets the members of the C# 14 extension blocks of a static class, from all the target frameworks (see PublicApiType.ExtensionBlocks). They are matched by documentation ID and sorted as PublicApiAggregatedSymbol.Members.

public ImmutableArray<PublicApiAggregatedSymbol> ExtensionMembers { get; }

IsAvailableInAllTargetFrameworks

PublicApiAggregatedSymbol.cs
public bool IsAvailableInAllTargetFrameworks { get; }

Property value

bool

No documentation is available.

public PublicApiSymbolKind Kind { get; }

Property value

PublicApiSymbolKind

No documentation is available.

Gets the members of a type, from all the target frameworks. They are sorted as PublicApiType.Members.

public ImmutableArray<PublicApiAggregatedSymbol> Members { get; }
public string Name { get; }

Property value

string

No documentation is available.

Gets the nested types of a type, from all the target frameworks.

public ImmutableArray<PublicApiAggregatedSymbol> NestedTypes { get; }

Gets the symbol of each target framework of PublicApiAggregatedSymbol.TargetFrameworks, in the same order.

public ImmutableArray<PublicApiSymbol> Symbols { get; }

Gets the target frameworks that declare the symbol.

public ImmutableArray<string> TargetFrameworks { get; }

Gets the distinct declarations of the symbol. There is a single variant when all the target frameworks share the same declaration.

public ImmutableArray<PublicApiSymbolVariant> Variants { get; }

Methods

NameDescription
GetSymbol(string)Gets the symbol declared for a target framework, or null when the target framework does not declare it.
ToString()

Gets the symbol declared for a target framework, or null when the target framework does not declare it.

public PublicApiSymbol? GetSymbol(string targetFramework)

Parameters

targetFramework string

Returns

PublicApiSymbol?

public override string ToString()

Returns

string

No documentation is available.