Class ScopedObject

An object reduced to a certain scope of language and variants

Inheritance
object
ScopedObject
Inherited Members
Namespace: Noxum.Nova.Delivery.Client
Assembly: Noxum.Nova.Delivery.Client.dll
Syntax
public class ScopedObject

Properties

DisplayIcon

The ID of the display icon

Declaration
[JsonPropertyName("displayIcon")]
public int DisplayIcon { get; set; }
Property Value
Type Description
int

DisplayName

The display name for the UI language

Declaration
[JsonPropertyName("displayName")]
public string DisplayName { get; set; }
Property Value
Type Description
string

Meta

The meta data

Declaration
[JsonPropertyName("meta")]
public ObjectMetadata Meta { get; set; }
Property Value
Type Description
ObjectMetadata

Props

The dictionary of properties. Use API identifiers as keys. This dictionary contains values for the desired scope only.

Declaration
[JsonPropertyName("props")]
public IDictionary<string, object> Props { get; set; }
Property Value
Type Description
IDictionary<string, object>

Reverse

The dictionary of reverse relations. Use API identifiers as keys.
The values are list of object IDs of objects that have the current object as their value for the desired attribute.

Declaration
[JsonPropertyName("reverse")]
public IDictionary<string, IList<int>> Reverse { get; set; }
Property Value
Type Description
IDictionary<string, IList<int>>

SortReverse

This dictionary contains an entry for each API identifier in Props that belongs to an attribute of type ObjRef that supports reverse sorting.
Values are either scalar integers or arrays of integers (if the attribute supports multiple values).

Declaration
[JsonPropertyName("sortReverse")]
public IDictionary<string, object> SortReverse { get; set; }
Property Value
Type Description
IDictionary<string, object>

Methods

GetReverseSortKey(string)

Try to get the reverse sort key of a scalar value by apiIdentifier

Declaration
public int? GetReverseSortKey(string apiIdentifier)
Parameters
Type Name Description
string apiIdentifier
Returns
Type Description
int?

GetReverseSortKeys(string)

Try to get the reverse sort keys of a multiple value by apiIdentifier

Declaration
public int[] GetReverseSortKeys(string apiIdentifier)
Parameters
Type Name Description
string apiIdentifier
Returns
Type Description
int[]

GetValue<T>(string)

Try to get a scalar value by apiIdentifier

Declaration
public T GetValue<T>(string apiIdentifier)
Parameters
Type Name Description
string apiIdentifier
Returns
Type Description
T
Type Parameters
Name Description
T

GetValues<T>(string)

Try to get a multiple value by apiIdentifier

Declaration
public T[] GetValues<T>(string apiIdentifier) where T : class
Parameters
Type Name Description
string apiIdentifier
Returns
Type Description
T[]
Type Parameters
Name Description
T