xep0004

Documentation

Index

• Constants
• type DataForm
  • func NewFormFromElement(elem stravaganza.Element) (*DataForm, error)
  • func (f *DataForm) Element() stravaganza.Element
• type Field
  • func NewFieldFromElement(elem stravaganza.Element) (*Field, error)
  • func (f *Field) Element() stravaganza.Element
• type Fields
  • func (f Fields) ValueForField(fieldName string) string
  • func (f Fields) ValueForFieldOfType(fieldName, typ string) string
  • func (f Fields) ValuesForField(fieldName string) []string
  • func (f Fields) ValuesForFieldOfType(fieldName, typ string) []string
• type Option

Constants

const (
	// Boolean represents a 'boolean' form field.
	Boolean = "boolean"

	// Fixed represents a 'fixed' form field.
	Fixed = "fixed"

	// Hidden represents a 'hidden' form field.
	Hidden = "hidden"

	// JidMulti represents a 'jid-multi' form field.
	JidMulti = "jid-multi"

	// JidSingle represents a 'jid-single' form field.
	JidSingle = "jid-single"

	// ListMulti represents a 'list-multi' form field.
	ListMulti = "list-multi"

	// ListSingle represents a 'list-single' form field.
	ListSingle = "list-single"

	// TextMulti represents a 'text-multi' form field.
	TextMulti = "text-multi"

	// TextPrivate represents a 'text-private' form field.
	TextPrivate = "text-private"

	// TextSingle represents a 'text-single' form field.
	TextSingle = "text-single"
)

const (
	// Form represents a 'form' data form.
	Form = "form"

	// Submit represents a 'submit' data form.
	Submit = "submit"

	// Cancel represents a 'cancel' data form.
	Cancel = "cancel"

	// Result represents a 'result' data form.
	Result = "result"
)

const FormNamespace = "jabber:x:data"

FormNamespace specifies XEP-0004 namespace constant value.

const FormType = "FORM_TYPE"

FormType represents form type constant value.

Types

type DataForm

type DataForm struct {
	Type         string
	Title        string
	Instructions string
	Fields       Fields
	Reported     Fields
	Items        []Fields
}

DataForm represents a form that could be use for gathering data as well as for reporting data returned from a search.

func NewFormFromElement

func NewFormFromElement(elem stravaganza.Element) (*DataForm, error)

NewFormFromElement returns a new data form entity reading it from it's XMPP representation.

func (*DataForm) Element

func (f *DataForm) Element() stravaganza.Element

Element returns data form XML representation.

type Field

type Field struct {
	Var         string
	Required    bool
	Type        string
	Label       string
	Description string
	Values      []string
	Options     []Option
}

Field represents a field of a form. The field could be used to represent a question to complete, a completed question or a data returned from a search.

func NewFieldFromElement

func NewFieldFromElement(elem stravaganza.Element) (*Field, error)

NewFieldFromElement returns a new form field entity reading it from it's XML representation.

func (*Field) Element

func (f *Field) Element() stravaganza.Element

Element returns form field XML representation.

type Fields

type Fields []Field

Fields represent a set of form fields

func (Fields) ValueForField

func (f Fields) ValueForField(fieldName string) string

ValueForField returns the associated value for a given field name.

func (Fields) ValueForFieldOfType

func (f Fields) ValueForFieldOfType(fieldName, typ string) string

ValueForFieldOfType returns the associated value for a given field name and type.

func (Fields) ValuesForField

func (f Fields) ValuesForField(fieldName string) []string

ValuesForField returns all associated values for a given field name.

func (Fields) ValuesForFieldOfType

func (f Fields) ValuesForFieldOfType(fieldName, typ string) []string

ValuesForFieldOfType returns all associated values for a given field name and type.

type Option

type Option struct {
	Label string
	Value string
}

Option represents an individual field option.