1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
|
{% for interface in interfaces %}
{% if interface.name == extra.interface %}
---
title: "{{interface.name}}"
draft: false
weight: {{loop.index}}
---
# {{interface.description.summary|title}}
{{interface.description.text|ei_escape_names}}
{% if interface.enums %}
# Enums
{% raw %}
{{% notice style="info" %}}
Enum names are shown here in uppercase. The exact name depends on the language bindings.
{{% /notice %}}
{% endraw %}
{% for enum in interface.enums %}
## {{interface.name}}.{{enum.name}}
{{enum.description.text|ei_escape_names}}
| Name | Value | Summary |
| ---- | ----- | ------- |
{% for entry in enum.entries %}
| `{{entry.name|upper}}` | {{entry.value}} | {{entry.summary}} |
{% endfor %}
{% endfor %}
{% endif %}
{% if interface.requests %}
# Requests
{% for request in interface.requests %}
## {{interface.name}}.{{request.name}}
{% raw %}{{% badge style="primary" title="Since Version" %}}{% endraw %}{{request.since}}{% raw %}{{% /badge %}}{% endraw %}
{% raw %}{{% badge style="secondary" title="Request Opcode" %}}{% endraw %}{{request.opcode}}{% raw %}{{% /badge %}}{% endraw %}
```
{{interface.name}}.{{request.name}}({{request.arguments|join(", ", attribute="name")}})
```
{% if request.arguments %}
| Argument | Type | Summary |
| -------- | ---- | ------- |
{% for arg in request.arguments %}
| {{arg.name}} | `{{arg.protocol_type}}` | {{arg.summary}} |
{% endfor %}
{% endif %}
{% if request.is_destructor %}
{% raw %}
{{% notice default "Destructor" "skull-crossbones" %}}
{% endraw %}
Immediately after sending this request, the object is considered destroyed
by the EIS implementation. It must no longer be used by the client.
{% raw %}
{{% /notice %}}
{% endraw %}
{% endif %}
{% if request.context_type %}
{% raw %}
{{% notice style="note" %}}
{% endraw %}
This request is only available for clients of `ei_handshake.context_type.{{request.context_type}}`.
{% raw %}
{{% /notice %}}
{% endraw %}
{% endif %}
{{request.description.text|ei_escape_names}}
{% endfor %}
{% endif %}
{% if interface.events %}
# Events
{% for event in interface.events %}
## {{interface.name}}.{{event.name}}
{% raw %}{{% badge style="primary" title="Since Version" %}}{% endraw %}{{event.since}}{% raw %}{{% /badge %}}{% endraw %}
{% raw %}{{% badge style="secondary" title="Event Opcode" %}}{% endraw %}{{event.opcode}}{% raw %}{{% /badge %}}{% endraw %}
```
{{interface.name}}.{{event.name}}({{event.arguments|join(", ", attribute="name")}})
```
{% if event.arguments %}
| Argument| Type | Summary |
| ------- | ---- | ------- |
{% for arg in event.arguments %}
| {{arg.name}} | `{{arg.protocol_type}}` | {{arg.summary}} |
{% endfor %}
{% endif %}
{% if event.is_destructor %}
{% raw %}
{{% notice default "Destructor" "skull-crossbones" %}}
{% endraw %}
Immediately after sending this request, the object is considered destroyed
by the EIS implementation. It must no longer be used by the client.
{% raw %}
{{% /notice %}}
{% endraw %}
{% endif %}
{% if event.context_type %}
{% raw %}
{{% notice style="note" %}}
{% endraw %}
This event is only available for clients of `ei_handshake.context_type.{{event.context_type}}`.
{% raw %}
{{% /notice %}}
{% endraw %}
{% endif %}
{{event.description.text|ei_escape_names}}
{% endfor %}
{% endif %}
{% endif %}
{% endfor %}
|
