docs/api.mdwn
changeset 142 7e8f523b66af
parent 138 832ded5b44c9
child 150 c8514af9b449
equal deleted inserted replaced
141:1e36a08d7734 142:7e8f523b66af
   175 **Return values:** string (event id) or nothing (creation error) or table (list of event names)  
   175 **Return values:** string (event id) or nothing (creation error) or table (list of event names)  
   176 
   176 
   177 <a name="completion.type"></a>
   177 <a name="completion.type"></a>
   178 ### completion type
   178 ### completion type
   179 Built-it completion types can be specified as string, instead of id.  
   179 Built-it completion types can be specified as string, instead of id.  
   180 **Values:**  cmd, jid, urljid, name, status, filename, roster, buffer, group, groupname, multiline, room, resource, auth, request, events, eventsid, pgp, color, otr, ortpolicy, yesno  
   180 **Values:**  cmd, jid, urljid, name, status, filename, roster, buffer, group, groupname, multiline, room, resource, auth, request, events, eventsid, pgp, color, otr, ortpolicy, module, yesno  
       
   181 
       
   182 <a name="completion.sorting.order"></a>
       
   183 ### completion sorting order
       
   184 Sorting order for completion category.  
       
   185 **Values:**  sort, direct, reverse, append, prepend  
   181 
   186 
   182 <a name="command.arguments.table"></a>
   187 <a name="command.arguments.table"></a>
   183 ### command arguments table
   188 ### command arguments table
   184 It can parse barewords (with escapes), double-quoted strings (with escapes), single-quoted strings (without escapes), options and arguments.
   189 It can parse barewords (with escapes), double-quoted strings (with escapes), single-quoted strings (without escapes), options and arguments.
   185 Arguments are separated only by whitespace, so, consequential quoted strings or barewords are one argument.
   190 Arguments are separated only by whitespace, so, consequential quoted strings or barewords are one argument.
   211 **Return values:** table  
   216 **Return values:** table  
   212 
   217 
   213 <a name="main.add.category"></a>
   218 <a name="main.add.category"></a>
   214 ### main.add_category
   219 ### main.add_category
   215 Adds completion category.  
   220 Adds completion category.  
   216 **Arguments:** table (values are used as words for completion, optional)    
   221 **Arguments:** table (values are used as words for completion, optional), argument enum value ([completion sorting order](#completion.sorting.order), optional)    
   217 **Return values:** integer (category id, in fact [completion type](#completion.type)) or nil  
   222 **Return values:** integer (category id, in fact [completion type](#completion.type)) or nil  
   218 
   223 
   219 <a name="main.del.category"></a>
   224 <a name="main.del.category"></a>
   220 ### main.del_category
   225 ### main.del_category
   221 Removes completion category.  
   226 Removes completion category.