RaptorCredit
One bundled third-party component and its licence.
| Namespace | Assembly | Kind | Stability |
|---|---|---|---|
Raptor.EditorTools | Raptor.Editor | class | preview, since 0.1.0 |
Register it with RaptorCredits.Register.
public sealed class RaptorCreditConstructors
RaptorCredit
public RaptorCredit(string id, string title, string component, string licence) : this(id, title, component, licence, (Func<string>)null)Creates a credit that uses the package's notices file as its licence text.
| Parameter | Type | Description |
|---|---|---|
id | string | Unique id (letters, digits, '.', '_' and '-'). |
title | string | What the component is used for (the row's title). |
component | string | The component's name as credited. |
licence | string | SPDX id or expression. |
RaptorCredit
public RaptorCredit(string id, string title, string component, string licence, Func<string> noticeAssetPath)Creates a credit whose licence path is resolved each time it is needed. Use this when the path depends on the install root.
| Parameter | Type | Description |
|---|---|---|
id | string | Unique id (letters, digits, '.', '_' and '-'). |
title | string | What the component is used for (the row's title). |
component | string | The component's name as credited. |
licence | string | SPDX id or expression. |
noticeAssetPath | Func<string> | Returns the project path of the licence text. Null uses the package's notices file. |
RaptorCredit
public RaptorCredit(string id, string title, string component, string licence, string noticeAssetPath) : this(id, title, component, licence, noticeAssetPath == null ? (Func<string>)null : () => noticeAssetPath)Creates a credit with licence text at a fixed project path.
| Parameter | Type | Description |
|---|---|---|
id | string | Unique id (letters, digits, '.', '_' and '-'). |
title | string | What the component is used for (the row's title). |
component | string | The component's name as credited. |
licence | string | SPDX id or expression. |
noticeAssetPath | string | Project path of the licence text, or null for the package's notices file. |
Properties
Component
public string Component { get; }Gets the component's name as credited (e.g. "Roboto Mono").
Id
public string Id { get; }Gets the unique id, which matches the component's row in the package's notices data. It may contain letters, digits, '.', '_' and '-'.
Licence
public string Licence { get; }Gets the licence as an SPDX id or expression.
NoticeAssetPath
public string NoticeAssetPath { get; }Gets the project path of the licence text (Assets/... or Packages/...), or null for the package's notices file.
Title
public string Title { get; }Gets what the component is used for, shown as the row's title (e.g. "Icons").
Related types
- RaptorCredits: Registry of bundled third-party components and their licences.