# BookOnixCollateralText

Publisher-supplied supporting text, attribution and usage assertions. No content is fetched or inferred.

Class 

`OfficeIMO.Workflows`

**Namespace**

`OfficeIMO.Workflows`

**Assembly**

`OfficeIMO.Workflows`

**Source revision**

`3b680b1b6fb1` with working tree changes

**Source**

[BookOnixCollateralText.cs:100](https://github.com/EvotecIT/OfficeIMO/blob/3b680b1b6fb15a268ff5525a4ca6cdd70b2f6613/OfficeIMO.Workflows/Publishing/BookOnixCollateralText.cs#L100)

**Implements**

`IEquatable<BookOnixCollateralText>`

**Modifiers**

sealed

Publisher-supplied supporting text, attribution and usage assertions. No content is fetched or inferred.

## Inheritance

- object
- BookOnixCollateralText

## Usage

Explore 7 API references to this type

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

### Returned or exposed by 2

- Method [BookOnixCollateralText.<Clone>$](/api/workflows/officeimo-workflows-bookonixcollateraltext/#method-clone)
- Property [BookOnixExportOptions.CollateralTexts](/api/workflows/officeimo-workflows-bookonixexportoptions/#property-collateraltexts)

### Accepted by parameters 5

- Method [BookOnixCollateralText.Equals](/api/workflows/officeimo-workflows-bookonixcollateraltext/#method-equals-bookonixcollateraltext) parameter `other`
- Method [BookOnixCollateralText.op_Equality](/api/workflows/officeimo-workflows-bookonixcollateraltext/#method-op-equality-bookonixcollateraltext-bookonixcollateraltext) parameter `left`
- Method [BookOnixCollateralText.op_Equality](/api/workflows/officeimo-workflows-bookonixcollateraltext/#method-op-equality-bookonixcollateraltext-bookonixcollateraltext) parameter `right`
- Method [BookOnixCollateralText.op_Inequality](/api/workflows/officeimo-workflows-bookonixcollateraltext/#method-op-inequality-bookonixcollateraltext-bookonixcollateraltext) parameter `left`
- Method [BookOnixCollateralText.op_Inequality](/api/workflows/officeimo-workflows-bookonixcollateraltext/#method-op-inequality-bookonixcollateraltext-bookonixcollateraltext) parameter `right`

Filter members 

Show inherited

## Constructors

`public BookOnixCollateralText()` [#](#constructor-ctor)

[BookOnixCollateralText.cs:100](https://github.com/EvotecIT/OfficeIMO/blob/3b680b1b6fb15a268ff5525a4ca6cdd70b2f6613/OfficeIMO.Workflows/Publishing/BookOnixCollateralText.cs#L100)

`Obsolete("Constructors of types with required members are not supported in this version of your compiler.", true)`

## Methods

`public BookOnixCollateralText <Clone>$()` [#](#method-clone)

Returns

`BookOnixCollateralText`

Equals 2 overloads

`public override bool Equals(object? obj)` [#](#method-equals-object)

Parameters

**obj object? required**

Returns

`bool`

`public bool Equals(BookOnixCollateralText? other)` [#](#method-equals-bookonixcollateraltext)

Parameters

**other BookOnixCollateralText? required**

Returns

`bool`

`public override int GetHashCode()` [#](#method-gethashcode)

Returns

`int`

`public static bool op_Equality(BookOnixCollateralText? left, BookOnixCollateralText? right)` [#](#method-op-equality-bookonixcollateraltext-bookonixcollateraltext)

Parameters

**left BookOnixCollateralText? required**

**right BookOnixCollateralText? required**

Returns

`bool`

`public static bool op_Inequality(BookOnixCollateralText? left, BookOnixCollateralText? right)` [#](#method-op-inequality-bookonixcollateraltext-bookonixcollateraltext)

Parameters

**left BookOnixCollateralText? required**

**right BookOnixCollateralText? required**

Returns

`bool`

`public override string ToString()` [#](#method-tostring)

Returns

`string`

## Inherited Methods

`public Type GetType()` [#](#method-gettype)

Inherited from object

Returns

`Type`

## Properties

`public BookOnixTextType Type { get; init; }` [#](#property-type)

[BookOnixCollateralText.cs:90](https://github.com/EvotecIT/OfficeIMO/blob/3b680b1b6fb15a268ff5525a4ca6cdd70b2f6613/OfficeIMO.Workflows/Publishing/BookOnixCollateralText.cs#L90)

Purpose of this collateral item.

`public IReadOnlyList<BookOnixContentAudience> Audiences { get; init; }` [#](#property-audiences)

[BookOnixCollateralText.cs:92](https://github.com/EvotecIT/OfficeIMO/blob/3b680b1b6fb15a268ff5525a4ca6cdd70b2f6613/OfficeIMO.Workflows/Publishing/BookOnixCollateralText.cs#L92)

One to 13 distinct recipient codes; must be explicitly supplied.

`public IReadOnlyList<BookOnixCollateralTextValue> Texts { get; init; }` [#](#property-texts)

[BookOnixCollateralText.cs:94](https://github.com/EvotecIT/OfficeIMO/blob/3b680b1b6fb15a268ff5525a4ca6cdd70b2f6613/OfficeIMO.Workflows/Publishing/BookOnixCollateralText.cs#L94)

One to 16 language variants; repeated variants require distinct explicit languages; at most 65,536 UTF-16 code units each, with a 524,288-unit aggregate per export including source titles, rating units, license names, license expression links, supporting-resource notes, filenames and links.

`public BookOnixReviewRating? ReviewRating { get; init; }` [#](#property-reviewrating)

[BookOnixCollateralText.cs:96](https://github.com/EvotecIT/OfficeIMO/blob/3b680b1b6fb15a268ff5525a4ca6cdd70b2f6613/OfficeIMO.Workflows/Publishing/BookOnixCollateralText.cs#L96)

Optional publisher-supplied score for review text types only; no scale or units are inferred.

`public BookOnixTerritory? Territory { get; init; }` [#](#property-territory)

[BookOnixCollateralText.cs:98](https://github.com/EvotecIT/OfficeIMO/blob/3b680b1b6fb15a268ff5525a4ca6cdd70b2f6613/OfficeIMO.Workflows/Publishing/BookOnixCollateralText.cs#L98)

Optional territory where the collateral may be used, independent of product sales rights.

`public IReadOnlyList<string> Authors { get; init; }` [#](#property-authors)

[BookOnixCollateralText.cs:100](https://github.com/EvotecIT/OfficeIMO/blob/3b680b1b6fb15a268ff5525a4ca6cdd70b2f6613/OfficeIMO.Workflows/Publishing/BookOnixCollateralText.cs#L100)

At most 16 author names for this text, distinct from book contributors.

`public string? SourceCorporate { get; init; }` [#](#property-sourcecorporate)

[BookOnixCollateralText.cs:102](https://github.com/EvotecIT/OfficeIMO/blob/3b680b1b6fb15a268ff5525a4ca6cdd70b2f6613/OfficeIMO.Workflows/Publishing/BookOnixCollateralText.cs#L102)

Optional corporate source of this text.

`public IReadOnlyList<BookOnixCollateralTextValue> SourceTitles { get; init; }` [#](#property-sourcetitles)

[BookOnixCollateralText.cs:104](https://github.com/EvotecIT/OfficeIMO/blob/3b680b1b6fb15a268ff5525a4ca6cdd70b2f6613/OfficeIMO.Workflows/Publishing/BookOnixCollateralText.cs#L104)

At most 16 language variants of the publication/source title; repeated variants require distinct explicit languages; at most 4096 UTF-16 code units each.

`public IReadOnlyList<string> SourceLinks { get; init; }` [#](#property-sourcelinks)

[BookOnixCollateralText.cs:106](https://github.com/EvotecIT/OfficeIMO/blob/3b680b1b6fb15a268ff5525a4ca6cdd70b2f6613/OfficeIMO.Workflows/Publishing/BookOnixCollateralText.cs#L106)

At most 16 distinct absolute HTTP(S) source links without credentials. Export does not fetch them.

`public IReadOnlyList<BookOnixUsageConstraint> UsageConstraints { get; init; }` [#](#property-usageconstraints)

[BookOnixCollateralText.cs:108](https://github.com/EvotecIT/OfficeIMO/blob/3b680b1b6fb15a268ff5525a4ca6cdd70b2f6613/OfficeIMO.Workflows/Publishing/BookOnixCollateralText.cs#L108)

Up to 32 explicit usage constraints. No permissions are inferred or enforced.

`public IReadOnlyList<BookOnixLicense> Licenses { get; init; }` [#](#property-licenses)

[BookOnixCollateralText.cs:110](https://github.com/EvotecIT/OfficeIMO/blob/3b680b1b6fb15a268ff5525a4ca6cdd70b2f6613/OfficeIMO.Workflows/Publishing/BookOnixCollateralText.cs#L110)

Up to 16 explicit collateral licenses. Names and expression links share the aggregate text budget.

`public DateTime? PublishedOn { get; init; }` [#](#property-publishedon)

[BookOnixCollateralText.cs:112](https://github.com/EvotecIT/OfficeIMO/blob/3b680b1b6fb15a268ff5525a4ca6cdd70b2f6613/OfficeIMO.Workflows/Publishing/BookOnixCollateralText.cs#L112)

Publication date of the collateral, independent of the book's publication date. Time of day is ignored during export.

`public DateTime? UsableFrom { get; init; }` [#](#property-usablefrom)

[BookOnixCollateralText.cs:114](https://github.com/EvotecIT/OfficeIMO/blob/3b680b1b6fb15a268ff5525a4ca6cdd70b2f6613/OfficeIMO.Workflows/Publishing/BookOnixCollateralText.cs#L114)

First permitted use date (embargo). Serialized, not enforced as an access-control rule. Time of day is ignored during export.

`public DateTime? UsableUntil { get; init; }` [#](#property-usableuntil)

[BookOnixCollateralText.cs:116](https://github.com/EvotecIT/OfficeIMO/blob/3b680b1b6fb15a268ff5525a4ca6cdd70b2f6613/OfficeIMO.Workflows/Publishing/BookOnixCollateralText.cs#L116)

Last permitted use date. Time of day is ignored during export.

`public DateTime? UpdatedOn { get; init; }` [#](#property-updatedon)

[BookOnixCollateralText.cs:118](https://github.com/EvotecIT/OfficeIMO/blob/3b680b1b6fb15a268ff5525a4ca6cdd70b2f6613/OfficeIMO.Workflows/Publishing/BookOnixCollateralText.cs#L118)

Date the collateral was last updated. Time of day is ignored during export.

<!-- PowerForge markdown artifact sha256:33807605B3453621AAAE440B2840B6E02980647DF0955ADE4D1B78822C8D53D4 -->
