Interface IRelation
Base interface for relations.
Inherited Members
Namespace: StylelabsStylelabs.MSdkStylelabs.M.Sdk.ContractsBase
Assembly: Stylelabs.M.Sdk.dll
Syntax
Properties
Properties
Gets the properties of the linked entity.
Declaration
Property Value
| Type | Description |
|---|---|
| IDictionary<, >longIDictionary<, >stringJToken |
Gets the role of this instance in the relation.
Declaration
Property Value
| Type | Description |
|---|---|
| RelationRole |
Methods
Clear()
Clears the value(s) of the relation.
Declaration
GetIds()
This utility method allows getting the value of any type of relation.
In case of an IToManyRelation the result will contain all ids on the relation.
In case of an IToOneRelation the list can contain 1 id (maximum) if an id was set on the relation. If no id was set on the relation, an empty list is returned.
Declaration
Returns
| Type | Description |
|---|---|
| IList<>long | A list of ids (never null). |
SetIdentifiersAsync(IEnumerable)
Sets the ids on the relations values based on the given identifiers.
In case of an IToManyRelation, the list of ids will be set on the relation.
In case of an IToOneRelation, identifiers can have at most one value. If the list is empty then the value will be set to null.
Declaration
Parameters
| Type | Name | Description |
|---|---|---|
| IEnumerable<>string | identifiers | Identifiers. |
Returns
| Type | Description |
|---|---|
| Task | A representing the asynchronous operation. |
SetIds(IEnumerable)
Sets the ids on the relations values. The values should be strictly positive.
In case of an IToManyRelation, the list of ids will be set on the relation.
In case of an IToOneRelation, ids can have at most one value. If the list is empty then the value will be set to null.
Declaration
Parameters
| Type | Name | Description |
|---|---|---|
| IEnumerable<>long | ids | Ids. |