Skip to content

Commit d7f3e31

Browse files
committed
Added method signatures for link retrieval
1 parent 3eac413 commit d7f3e31

1 file changed

Lines changed: 40 additions & 12 deletions

File tree

docs/link-handling/index.md

Lines changed: 40 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -13,26 +13,54 @@ All endpoints provide methods for resolving links:
1313

1414
=== "C#"
1515

16-
- `GetLinks(rel)` - Resolves all links with a specific relation type
17-
- `Link(rel)` - Resolves a single link with a specific relation type
18-
- `LinkTemplate(rel, variables)` - Resolves a link template with variables
16+
```csharp
17+
// Resolves all links with a specific relation type.
18+
IReadOnlyList<(Uri uri, string? title)> GetLinks(string rel);
19+
20+
// Resolves a single link with a specific relation type.
21+
Uri Link(string rel);
22+
23+
// Resolves a link template with a specific relation type.
24+
Uri LinkTemplate(string rel, IDictionary<string, object> variables);
25+
```
1926

2027
=== "Java"
2128

22-
- `getLinks(rel)` - Resolves all links with a specific relation type
23-
- `link(rel)` - Resolves a single link with a specific relation type
24-
- `linkTemplate(rel, variables)` - Resolves a link template with variables
29+
```java
30+
// Resolves all links with a specific relation type.
31+
List<Pair<URI, String>> getLinks(String rel);
32+
33+
// Resolves a single link with a specific relation type.
34+
URI link(String rel);
35+
36+
// Resolves a link template with a specific relation type.
37+
URI linkTemplate(String rel, Map<String, Object> variables);
38+
```
2539

2640
=== "Kotlin"
2741

28-
- `getLinks(rel)` - Resolves all links with a specific relation type
29-
- `link(rel)` - Resolves a single link with a specific relation type
30-
- `linkTemplate(rel, variables)` - Resolves a link template with variables
42+
```kotlin
43+
// Resolves all links with a specific relation type.
44+
fun getLinks(rel: String): List<Pair<URI, String?>>
45+
46+
// Resolves a single link with a specific relation type.
47+
fun link(rel: String): URI
48+
49+
// Resolves a link template with a specific relation type.
50+
fun linkTemplate(rel: String, variables: Map<String, Any>): URI
51+
```
3152

3253
=== "TypeScript"
3354

34-
- `getLinks(rel)` - Resolves all links with a specific relation type
35-
- `link(rel)` - Resolves a single link with a specific relation type
36-
- `linkTemplate(rel, variables)` - Resolves a link template with variables
55+
```typescript
56+
// Resolves all links with a specific relation type.
57+
getLinks(rel: string): { uri: URL; title?: string; }[];
58+
59+
// Resolves a single link with a specific relation type.
60+
link(rel: string): URL;
61+
62+
// Resolves a link template with a specific relation type.
63+
linkTemplate(rel: string, variables: { [key: string]: any; }): URL;
64+
```
3765

3866
These methods use cached data from the last response. On cache miss, they perform a lazy lookup using HTTP `HEAD`.

0 commit comments

Comments
 (0)