Skip to main content
How an entitlement field’s values name entitlements: the object kind they are on, the relation and scope kind the field pins, and the item property holding each part.
Implements: EntitlementShape

Constructors

How an entitlement field’s values name entitlements: the object kind they are on, the relation and scope kind the field pins, and the item property holding each part.

Parameters

string
required
The field’s key.
string
required
The object or resource kind its entitlements are on.
string
required
The relation a value that names none is, or null.
string
required
The resource kind a role it grants is held at, or null.
IReadOnlyDictionary<EntitlementPart,String>
required
Type: EntitlementPartThe item property holding each part, for a field whose values are records.

Properties

string
required
The field’s key.
string
required
The object or resource kind its entitlements are on.
IReadOnlyDictionary<EntitlementPart,String>
required
Type: EntitlementPartThe item property holding each part, for a field whose values are records.
string
The relation a value that names none is, or null.
string
The resource kind a role it grants is held at, or null.

Methods

Deconstruct()

Parameters

string
required
string
required
string
required
string
required
IReadOnlyDictionary<EntitlementPart,String>
required

Equals()

Parameters

Returns

bool

Parameters

object
required

Returns

bool

GetHashCode()

Returns

int

GrantOf()

Reads one value of the field as the grant of it a holder has.

Parameters

required
string
required

Returns

Grant

KeyOf()

Names the entitlement a value grants and how it is held, so two values that grant the same one the same way have the same key whatever their spelling. A value that cannot be read keys as its text.

Parameters

string
required

Returns

string

ObjectIdOf()

Names the object a value is on, as the catalog lists it: its ID, or the value itself when it cannot be read.

Parameters

string
required

Returns

string

Of()

Parameters

Returns

EntitlementShape

operator !=()

Parameters

Returns

bool

operator ==()

Parameters

Returns

bool

RelationOf()

Names the relation a value is, or null when it cannot be read.

Parameters

string
required

Returns

string

ToString()

Returns

string

ValueOf()

Writes a grant as a value of the field: the entitlement’s ID, or for a field whose values are records, a record of its parts and properties in ordinal key order.

Parameters

required

Returns

string