Skip to main content

RtAssociationBaseQueryOptions

Namespace: Meshmakers.Octo.Runtime.Contracts.Repositories.Query

Represents basic query options for runtime associations

public record RtAssociationBaseQueryOptions : IEquatable<RtAssociationBaseQueryOptions>

Inheritance ObjectRtAssociationBaseQueryOptions
Implements IEquatable<RtAssociationBaseQueryOptions>

Properties

Direction

Gets the graph direction of the association.

public GraphDirections Direction { get; }

Property Value

GraphDirections

Skip

Gets if defined a value indicating how many associations are skipped

public Nullable<int> Skip { get; }

Property Value

Nullable<Int32>

Take

Gets if defined a value indicating how many associations are taken.

public Nullable<int> Take { get; }

Property Value

Nullable<Int32>

GlobalFilter

Represents global filter settings for the query.

public GlobalRtAssociationFilter GlobalFilter { get; private set; }

Property Value

GlobalRtAssociationFilter

Methods

Global(Boolean)

Defines global filter settings for runtime association queries

public RtAssociationBaseQueryOptions Global(bool includeArchived)

Parameters

includeArchived Boolean
When true, archived associations are returned by the data operation, otherwise not

Returns

RtAssociationBaseQueryOptions

Create(GraphDirections, Nullable<Int32>, Nullable<Int32>)

Creates a new instance of RtAssociationBaseQueryOptions.

public static RtAssociationBaseQueryOptions Create(GraphDirections direction, Nullable<int> skip, Nullable<int> take)

Parameters

direction GraphDirections
The graph direction for query

skip Nullable<Int32>
Number of items to skip

take Nullable<Int32>
Number of items to take

Returns

RtAssociationBaseQueryOptions