Skip to content

Commit

Permalink
feat: use more appropriate links
Browse files Browse the repository at this point in the history
  • Loading branch information
@britsta
britsta committed Dec 17, 2024
1 parent 02f532d commit 2cdfc88
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions _docs_integrate/data-model-overview.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -86,14 +86,14 @@ A RelationshipTemplate serves two purposes:

### PasswordProtection

A [RelationshipTemplate](#relationshiptemplate) can be protected by a password to ensure that it is protected from unauthorized access.
Indeed, in order for a peer to [establish a Relationship]({% link _docs_integrate/establish-relationships.md %}) to the creator of the password protected RelationshipTemplate, it must enter the correct password when loading the RelationshipTemplate.
Whether a RelationshipTemplate is protected by a password or not is recorded within its `passwordProtection` property.

| Name | Type | Description | Remarks |
| ------------- | --------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- |
| password | `string` | The password of the RelationshipTemplate. | |
| passwordIsPin | `true` \| `undefined` | If the password of the RelationshipTemplate consists only of numbers, the value of the `passwordIsPin` property can be set to `true`. In this case, the password is interpreted as a pin and a corresponding input field is displayed in the UI of the App when the pin needs to be entered. However, if the value is `undefined`, a regular input field for entering the password is displayed regardless of whether the password could also be interpreted as a pin because it only consists of numbers. | |
A [RelationshipTemplate can be protected by a password]({% link _docs_integrate/establish-relationships.md %}#password-protection-of-a-relationshiptemplate) to ensure that it is protected from unauthorized access.
Indeed, in order for a peer to [establish a Relationship]({% link _docs_integrate/establish-relationships.md %}) to the creator of the password protected RelationshipTemplate, it must enter the correct password when [loading the RelationshipTemplate]({% link _docs_use-cases/use-case-transport-load-relationshiptemplate-created-by-others.md %}).
Information about the password protection of a [RelationshipTemplate](#relationshiptemplate) is recorded within its optional `passwordProtection` property.

| Name | Type | Description | Remarks |
| ------------- | --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------- |
| password | `string` | The password of the RelationshipTemplate. | |
| passwordIsPin | `true` \| `undefined` | If the password of the RelationshipTemplate consists of 4 to 16 digits, the value of the `passwordIsPin` property can be set to `true`. In this case, the password is interpreted as a pin and a corresponding input field is displayed in the UI of the App when the pin needs to be entered. However, if the value is `undefined`, a regular input field for entering the password is displayed regardless of whether the password could also be interpreted as a pin. | |

## Relationship

Expand Down

0 comments on commit 2cdfc88

Please sign in to comment.