teal-src/util/dataforms.d.tl
author Matthew Wild <mwild1@gmail.com>
Thu, 06 Oct 2022 11:12:57 +0100
changeset 12745 7b3deafb9162
parent 12619 b2047b82ec85
permissions -rw-r--r--
prosodyctl: check turn: More clearly indicate the error is from TURN server
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
11436
113f3912c7cb util: Add Teal interface definition files
Kim Alvefur <zash@zash.se>
parents:
diff changeset
     1
local stanza_t = require "util.stanza".stanza_t
113f3912c7cb util: Add Teal interface definition files
Kim Alvefur <zash@zash.se>
parents:
diff changeset
     2
12618
d498e7e7853a util.dataforms: Restructure Teal definition file
Kim Alvefur <zash@zash.se>
parents: 11436
diff changeset
     3
local record lib
d498e7e7853a util.dataforms: Restructure Teal definition file
Kim Alvefur <zash@zash.se>
parents: 11436
diff changeset
     4
	record dataform
d498e7e7853a util.dataforms: Restructure Teal definition file
Kim Alvefur <zash@zash.se>
parents: 11436
diff changeset
     5
		title : string
d498e7e7853a util.dataforms: Restructure Teal definition file
Kim Alvefur <zash@zash.se>
parents: 11436
diff changeset
     6
		instructions : string
d498e7e7853a util.dataforms: Restructure Teal definition file
Kim Alvefur <zash@zash.se>
parents: 11436
diff changeset
     7
d498e7e7853a util.dataforms: Restructure Teal definition file
Kim Alvefur <zash@zash.se>
parents: 11436
diff changeset
     8
		record form_field
11436
113f3912c7cb util: Add Teal interface definition files
Kim Alvefur <zash@zash.se>
parents:
diff changeset
     9
12618
d498e7e7853a util.dataforms: Restructure Teal definition file
Kim Alvefur <zash@zash.se>
parents: 11436
diff changeset
    10
			enum field_type
d498e7e7853a util.dataforms: Restructure Teal definition file
Kim Alvefur <zash@zash.se>
parents: 11436
diff changeset
    11
				"boolean"
d498e7e7853a util.dataforms: Restructure Teal definition file
Kim Alvefur <zash@zash.se>
parents: 11436
diff changeset
    12
				"fixed"
d498e7e7853a util.dataforms: Restructure Teal definition file
Kim Alvefur <zash@zash.se>
parents: 11436
diff changeset
    13
				"hidden"
d498e7e7853a util.dataforms: Restructure Teal definition file
Kim Alvefur <zash@zash.se>
parents: 11436
diff changeset
    14
				"jid-multi"
d498e7e7853a util.dataforms: Restructure Teal definition file
Kim Alvefur <zash@zash.se>
parents: 11436
diff changeset
    15
				"jid-single"
d498e7e7853a util.dataforms: Restructure Teal definition file
Kim Alvefur <zash@zash.se>
parents: 11436
diff changeset
    16
				"list-multi"
d498e7e7853a util.dataforms: Restructure Teal definition file
Kim Alvefur <zash@zash.se>
parents: 11436
diff changeset
    17
				"list-single"
d498e7e7853a util.dataforms: Restructure Teal definition file
Kim Alvefur <zash@zash.se>
parents: 11436
diff changeset
    18
				"text-multi"
d498e7e7853a util.dataforms: Restructure Teal definition file
Kim Alvefur <zash@zash.se>
parents: 11436
diff changeset
    19
				"text-private"
d498e7e7853a util.dataforms: Restructure Teal definition file
Kim Alvefur <zash@zash.se>
parents: 11436
diff changeset
    20
				"text-single"
d498e7e7853a util.dataforms: Restructure Teal definition file
Kim Alvefur <zash@zash.se>
parents: 11436
diff changeset
    21
			end
11436
113f3912c7cb util: Add Teal interface definition files
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    22
12618
d498e7e7853a util.dataforms: Restructure Teal definition file
Kim Alvefur <zash@zash.se>
parents: 11436
diff changeset
    23
			type : field_type
d498e7e7853a util.dataforms: Restructure Teal definition file
Kim Alvefur <zash@zash.se>
parents: 11436
diff changeset
    24
			var : string -- protocol name
d498e7e7853a util.dataforms: Restructure Teal definition file
Kim Alvefur <zash@zash.se>
parents: 11436
diff changeset
    25
			name :  string -- internal name
11436
113f3912c7cb util: Add Teal interface definition files
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    26
12618
d498e7e7853a util.dataforms: Restructure Teal definition file
Kim Alvefur <zash@zash.se>
parents: 11436
diff changeset
    27
			label : string
d498e7e7853a util.dataforms: Restructure Teal definition file
Kim Alvefur <zash@zash.se>
parents: 11436
diff changeset
    28
			desc : string
11436
113f3912c7cb util: Add Teal interface definition files
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    29
12618
d498e7e7853a util.dataforms: Restructure Teal definition file
Kim Alvefur <zash@zash.se>
parents: 11436
diff changeset
    30
			datatype : string
d498e7e7853a util.dataforms: Restructure Teal definition file
Kim Alvefur <zash@zash.se>
parents: 11436
diff changeset
    31
			range_min : number
d498e7e7853a util.dataforms: Restructure Teal definition file
Kim Alvefur <zash@zash.se>
parents: 11436
diff changeset
    32
			range_max : number
11436
113f3912c7cb util: Add Teal interface definition files
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    33
12618
d498e7e7853a util.dataforms: Restructure Teal definition file
Kim Alvefur <zash@zash.se>
parents: 11436
diff changeset
    34
			value : any -- depends on field_type
d498e7e7853a util.dataforms: Restructure Teal definition file
Kim Alvefur <zash@zash.se>
parents: 11436
diff changeset
    35
			options : table
d498e7e7853a util.dataforms: Restructure Teal definition file
Kim Alvefur <zash@zash.se>
parents: 11436
diff changeset
    36
		end
11436
113f3912c7cb util: Add Teal interface definition files
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    37
12618
d498e7e7853a util.dataforms: Restructure Teal definition file
Kim Alvefur <zash@zash.se>
parents: 11436
diff changeset
    38
		{ form_field }
11436
113f3912c7cb util: Add Teal interface definition files
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    39
12618
d498e7e7853a util.dataforms: Restructure Teal definition file
Kim Alvefur <zash@zash.se>
parents: 11436
diff changeset
    40
		enum form_type
d498e7e7853a util.dataforms: Restructure Teal definition file
Kim Alvefur <zash@zash.se>
parents: 11436
diff changeset
    41
			"form"
d498e7e7853a util.dataforms: Restructure Teal definition file
Kim Alvefur <zash@zash.se>
parents: 11436
diff changeset
    42
			"submit"
d498e7e7853a util.dataforms: Restructure Teal definition file
Kim Alvefur <zash@zash.se>
parents: 11436
diff changeset
    43
			"cancel"
d498e7e7853a util.dataforms: Restructure Teal definition file
Kim Alvefur <zash@zash.se>
parents: 11436
diff changeset
    44
			"result"
d498e7e7853a util.dataforms: Restructure Teal definition file
Kim Alvefur <zash@zash.se>
parents: 11436
diff changeset
    45
		end
11436
113f3912c7cb util: Add Teal interface definition files
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    46
12618
d498e7e7853a util.dataforms: Restructure Teal definition file
Kim Alvefur <zash@zash.se>
parents: 11436
diff changeset
    47
		form : function ( dataform, { string : any }, form_type ) : stanza_t
12619
b2047b82ec85 util.dataforms: Add missing :data() to Teal definition
Kim Alvefur <zash@zash.se>
parents: 12618
diff changeset
    48
		data : function ( dataform, stanza_t ) : { string : any }
12618
d498e7e7853a util.dataforms: Restructure Teal definition file
Kim Alvefur <zash@zash.se>
parents: 11436
diff changeset
    49
	end
11436
113f3912c7cb util: Add Teal interface definition files
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    50
113f3912c7cb util: Add Teal interface definition files
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    51
	new : function ( dataform ) : dataform
113f3912c7cb util: Add Teal interface definition files
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    52
end
113f3912c7cb util: Add Teal interface definition files
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    53
113f3912c7cb util: Add Teal interface definition files
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    54
return lib