Home > @uniformdev/canvas > RelationshipClient

RelationshipClient class

Signature:

Extends: ApiClient<ClientOptions & { projectId: string; }>

Constructors

<table><thead><tr><th>

Constructor

</th><th>

Modifiers

</th><th>

Description

</th></tr></thead> <tbody><tr><td>

(constructor)(options)

</td><td>

</td><td>

Constructs a new instance of the RelationshipClient class

</td></tr> </tbody></table>

Properties

<table><thead><tr><th>

Property

</th><th>

Modifiers

</th><th>

Type

</th><th>

Description

</th></tr></thead> <tbody><tr><td>

clearProjectRelationships

</td><td>

</td><td>

() => Promise<RelationshipsPostResponse>

</td><td>

</td></tr> <tr><td>

get

</td><td>

</td><td>

(options: ExceptProject<RelationshipsGetParameters>) => Promise<RelationshipsGetResponse>

</td><td>

</td></tr> <tr><td>

getVersion

</td><td>

</td><td>

() => Promise<UsageTrackingGetResponse['version']>

</td><td>

</td></tr> <tr><td>

indexRelationships

</td><td>

</td><td>

({ state, id, type }: IndexRelationshipsParameter) => Promise<{ success: boolean; }>

</td><td>

</td></tr> <tr><td>

setVersion

</td><td>

</td><td>

(version: UsageTrackingPostParameters['version']) => Promise<UsageTrackingPostResponse>

</td><td>

</td></tr> </tbody></table>