-
Notifications
You must be signed in to change notification settings - Fork 909
/
functions.xml
211 lines (194 loc) · 5.43 KB
/
functions.xml
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
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<section id="avp_db.functions" xmlns:xi="http://www.w3.org/2001/XInclude">
<!-- following is not needed in every section - it is needless here?
<sectioninfo>
</sectioninfo>-->
<title>Functions</title>
<!--
<section id="avp_load">
<title><function moreinfo="none">avp_load(type)</function></title>
<para>
Load AVPs from the database.
</para>
<para>Meaning of the parameters is as follows:</para>
<itemizedlist>
<listitem>
<para><emphasis>type</emphasis> - One of:
<itemizedlist>
<listitem>
<para>
<emphasis>caller_uuid</emphasis> - Load AVPs
for caller identified by UUID. All AVP names
will have "caller_" prefix.
</para>
</listitem>
<listitem>
<para>
<emphasis>callee_uuid</emphasis> - Load AVPs
for callee identified by UUID. All AVP
names will have "callee_" prefix.
</para>
</listitem>
<listitem>
<para>
<emphasis>caller</emphasis> - Load AVPs for
caller based on the URI of the caller
(From). All AVP names will have "caller_"
prefix.
</para>
</listitem>
<listitem>
<para>
<emphasis>callee</emphasis> - Load AVPs for
callee based on the URI of the callee
(Request-URI). All AVP names will have
"callee_" prefix.
</para>
</listitem>
</itemizedlist>
</para>
</listitem>
</itemizedlist>
</section>
-->
<section><title>load_attrs (track, id)</title>
<para>
Loads attributes from the database.
<variablelist>
Track can have following values:
<varlistentry>
<term>track</term>
<listitem><para>
<variablelist>
<varlistentry>
<term>$fu</term>
<listitem><para>Load user attributes into from track. In this case
the second parameter is UID used to search attributes.
</para></listitem>
</varlistentry>
<varlistentry>
<term>$tu</term>
<listitem><para>Load user attributes into to track. In this case
the second parameter is UID used to search attributes.
</para></listitem>
</varlistentry>
<varlistentry>
<term>$fr</term>
<listitem><para>Load uri attributes into from track. In this case
the second parameter is URI used to search attributes.
</para></listitem>
</varlistentry>
<varlistentry>
<term>$tr</term>
<listitem><para>Load uri attributes into to track. In this case
the second parameter is URI used to search attributes.
</para></listitem>
</varlistentry>
</variablelist>
</para></listitem>
</varlistentry>
<varlistentry>
<term>id</term>
<listitem><para>Identifier used for searching attributes. When
searching for user attributes it is UID, when searching uri
attributes it is URI.
</para></listitem>
</varlistentry>
</variablelist>
</para>
</section>
<section><title>load_extra_attrs (group_id, id)</title>
<para>
Loads 'extra attributes' stored by previous call to save_extra_attrs.
<variablelist>
<varlistentry>
<term>group_id</term>
<listitem><para>Identifies attribute group, see <xref
linkend="extra_attr_group"/>.
</para></listitem>
</varlistentry>
<varlistentry>
<term>id</term>
<listitem><para>Identifies attributes which should be loaded.
</para></listitem>
</varlistentry>
</variablelist>
</para>
</section>
<section><title>save_extra_attrs (group_id, id)</title>
<para>
Saves 'extra attributes' flagged by group flag under given id.
<variablelist>
<varlistentry>
<term>group_id</term>
<listitem><para>Identifies attribute group, see <xref
linkend="extra_attr_group"/>.
</para></listitem>
</varlistentry>
<varlistentry>
<term>id</term>
<listitem><para>Identifier stored with flagged attributes.
</para></listitem>
</varlistentry>
</variablelist>
</para>
</section>
<section><title>remove_extra_attrs (group_id, id)</title>
<para>
Removes all extra attributes with given id.
<variablelist>
<varlistentry>
<term>group_id</term>
<listitem><para>Identifies attribute group, see <xref
linkend="extra_attr_group"/>.
</para></listitem>
</varlistentry>
<varlistentry>
<term>id</term>
<listitem><para>Identifies attributes which should be removed.
</para></listitem>
</varlistentry>
</variablelist>
</para>
</section>
<section><title>lock_extra_attrs (group_id, id)</title>
<para>
Locks extra attributes. Currently locks whole attribute group (not only
id).
<variablelist>
<varlistentry>
<term>group_id</term>
<listitem><para>Identifies attribute group, see <xref
linkend="extra_attr_group"/>.
</para></listitem>
</varlistentry>
<varlistentry>
<term>id</term>
<listitem><para>Identifies attributes which should be locked.
</para></listitem>
</varlistentry>
</variablelist>
</para>
</section>
<section><title>unlock_extra_attrs (group_id, id)</title>
<para>
Unlocks extra attributes. Currently unlocks whole attribute group (not only
id).
<variablelist>
<varlistentry>
<term>group_id</term>
<listitem><para>Identifies attribute group, see <xref
linkend="extra_attr_group"/>.
</para></listitem>
</varlistentry>
<varlistentry>
<term>id</term>
<listitem><para>Identifies attributes which should be unlocked.
</para></listitem>
</varlistentry>
</variablelist>
</para>
</section>
</section>